jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/AbstractIndexWriter.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/AbstractIndexWriter.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/AbstractIndexWriter.java

Wed, 10 Oct 2012 16:48:21 -0700

author: jjg
date: Wed, 10 Oct 2012 16:48:21 -0700
changeset 1359: 25e14ad23cef
parent 1357: c75be5bc5283
child 1372: 78962d89f283
permissions: -rw-r--r--

8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy

 /*
  * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * 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.
  */
 package com.sun.tools.doclets.formats.html;
 import java.io.*;
 import java.util.*;
 import com.sun.javadoc.*;
 import com.sun.tools.doclets.formats.html.markup.*;
 import com.sun.tools.doclets.internal.toolkit.*;
 import com.sun.tools.doclets.internal.toolkit.util.*;
 /**
  * Generate Index for all the Member Names with Indexing in
  * Unicode Order. This class is a base class for {@link SingleIndexWriter} and
  * {@link SplitIndexWriter}. It uses the functionality from
  * {@link HtmlDocletWriter} to generate the Index Contents.
  *
  *  <p><b>This is NOT part of any supported API.
  *  If you write code that depends on this, you do so at your own risk.
  *  This code and its internal interfaces are subject to change or
  *  deletion without notice.</b>
  *
  * @see    IndexBuilder
  * @author Atul M Dambalkar
  * @author Bhavesh Patel (Modified)
  */
 public class AbstractIndexWriter extends HtmlDocletWriter {
     /**
      * The index of all the members with unicode character.
      */
     protected IndexBuilder indexbuilder;
     /**
      * This constructor will be used by {@link SplitIndexWriter}. Initialises
      * path to this file and relative path from this file.
      *
      * @param path       Path to the file which is getting generated.
      * @param filename   Name of the file which is getting genrated.
      * @param relpath    Relative path from this file to the current directory.
      * @param indexbuilder Unicode based Index from {@link IndexBuilder}
      */
     protected AbstractIndexWriter(ConfigurationImpl configuration,
                                   String path, String filename,
                                   String relpath, IndexBuilder indexbuilder)
                                   throws IOException {
         super(configuration, path, filename, relpath);
         this.indexbuilder = indexbuilder;
     }
     /**
      * This Constructor will be used by {@link SingleIndexWriter}.
      *
      * @param filename   Name of the file which is getting genrated.
      * @param indexbuilder Unicode based Index form {@link IndexBuilder}
      */
     protected AbstractIndexWriter(ConfigurationImpl configuration,
                                   String filename, IndexBuilder indexbuilder)
                                   throws IOException {
         super(configuration, filename);
         this.indexbuilder = indexbuilder;
     }
     /**
      * Get the index label for navigation bar.
      *
      * @return a content tree for the tree label
      */
     protected Content getNavLinkIndex() {
         Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, indexLabel);
         return li;
     }
     /**
      * Add the member information for the unicode character along with the
      * list of the members.
      *
      * @param unicode Unicode for which member list information to be generated
      * @param memberlist List of members for the unicode character
      * @param contentTree the content tree to which the information will be added
      */
     protected void addContents(Character unicode, List<? extends Doc> memberlist,
             Content contentTree) {
         contentTree.addContent(getMarkerAnchor("_" + unicode + "_"));
         Content headContent = new StringContent(unicode.toString());
         Content heading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, false,
                 HtmlStyle.title, headContent);
         contentTree.addContent(heading);
         int memberListSize = memberlist.size();
         // Display the list only if there are elements to be displayed.
         if (memberListSize > 0) {
             Content dl = new HtmlTree(HtmlTag.DL);
             for (int i = 0; i < memberListSize; i++) {
                 Doc element = memberlist.get(i);
                 if (element instanceof MemberDoc) {
                     addDescription((MemberDoc)element, dl);
                 } else if (element instanceof ClassDoc) {
                     addDescription((ClassDoc)element, dl);
                 } else if (element instanceof PackageDoc) {
                     addDescription((PackageDoc)element, dl);
                 }
             }
             contentTree.addContent(dl);
         }
     }
     /**
      * Add one line summary comment for the package.
      *
      * @param pkg the package to be documented
      * @param dlTree the content tree to which the description will be added
      */
     protected void addDescription(PackageDoc pkg, Content dlTree) {
         Content link = getPackageLink(pkg, new StringContent(Util.getPackageName(pkg)));
         Content dt = HtmlTree.DT(link);
         dt.addContent(" - ");
         dt.addContent(getResource("doclet.package"));
         dt.addContent(" " + pkg.name());
         dlTree.addContent(dt);
         Content dd = new HtmlTree(HtmlTag.DD);
         addSummaryComment(pkg, dd);
         dlTree.addContent(dd);
     }
     /**
      * Add one line summary comment for the class.
      *
      * @param cd the class being documented
      * @param dlTree the content tree to which the description will be added
      */
     protected void addDescription(ClassDoc cd, Content dlTree) {
         Content link = new RawHtml(
                 getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_INDEX, cd, true)));
         Content dt = HtmlTree.DT(link);
         dt.addContent(" - ");
         addClassInfo(cd, dt);
         dlTree.addContent(dt);
         Content dd = new HtmlTree(HtmlTag.DD);
         addComment(cd, dd);
         dlTree.addContent(dd);
     }
     /**
      * Add the classkind(class, interface, exception, error of the class
      * passed.
      *
      * @param cd the class being documented
      * @param contentTree the content tree to which the class info will be added
      */
     protected void addClassInfo(ClassDoc cd, Content contentTree) {
         contentTree.addContent(getResource("doclet.in",
                 Util.getTypeName(configuration, cd, false),
                 getPackageLinkString(cd.containingPackage(),
                 Util.getPackageName(cd.containingPackage()), false)));
     }
     /**
      * Add description for Class, Field, Method or Constructor.
      *
      * @param member MemberDoc for the member of the Class Kind
      * @param dlTree the content tree to which the description will be added
      */
     protected void addDescription(MemberDoc member, Content dlTree) {
         String name = (member instanceof ExecutableMemberDoc)?
             member.name() + ((ExecutableMemberDoc)member).flatSignature() :
             member.name();
         if (name.indexOf("<") != -1 || name.indexOf(">") != -1) {
                 name = Util.escapeHtmlChars(name);
         }
         Content span = HtmlTree.SPAN(HtmlStyle.strong,
                 getDocLink(LinkInfoImpl.CONTEXT_INDEX, member, name));
         Content dt = HtmlTree.DT(span);
         dt.addContent(" - ");
         addMemberDesc(member, dt);
         dlTree.addContent(dt);
         Content dd = new HtmlTree(HtmlTag.DD);
         addComment(member, dd);
         dlTree.addContent(dd);
     }
     /**
      * Add comment for each element in the index. If the element is deprecated
      * and it has a @deprecated tag, use that comment. Else if the containing
      * class for this element is deprecated, then add the word "Deprecated." at
      * the start and then print the normal comment.
      *
      * @param element Index element
      * @param contentTree the content tree to which the comment will be added
      */
     protected void addComment(ProgramElementDoc element, Content contentTree) {
         Tag[] tags;
         Content span = HtmlTree.SPAN(HtmlStyle.strong, deprecatedPhrase);
         HtmlTree div = new HtmlTree(HtmlTag.DIV);
         div.addStyle(HtmlStyle.block);
         if (Util.isDeprecated(element)) {
             div.addContent(span);
             if ((tags = element.tags("deprecated")).length > 0)
                 addInlineDeprecatedComment(element, tags[0], div);
             contentTree.addContent(div);
         } else {
             ClassDoc cont = element.containingClass();
             while (cont != null) {
                 if (Util.isDeprecated(cont)) {
                     div.addContent(span);
                     contentTree.addContent(div);
                     break;
                 }
                 cont = cont.containingClass();
             }
             addSummaryComment(element, contentTree);
         }
     }
     /**
      * Add description about the Static Varible/Method/Constructor for a
      * member.
      *
      * @param member MemberDoc for the member within the Class Kind
      * @param contentTree the content tree to which the member description will be added
      */
     protected void addMemberDesc(MemberDoc member, Content contentTree) {
         ClassDoc containing = member.containingClass();
         String classdesc = Util.getTypeName(
                 configuration, containing, true) + " ";
         if (member.isField()) {
             if (member.isStatic()) {
                 contentTree.addContent(
                         getResource("doclet.Static_variable_in", classdesc));
             } else {
                 contentTree.addContent(
                         getResource("doclet.Variable_in", classdesc));
             }
         } else if (member.isConstructor()) {
             contentTree.addContent(
                     getResource("doclet.Constructor_for", classdesc));
         } else if (member.isMethod()) {
             if (member.isStatic()) {
                 contentTree.addContent(
                         getResource("doclet.Static_method_in", classdesc));
             } else {
                 contentTree.addContent(
                         getResource("doclet.Method_in", classdesc));
             }
         }
         addPreQualifiedClassLink(LinkInfoImpl.CONTEXT_INDEX, containing,
                 false, contentTree);
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/doclets/formats/html/AbstractIndexWriter.java@25e14ad23cef (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/AbstractIndexWriter.java