/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* An abstract implementation of a Doclet.
*
* This code is not part of an API.
* It is implementation that is subject to change.
* Do not use it as an API.
*
* @author Jamie Ho
*/
public abstract class AbstractDoclet {
/**
* The global configuration information for this run.
*/
/**
* The only doclet that may use this toolkit is {@value}
*/
/**
* Verify that the only doclet that is using this toolkit is
* {@value #TOOLKIT_DOCLET_NAME}.
*/
return false;
}
return true;
}
/**
* The method that starts the execution of the doclet.
*
* @param doclet the doclet to start the execution for.
* @param root the {@link RootDoc} that points to the source to document.
* @return true if the doclet executed without error. False otherwise.
*/
if (! isValidDoclet(doclet)) {
return false;
}
try {
return false;
}
return true;
}
/**
* Indicate that this doclet supports the 1.5 language features.
* @return JAVA_1_5, indicating that the new features are supported.
*/
return LanguageVersion.JAVA_1_5;
}
/**
* Create the configuration instance and returns it.
* @return the configuration of the doclet.
*/
/**
* Start the generation of files. Call generate methods in the individual
* writers, which will in turn genrate the documentation files. Call the
* TreeWriter generation first to ensure the Class Hierarchy is built
* first and then can be used in the later generation.
*
* @see com.sun.javadoc.RootDoc
*/
error("doclet.No_Public_Classes_To_Document");
return;
}
boolean first = true;
while(pathTokens.hasMoreTokens()){
first = false;
}
}
}
/**
* Generate additional documentation that is added to the API documentation.
*
* @param root the RootDoc of source to document.
* @param classtree the data structure representing the class tree.
*/
}
/**
* Generate the package documentation.
*
* @param classtree the data structure representing the class tree.
*/
/**
* Generate the class documentation.
*
* @param classtree the data structure representing the class tree.
*/
/**
* Iterate through all classes and construct documentation for them.
*
* @param root the RootDoc of source to document.
* @param classtree the data structure representing the class tree.
*/
}
}
/**
* Generate the class files for single classes specified on the command line.
*
* @param classtree the data structure representing the class tree.
*/
packageNameIndex++) {
}
}
}