summaryrefslogtreecommitdiffstats
path: root/libjava/classpath/tools/com/sun/javadoc/Doc.java
diff options
context:
space:
mode:
authorfitzsim <fitzsim@138bc75d-0d04-0410-961f-82ee72b054a4>2007-03-13 05:48:03 +0000
committerfitzsim <fitzsim@138bc75d-0d04-0410-961f-82ee72b054a4>2007-03-13 05:48:03 +0000
commitf320685c2f28be86b362cdc99454c967fcaa64db (patch)
tree990fd86bf6b013d5491baa12df0c10d63975e50c /libjava/classpath/tools/com/sun/javadoc/Doc.java
parent02b0f3d552485e44710d4984843866854c40ee15 (diff)
downloadppe42-gcc-f320685c2f28be86b362cdc99454c967fcaa64db.tar.gz
ppe42-gcc-f320685c2f28be86b362cdc99454c967fcaa64db.zip
2007-03-13 Thomas Fitzsimmons <fitzsim@redhat.com>
* Makefile.am (AM_CXXFLAGS): Define ECJ_JAR_FILE. * classpath/configure.ac: Add --with-ecj-jar configure option. * classpath/gnu/classpath/Configuration.java.in (ECJ_JAR): New field. * classpath/INSTALL: Document --with-ecj-jar configure option and ecj jar requirement for com.sun.tools.javac support. * classpath/tools/Makefile.am: Build decendents of com and sun directories. * configure.ac: Substitute ECJ_JAR in stub Configuration.java. * gnu/classpath/Configuration.java, gnu/classpath/natConfiguration.cc (ecj): New method. (ECJ_JAR): New field. * scripts/makemake.tcl (scan_packages): Add com directory. * sources.am (property_files): Add classpath/resource/sun/rmi/rmic/messages.properties and classpath/resource/com/sun/tools/javac/messages.properties. * classpath/resource/com, classpath/resource/com/sun, classpath/resource/com/sun/tools, classpath/resource/com/sun/tools/javac, classpath/resource/sun, classpath/resource/sun/rmi, classpath/resource/sun/rmi/rmic, classpath/tools/classes/com, classpath/tools/classes/com/sun, classpath/tools/classes/com/sun/javadoc, classpath/tools/classes/com/sun/tools, classpath/tools/classes/com/sun/tools/doclets, classpath/tools/classes/sun, classpath/tools/classes/sun/rmi, classpath/tools/classes/sun/rmi/rmic, classpath/tools/com, classpath/tools/com/sun, classpath/tools/com/sun/javadoc, classpath/tools/com/sun/tools, classpath/tools/com/sun/tools/doclets, classpath/tools/com/sun/tools/javac, classpath/tools/sun, classpath/tools/sun/rmi, classpath/tools/sun/rmi/rmic: New directories. * classpath/resource/com/sun/tools/javac/messages.properties, classpath/resource/sun/rmi/rmic/messages.properties, classpath/tools/classes/com/sun/javadoc/ClassDoc.class, classpath/tools/classes/com/sun/javadoc/ConstructorDoc.class, classpath/tools/classes/com/sun/javadoc/Doc.class, classpath/tools/classes/com/sun/javadoc/DocErrorReporter.class, classpath/tools/classes/com/sun/javadoc/Doclet.class, classpath/tools/classes/com/sun/javadoc/ExecutableMemberDoc.class, classpath/tools/classes/com/sun/javadoc/FieldDoc.class, classpath/tools/classes/com/sun/javadoc/MemberDoc.class, classpath/tools/classes/com/sun/javadoc/MethodDoc.class, classpath/tools/classes/com/sun/javadoc/PackageDoc.class, classpath/tools/classes/com/sun/javadoc/ParamTag.class, classpath/tools/classes/com/sun/javadoc/Parameter.class, classpath/tools/classes/com/sun/javadoc/ProgramElementDoc.class, classpath/tools/classes/com/sun/javadoc/RootDoc.class, classpath/tools/classes/com/sun/javadoc/SeeTag.class, classpath/tools/classes/com/sun/javadoc/SerialFieldTag.class, classpath/tools/classes/com/sun/javadoc/SourcePosition.class, classpath/tools/classes/com/sun/javadoc/Tag.class, classpath/tools/classes/com/sun/javadoc/ThrowsTag.class, classpath/tools/classes/com/sun/javadoc/Type.class, classpath/tools/classes/com/sun/javadoc/TypeVariable.class, classpath/tools/classes/com/sun/tools/doclets/Taglet.class, classpath/tools/classes/sun/rmi/rmic/Main.class, classpath/tools/classes/sun/rmi/rmic/Messages.class, classpath/tools/com/sun/javadoc/ClassDoc.java, classpath/tools/com/sun/javadoc/ConstructorDoc.java, classpath/tools/com/sun/javadoc/Doc.java, classpath/tools/com/sun/javadoc/DocErrorReporter.java, classpath/tools/com/sun/javadoc/Doclet.java, classpath/tools/com/sun/javadoc/ExecutableMemberDoc.java, classpath/tools/com/sun/javadoc/FieldDoc.java, classpath/tools/com/sun/javadoc/MemberDoc.java, classpath/tools/com/sun/javadoc/MethodDoc.java, classpath/tools/com/sun/javadoc/PackageDoc.java, classpath/tools/com/sun/javadoc/ParamTag.java, classpath/tools/com/sun/javadoc/Parameter.java, classpath/tools/com/sun/javadoc/ProgramElementDoc.java, classpath/tools/com/sun/javadoc/RootDoc.java, classpath/tools/com/sun/javadoc/SeeTag.java, classpath/tools/com/sun/javadoc/SerialFieldTag.java, classpath/tools/com/sun/javadoc/SourcePosition.java, classpath/tools/com/sun/javadoc/Tag.java, classpath/tools/com/sun/javadoc/ThrowsTag.java, classpath/tools/com/sun/javadoc/Type.java, classpath/tools/com/sun/javadoc/TypeVariable.java, classpath/tools/com/sun/tools/doclets/Taglet.java, classpath/tools/com/sun/tools/javac/Main.java, classpath/tools/com/sun/tools/javac/Messages.java, classpath/tools/sun/rmi/rmic/Main.java, classpath/tools/sun/rmi/rmic/Messages.java: New files. * Makefile.in, classpath/Makefile.in, classpath/configure, classpath/doc/Makefile.in, classpath/doc/api/Makefile.in, classpath/examples/Makefile.in, classpath/external/Makefile.in, classpath/external/jsr166/Makefile.in, classpath/external/relaxngDatatype/Makefile.in, classpath/external/sax/Makefile.in, classpath/external/w3c_dom/Makefile.in, classpath/include/Makefile.in, classpath/include/config.h.in, classpath/lib/Makefile.in, classpath/lib/gnu/classpath/Configuration.class, classpath/native/Makefile.in, classpath/native/fdlibm/Makefile.in, classpath/native/jawt/Makefile.in, classpath/native/jni/Makefile.in, classpath/native/jni/classpath/Makefile.in, classpath/native/jni/gconf-peer/Makefile.in, classpath/native/jni/gtk-peer/Makefile.in, classpath/native/jni/java-io/Makefile.in, classpath/native/jni/java-lang/Makefile.in, classpath/native/jni/java-net/Makefile.in, classpath/native/jni/java-nio/Makefile.in, classpath/native/jni/java-util/Makefile.in, classpath/native/jni/midi-alsa/Makefile.in, classpath/native/jni/midi-dssi/Makefile.in, classpath/native/jni/native-lib/Makefile.in, classpath/native/jni/qt-peer/Makefile.in, classpath/native/jni/xmlj/Makefile.in, classpath/native/plugin/Makefile.in, classpath/resource/Makefile.in, classpath/scripts/Makefile.in, classpath/tools/Makefile.in, configure, gnu/classpath/Configuration.h: Regenerate. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@122876 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libjava/classpath/tools/com/sun/javadoc/Doc.java')
-rw-r--r--libjava/classpath/tools/com/sun/javadoc/Doc.java265
1 files changed, 265 insertions, 0 deletions
diff --git a/libjava/classpath/tools/com/sun/javadoc/Doc.java b/libjava/classpath/tools/com/sun/javadoc/Doc.java
new file mode 100644
index 00000000000..425c85718f2
--- /dev/null
+++ b/libjava/classpath/tools/com/sun/javadoc/Doc.java
@@ -0,0 +1,265 @@
+/* Doc.java -- Model of an item to document.
+ Copyright (C) 1999 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+
+package com.sun.javadoc;
+
+/**
+ * This interface is the super-interface of all items that can have
+ * Javadoc comments associated with them.
+ */
+public interface Doc extends java.io.Serializable, Comparable
+{
+
+/**
+ * This method returns the text of the comment for this item, with all
+ * tags stripped.
+ *
+ * @return The comment text for this item.
+ */
+public abstract String
+commentText();
+
+/*************************************************************************/
+
+/**
+ * This method returns an array of all the tags in this item.
+ *
+ * @return An array of tags for this item.
+ */
+public abstract Tag[]
+tags();
+
+/*************************************************************************/
+
+/**
+ * This method returns an array of all the tags of the specified type
+ * in this item.
+ *
+ * @param tagtype The name of the tag type to return.
+ *
+ * @return A list of all tags of the specified type.
+ */
+public abstract Tag[]
+tags(String tagtype);
+
+/*************************************************************************/
+
+/**
+ * This method returns an array of all tags of the "@see" type.
+ *
+ * @return An array of tags of the "@see" type
+ */
+public abstract SeeTag[]
+seeTags();
+
+/*************************************************************************/
+
+/**
+ * This method returns the comment text as an array of tags. This will
+ * include any inline tags, but no regular tags. Regular text is returned
+ * as a type of <code>Text</code>. Inline "@see" tags are returned as
+ * type <code>SeeTag</code>.
+ *
+ * @return The comment text as tags.
+ */
+public abstract Tag[]
+inlineTags();
+
+/*************************************************************************/
+
+/**
+ * This method returns the first sentence of the comment text as an array
+ * of tags. This will include any inline tags, but no regular tags.
+ * Regular text is returned as a type of <code>Text</code>. Inline "@see"
+ * tags are returned as type <code>SeeTag</code>.
+ *
+ * @return An array of tags representing the first sentence of the comment
+ * text.
+ */
+public abstract Tag[]
+firstSentenceTags();
+
+/*************************************************************************/
+
+/**
+ * This method returns the text of the comment in an unprocessed format.
+ * Any Javadoc tags will remain as written in the text.
+ *
+ * @return The unprocessed comment text.
+ */
+public abstract String
+getRawCommentText();
+
+/*************************************************************************/
+
+/**
+ * This method sets the unprocessed comment text for this item.
+ *
+ * @param rawtext The unprocessed comment text for this itme.
+ */
+public abstract void
+setRawCommentText(String rawtext);
+
+/*************************************************************************/
+
+/**
+ * This method returns the name of this item.
+ *
+ * @return The name of this item.
+ */
+public abstract String
+name();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is a field.
+ *
+ * @return <code>true</code> if this item is a field, <code>false</code>
+ * otherwise.
+ */
+public abstract boolean
+isField();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is a method.
+ *
+ * @return <code>true</code> if this item is a method, <code>false</code>
+ * otherwise.
+ */
+public abstract boolean
+isMethod();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is a constructor.
+ *
+ * @return <code>true</code> if this item is a constructor,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isConstructor();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is an interface.
+ *
+ * @return <code>true</code> if this item is an interface,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isInterface();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is an exception.
+ *
+ * @return <code>true</code> if this item is an exception,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isException();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is an error.
+ *
+ * @return <code>true</code> if this item is an error,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isError();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is a class. Interfaces
+ * do not count as classes.
+ *
+ * @return <code>true</code> if this item is a class,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isClass();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is an ordinary class. An
+ * ordinary class is a class that is not an exception or an error.
+ * Interfaces also do not count because they are not considered classes at
+ * all.
+ *
+ * @return <code>true</code> if this item is an ordinary class,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isOrdinaryClass();
+
+/*************************************************************************/
+
+/**
+ * This method tests whether or not this item is part of the active set,
+ * whatever that is.
+ *
+ * @return <code>true</code> if this item is part of the active set,
+ * <code>false</code> otherwise.
+ */
+public abstract boolean
+isIncluded();
+
+/*************************************************************************/
+
+/**
+ * This method returns the location of the item within the Java
+ * source code.
+ *
+ * @return an object describing the file, line and column where this
+ * item is defined.
+ */
+public abstract SourcePosition
+position();
+
+} // interface Doc
+
OpenPOWER on IntegriCloud