src/share/classes/com/sun/javadoc/DocErrorReporter.java

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

Initial load

duke@1 1 /*
duke@1 2 * Copyright 1998-2006 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.javadoc;
duke@1 27
duke@1 28 /**
duke@1 29 * This interface provides error, warning and notice printing.
duke@1 30 *
duke@1 31 * @since 1.2
duke@1 32 * @author Robert Field
duke@1 33 */
duke@1 34 public interface DocErrorReporter {
duke@1 35
duke@1 36 /**
duke@1 37 * Print error message and increment error count.
duke@1 38 *
duke@1 39 * @param msg message to print
duke@1 40 */
duke@1 41 void printError(String msg);
duke@1 42
duke@1 43 /**
duke@1 44 * Print an error message and increment error count.
duke@1 45 *
duke@1 46 * @param pos the position item where the error occurs
duke@1 47 * @param msg message to print
duke@1 48 * @since 1.4
duke@1 49 */
duke@1 50 void printError(SourcePosition pos, String msg);
duke@1 51
duke@1 52 /**
duke@1 53 * Print warning message and increment warning count.
duke@1 54 *
duke@1 55 * @param msg message to print
duke@1 56 */
duke@1 57 void printWarning(String msg);
duke@1 58
duke@1 59 /**
duke@1 60 * Print warning message and increment warning count.
duke@1 61 *
duke@1 62 * @param pos the position item where the warning occurs
duke@1 63 * @param msg message to print
duke@1 64 * @since 1.4
duke@1 65 */
duke@1 66 void printWarning(SourcePosition pos, String msg);
duke@1 67
duke@1 68 /**
duke@1 69 * Print a message.
duke@1 70 *
duke@1 71 * @param msg message to print
duke@1 72 */
duke@1 73 void printNotice(String msg);
duke@1 74
duke@1 75 /**
duke@1 76 * Print a message.
duke@1 77 *
duke@1 78 * @param pos the position item where the message occurs
duke@1 79 * @param msg message to print
duke@1 80 * @since 1.4
duke@1 81 */
duke@1 82 void printNotice(SourcePosition pos, String msg);
duke@1 83 }

mercurial