/** * Indicate whether only protected and public classes and members are to * be included in the scope processed * * @param b true if scope is to be protected. */ public void setProtected(final boolean b) { addArgIf(b, "-protected"); }
/** * Set the title to be placed in the HTML <title> tag of the * generated documentation. * * @param title the window title to use. */ public void setWindowtitle(final String title) { addArgIfNotEmpty("-windowtitle", title); }
checkTaskName(); final Path sourceDirs = new Path(getProject()); checkPackageAndSourcePath(); parsePackages(packagesToDoc, sourceDirs); checkPackages(packagesToDoc, sourceDirs); addSourceFiles(sourceFilesToDoc); checkPackagesToDoc(packagesToDoc, sourceFilesToDoc); log("Generating Javadoc", Project.MSG_INFO); generalJavadocArguments(toExecute); // general Javadoc arguments doSourcePath(toExecute, sourceDirs); // sourcepath doDoclet(toExecute); // arguments for default doclet doBootPath(toExecute); // bootpath doLinks(toExecute); // links arguments doGroup(toExecute); // group attribute doGroups(toExecute); // groups attribute doDocFilesSubDirs(toExecute); // docfilessubdir attribute doJava14(toExecute); if (breakiterator && (doclet == null || JAVADOC_5)) { toExecute.createArgument().setValue("-breakiterator"); writeExternalArgs(toExecute);
/** * Set the list of source files to process. * * @param src a comma separated list of source files. */ public void setSourcefiles(final String src) { final StringTokenizer tok = new StringTokenizer(src, ","); while (tok.hasMoreTokens()) { final String f = tok.nextToken(); final SourceFile sf = new SourceFile(); sf.setFile(getProject().resolveFile(f.trim())); addSource(sf); } }
/** * Set the list of packages to be excluded. * * @param packages a comma separated list of packages to be excluded. * This may not include wildcards. */ public void setExcludePackageNames(final String packages) { final StringTokenizer tok = new StringTokenizer(packages, ","); while (tok.hasMoreTokens()) { final String p = tok.nextToken(); final PackageName pn = new PackageName(); pn.setName(p); addExcludePackage(pn); } }
/** * Set the package names to be processed. * * @param packages a comma separated list of packages specs * (may be wildcarded). * * @see #addPackage for wildcard information. */ public void setPackagenames(final String packages) { final StringTokenizer tok = new StringTokenizer(packages, ","); while (tok.hasMoreTokens()) { final String p = tok.nextToken(); final PackageName pn = new PackageName(); pn.setName(p); addPackage(pn); } }
/** * Set the title of the generated overview page. * * @param doctitle the Document title. */ public void setDoctitle(final String doctitle) { final Html h = new Html(); h.addText(doctitle); addDoctitle(h); }
/** * Set the header text to be placed at the top of each output file. * * @param header the header text */ public void setHeader(final String header) { final Html h = new Html(); h.addText(header); addHeader(h); }
/** * Set the footer text to be placed at the bottom of each output file. * * @param footer the footer text. */ public void setFooter(final String footer) { final Html h = new Html(); h.addText(footer); addFooter(h); }
/** * Set the text to be placed at the bottom of each output file. * * @param bottom the bottom text. */ public void setBottom(final String bottom) { final Html h = new Html(); h.addText(bottom); addBottom(h); }
/** * Generate a split index * * @param b true if the index should be split into a file per letter. */ public void setSplitindex(final boolean b) { addArgIf(b, "-splitindex"); }
/** * Charset for cross-platform viewing of generated documentation. * @param src the name of the charset */ public void setCharset(final String src) { this.addArgIfNotEmpty("-charset", src); }
/** * Control deprecated list generation * * @param b if true, do not generate deprecated list. */ public void setNodeprecatedlist(final boolean b) { addArgIf(b, "-nodeprecatedlist"); }
/** * Control generation of help link. * * @param b if true, do not generate help link */ public void setNohelp(final boolean b) { addArgIf(b, "-nohelp"); }
/** * Control warnings about serial tag. * * @param b if true, generate warning about the serial tag. */ public void setSerialwarn(final boolean b) { addArgIf(b, "-serialwarn"); }
/** * Indicate whether only public classes and members are to be included in * the scope processed * * @param b true if scope is to be public. */ public void setPublic(final boolean b) { addArgIf(b, "-public"); }
/** * Run javadoc in verbose mode * * @param b true if operation is to be verbose. */ public void setVerbose(final boolean b) { addArgIf(b, "-verbose"); }
/** * Control generation of index. * * @param b if true, do not generate index. */ public void setNoindex(final boolean b) { addArgIf(b, "-noindex"); }
/** * Control class tree generation. * * @param b if true, do not generate class hierarchy. */ public void setNotree(final boolean b) { addArgIf(b, "-notree"); }
/** * Indicate whether only package, protected and public classes and * members are to be included in the scope processed * * @param b true if scope is to be package level. */ public void setPackage(final boolean b) { addArgIf(b, "-package"); }