jdk-sandbox: comparison langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/ClassBuilder.java

equal deleted inserted replaced

-:e17429a7e843
+:1c355ea550ed
 * questions.
 */
 package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
 import javax.lang.model.element.PackageElement;
 import javax.lang.model.element.TypeElement;
 import jdk.javadoc.internal.doclets.toolkit.ClassWriter;
 import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException;
 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
 /**
 * Builds the summary for a given class.
 *
 isEnum = false;
 }
 }
 /**
-* Construct a new ClassBuilder.
+* Constructs a new ClassBuilder.
 *
 * @param context  the build context
 * @param typeElement the class being documented.
 * @param writer the doclet specific writer.
+* @return the new ClassBuilder
 */
 public static ClassBuilder getInstance(Context context,
 TypeElement typeElement, ClassWriter writer) {
 return new ClassBuilder(context, typeElement, writer);
 }
 /**
 * {@inheritDoc}
 */
-public void build() throws IOException {
+@Override
+public void build() throws DocletException {
 build(layoutParser.parseXML(ROOT), contentTree);
 }
 /**
 * {@inheritDoc}
 */
+@Override
 public String getName() {
 return ROOT;
 }
 /**
 * Handles the {@literal <TypeElement>} tag.
 *
 * @param node the XML element that specifies which components to document
 * @param contentTree the content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the documentation
 */
-public void buildClassDoc(XMLNode node, Content contentTree) throws Exception {
+public void buildClassDoc(XMLNode node, Content contentTree) throws DocletException {
 String key;
 if (isInterface) {
 key =  "doclet.Interface";
 } else if (isEnum) {
 key = "doclet.Enum";
 /**
 * Build the class information tree documentation.
 *
 * @param node the XML element that specifies which components to document
 * @param classContentTree the content tree to which the documentation will be added
-*/
+* @throws DocletException if there is a problem while building the documentation
-public void buildClassInfo(XMLNode node, Content classContentTree) {
+*/
+public void buildClassInfo(XMLNode node, Content classContentTree) throws DocletException {
 Content classInfoTree = writer.getClassInfoTreeHeader();
 buildChildren(node, classInfoTree);
 classContentTree.addContent(writer.getClassInfo(classInfoTree));
 }
 /**
-* Build the typeparameters of this class.
+* Build the type parameters of this class.
 *
 * @param node the XML element that specifies which components to document
 * @param classInfoTree the content tree to which the documentation will be added
 */
 public void buildTypeParamInfo(XMLNode node, Content classInfoTree) {
 writer.addNestedClassInfo(classInfoTree);
 }
 /**
 * Copy the doc files.
-*/
+*
-private void copyDocFiles() {
+* @throws DocFileIOException if there is a problem while copying the files
+*/
+private void copyDocFiles() throws DocFileIOException {
 PackageElement containingPackage = utils.containingPackage(typeElement);
 if((configuration.packages == null ||
 !configuration.packages.contains(containingPackage)) &&
 !containingPackagesSeen.contains(containingPackage)) {
 //Only copy doc files dir if the containing package is not
 /**
 * Build the member summary contents of the page.
 *
 * @param node the XML element that specifies which components to document
 * @param classContentTree the content tree to which the documentation will be added
-*/
+* @throws DocletException if there is a problem while building the documentation
-public void buildMemberSummary(XMLNode node, Content classContentTree) throws Exception {
+*/
+public void buildMemberSummary(XMLNode node, Content classContentTree) throws DocletException {
 Content memberSummaryTree = writer.getMemberTreeHeader();
 configuration.getBuilderFactory().
 getMemberSummaryBuilder(writer).buildChildren(node, memberSummaryTree);
 classContentTree.addContent(writer.getMemberSummaryTree(memberSummaryTree));
 }
 /**
 * Build the member details contents of the page.
 *
 * @param node the XML element that specifies which components to document
 * @param classContentTree the content tree to which the documentation will be added
-*/
+* @throws DocletException if there is a problem while building the documentation
-public void buildMemberDetails(XMLNode node, Content classContentTree) {
+*/
+public void buildMemberDetails(XMLNode node, Content classContentTree) throws DocletException {
 Content memberDetailsTree = writer.getMemberTreeHeader();
 buildChildren(node, memberDetailsTree);
 classContentTree.addContent(writer.getMemberDetailsTree(memberDetailsTree));
 }
 /**
 * Build the enum constants documentation.
 *
 * @param node the XML element that specifies which components to document
 * @param memberDetailsTree the content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the documentation
 */
 public void buildEnumConstantsDetails(XMLNode node,
-Content memberDetailsTree) throws Exception {
+Content memberDetailsTree) throws DocletException {
 configuration.getBuilderFactory().
 getEnumConstantsBuilder(writer).buildChildren(node, memberDetailsTree);
 }
 /**
 * Build the field documentation.
 *
 * @param node the XML element that specifies which components to document
 * @param memberDetailsTree the content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the documentation
 */
 public void buildFieldDetails(XMLNode node,
-Content memberDetailsTree) throws Exception {
+Content memberDetailsTree) throws DocletException {
 configuration.getBuilderFactory().
 getFieldBuilder(writer).buildChildren(node, memberDetailsTree);
 }
 /**
 * Build the property documentation.
 *
-* @param elements the XML elements that specify how a field is documented.
+* @param node the XML element that specifies which components to document
+* @param memberDetailsTree the content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the documentation
 */
 public void buildPropertyDetails(XMLNode node,
-Content memberDetailsTree) throws Exception {
+Content memberDetailsTree) throws DocletException {
 configuration.getBuilderFactory().
 getPropertyBuilder(writer).buildChildren(node, memberDetailsTree);
 }
 /**
 * Build the constructor documentation.
 *
 * @param node the XML element that specifies which components to document
 * @param memberDetailsTree the content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the documentation
 */
 public void buildConstructorDetails(XMLNode node,
-Content memberDetailsTree) throws Exception {
+Content memberDetailsTree) throws DocletException {
 configuration.getBuilderFactory().
 getConstructorBuilder(writer).buildChildren(node, memberDetailsTree);
 }
 /**
 * Build the method documentation.
 *
 * @param node the XML element that specifies which components to document
 * @param memberDetailsTree the content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the documentation
 */
 public void buildMethodDetails(XMLNode node,
-Content memberDetailsTree) throws Exception {
+Content memberDetailsTree) throws DocletException {
 configuration.getBuilderFactory().
 getMethodBuilder(writer).buildChildren(node, memberDetailsTree);
 }
 }

changeset 40587	1c355ea550ed
parent 40303	96a1226aca18
child 45599	8bc3a019f948