/*
* 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.
*/
/**
* Generate the Class Information Page.
* @see com.sun.javadoc.ClassDoc
* @see java.util.Collections
* @see java.util.List
* @see java.util.ArrayList
* @see java.util.HashMap
*
* @author Atul M Dambalkar
* @author Robert Field
* @author Bhavesh Patel (Modified)
*/
implements ClassWriter {
/**
* @param classDoc the class being documented.
* @param prevClass the previous class that was documented.
* @param nextClass the next class being documented.
* @param classTree the class tree for the given class.
*/
throws Exception {
super(ConfigurationImpl.getInstance(),
}
/**
* Get this package link.
*
* @return a content tree for the package link
*/
return li;
}
/**
* Get the class link.
*
* @return a content tree for the class link
*/
return li;
}
/**
* Get the class use link.
*
* @return a content tree for the class use link
*/
return li;
}
/**
* Get link to previous class.
*
* @return a content tree for the previous class link
*/
}
else
return li;
}
/**
* Get link to next class.
*
* @return a content tree for the next class link
*/
}
else
return li;
}
/**
* {@inheritDoc}
*/
addNavLinks(true, bodyTree);
}
classDoc, false);
//Let's not link to ourselves in the header.
linkInfo.linkToSelf = false;
return bodyTree;
}
/**
* {@inheritDoc}
*/
return getContentHeader();
}
/**
* {@inheritDoc}
*/
addNavLinks(false, contentTree);
}
/**
* {@inheritDoc}
*/
true, contentTree);
}
/**
* {@inheritDoc}
*/
return getMemberTreeHeader();
}
/**
* {@inheritDoc}
*/
}
/**
* {@inheritDoc}
*/
//Let's not link to ourselves in the signature.
linkInfo.linkToSelf = false;
if (configuration().linksource) {
} else {
}
if (!isInterface) {
configuration());
if (superclass != null) {
superclass)));
}
}
int counter = 0;
continue;
}
if (counter == 0) {
} else {
}
implIntfacs[i])));
counter++;
}
}
}
/**
* {@inheritDoc}
*/
if(!configuration.nocomment) {
// generate documentation for the class.
}
}
}
/**
* {@inheritDoc}
*/
if(!configuration.nocomment) {
// Print Information about all the tags here
}
}
/**
* Get the class hierarchy tree for the given class.
*
* @param type the class to print the hierarchy for
* @return a content tree for class inheritence
*/
do {
configuration());
}
else
}
return classTreeUl;
}
/**
* Get the class helper tree for the given class.
*
* @param type the class to print the helper for
* @return a content tree for class helper
*/
classDoc, false));
} else {
}
} else {
}
return li;
}
/**
* {@inheritDoc}
*/
return;
}
}
/**
* {@inheritDoc}
*/
getTagletWriterInstance(false));
}
}
/**
* {@inheritDoc}
*/
return; // Don't generate the list, too huge
}
"doclet.Subclasses");
subclasses));
}
}
}
/**
* {@inheritDoc}
*/
if (classDoc.isInterface()) {
"doclet.Subinterfaces");
}
}
}
/**
* {@inheritDoc}
*/
if (! classDoc.isInterface()) {
return;
}
return; // Don't generate the list, too big
}
"doclet.Implementing_Classes");
implcl));
}
}
/**
* {@inheritDoc}
*/
//NOTE: we really should be using ClassDoc.interfaceTypes() here, but
// it doesn't walk up the tree like we want it to.
"doclet.All_Implemented_Interfaces");
}
}
/**
* {@inheritDoc}
*/
//NOTE: we really should be using ClassDoc.interfaceTypes() here, but
// it doesn't walk up the tree like we want it to.
"doclet.All_Superinterfaces");
}
}
/**
* {@inheritDoc}
*/
if (outerClass != null) {
if (outerClass.isInterface()) {
label = getResource(
"doclet.Enclosing_Interface");
} else {
label = getResource(
"doclet.Enclosing_Class");
}
false))));
}
}
/**
* {@inheritDoc}
*/
}
}
}
}
/**
* Get links to the given classes.
*
* @param context the id of the context where the link will be printed
* @param list the list of classes
* @return a content tree for the class list
*/
if (i > 0) {
}
} else {
}
}
return dd;
}
/**
* {@inheritDoc}
*/
return li;
}
/**
* Add summary details to the navigation bar.
*
* @param subDiv the content tree to which the summary detail links will be added
*/
try {
} catch (Exception e) {
e.printStackTrace();
throw new DocletAbortException();
}
}
/**
* Get summary links for navigation bar.
*
* @return the content tree for the navigation summary links
*/
"doclet.navNested", "doclet.navEnum", "doclet.navField", "doclet.navConstructor",
"doclet.navMethod"
};
continue;
}
continue;
}
} else {
}
}
}
return ulNav;
}
/**
* Get detail links for the navigation bar.
*
* @return the content tree for the detail links
*/
"doclet.navNested", "doclet.navEnum", "doclet.navField", "doclet.navConstructor",
"doclet.navMethod"
};
continue;
}
continue;
}
} else {
}
}
}
return ulNav;
}
/**
* Add gap between navigation bar elements.
*
* @param liNav the content tree to which the gap will be added
*/
}
/**
* Return the classDoc being documented.
*
* @return the classDoc being documented.
*/
return classDoc;
}
}