Line 498
Link Here
|
|
|
498 |
|
Line 499
Link Here
|
|
|
500 |
* Does this instance of javadoc work around command line length limit by |
501 |
* using an external file for the sourcefiles. |
502 |
* |
503 |
* @return true if an external file is to be used. |
504 |
*/ |
505 |
public boolean getUseExternalFile() { |
506 |
return useExternalFile; |
507 |
} |
508 |
|
509 |
|
510 |
/** |
Line 509
Link Here
|
|
|
521 |
|
Line 510
Link Here
|
|
|
523 |
* Gets whether default exclusions should be used or not. |
524 |
* |
525 |
* @return true when default exclusions should be used, |
526 |
false when they shouldn't be used. |
527 |
*/ |
528 |
public boolean getDefaultexcludes() { |
529 |
return this.useDefaultExcludes; |
530 |
} |
531 |
|
532 |
|
533 |
/** |
Line 553
Link Here
|
|
|
577 |
|
Line 554
Link Here
|
|
|
579 |
* Returns the path where javadoc will find source files |
580 |
* |
581 |
* @return a Path instance containing the various source directories. |
582 |
*/ |
583 |
public Path getSourcepath() { |
584 |
return this.sourcePath; |
585 |
} |
586 |
|
587 |
|
588 |
/** |
Line 586
Link Here
|
|
|
621 |
|
Line 587
Link Here
|
|
|
623 |
* Get the directory where the Javadoc output will be generated. |
624 |
* |
625 |
* @return the destination directory. |
626 |
*/ |
627 |
public File getDestDir() { |
628 |
return this.destDir; |
629 |
} |
630 |
|
631 |
/** |
Line 610
Link Here
|
|
|
655 |
|
Line 611
Link Here
|
|
|
657 |
* Get the source files |
658 |
* |
659 |
* @return a Vector of SourceFile instances. |
660 |
*/ |
661 |
public Vector getSourceFiles() { |
662 |
return sourceFiles; |
663 |
} |
664 |
|
665 |
|
666 |
/** |
Line 628
Link Here
|
|
|
684 |
|
Line 629
Link Here
|
|
|
686 |
* Get the package names to be processed. |
687 |
* |
688 |
* @return a Vector of packages Javadoc.PackageName instances. |
689 |
* |
690 |
* @see #addPackage for wildcard information. |
691 |
*/ |
692 |
public Vector getPackagenames(String packages) { |
693 |
return this.packageNames; |
694 |
} |
695 |
|
696 |
|
697 |
/** |
Line 656
Link Here
|
|
|
725 |
|
Line 657
Link Here
|
|
|
727 |
* Get the package names to be excluded. |
728 |
* |
729 |
* @return a Vector of packages Javadoc.PackageName instances. |
730 |
*/ |
731 |
public Vector getExcludePackageNames(String packages) { |
732 |
return this.excludePackageNames; |
733 |
} |
734 |
|
735 |
|
736 |
/** |
Line 743
Link Here
|
|
|
823 |
|
Line 744
Link Here
|
|
|
825 |
* Get the class that starts the doclet used in generating the |
826 |
* documentation. |
827 |
* |
828 |
* @return the name of the doclet class. |
829 |
*/ |
830 |
public String getDoclet() { |
831 |
return this.doclet.getName(); |
832 |
} |
833 |
|
834 |
|
835 |
|
836 |
/** |
Line 757
Link Here
|
|
|
850 |
* Get the classpath used to find the doclet class. |
851 |
* |
852 |
* @return the doclet classpath. |
853 |
*/ |
854 |
public Path getDocletPath() { |
855 |
return this.doclet.getPath(); |
856 |
} |
857 |
|
858 |
/** |
Line 825
Link Here
|
|
|
927 |
|
Line 826
Link Here
|
|
|
929 |
* Get the classpath to be used for this javadoc run. |
930 |
* |
931 |
* @return an Ant Path object containing the compilation |
932 |
* classpath. |
933 |
*/ |
934 |
public Path getClasspath() { |
935 |
return this.classpath; |
936 |
} |
937 |
|
938 |
|
939 |
/** |
Line 948
Link Here
|
|
|
1062 |
* Include the version tag in the generated documentation. |
1063 |
* |
1064 |
* @return true if the version tag should be included. |
1065 |
*/ |
1066 |
public boolean getVersion() { |
1067 |
return this.version; |
1068 |
} |
1069 |
|
1070 |
/** |
Line 967
Link Here
|
|
|
1090 |
* Include the author tag in the generated documentation. |
1091 |
* |
1092 |
* @return true if the author tag should be included. |
1093 |
*/ |
1094 |
public boolean getAuthor() { |
1095 |
return this.author; |
1096 |
} |
1097 |
|
1098 |
|
1099 |
/** |
Line 996
Link Here
|
|
|
1129 |
|
Line 997
Link Here
|
|
|
1131 |
* Get the title of the generated overview page. |
1132 |
* |
1133 |
* @return the Document title. |
1134 |
*/ |
1135 |
public Html getDoctitle() { |
1136 |
return this.doctitle; |
1137 |
} |
1138 |
|
1139 |
/** |
Line 1018
Link Here
|
|
|
1161 |
|
Line 1019
Link Here
|
|
|
1163 |
* Get the header text to be placed at the top of each output file. |
1164 |
* |
1165 |
* @return the header text. |
1166 |
*/ |
1167 |
public Html getHeader() { |
1168 |
return this.header; |
1169 |
} |
1170 |
|
1171 |
|
1172 |
/** |
Line 1041
Link Here
|
|
|
1195 |
* Get the footer text to be placed at the bottom of each output file. |
1196 |
* |
1197 |
* @param footer the footer text. |
1198 |
*/ |
1199 |
public Html getFooter() { |
1200 |
return this.footer; |
1201 |
} |
1202 |
|
1203 |
/** |
Line 1063
Link Here
|
|
|
1226 |
* Get the text to be placed at the bottom of each output file. |
1227 |
* |
1228 |
* @return the bottom text. |
1229 |
*/ |
1230 |
public Html getBottom() { |
1231 |
return this.bottom; |
1232 |
} |
1233 |
|
1234 |
/** |
Line 1111
Link Here
|
|
|
1283 |
* Group specified packages together in overview page. |
1284 |
*/ |
1285 |
public String getGroup() { |
1286 |
return this.group; |
1287 |
} |
1288 |
|
1289 |
/** |
Line 1120
Link Here
|
|
|
1299 |
* Get links to be added to javadoc output. |
1300 |
* |
1301 |
* @return a Vector of LinkArgument instances. |
1302 |
*/ |
1303 |
public Vector getLinks() |
1304 |
{ |
1305 |
return this.links; |
1306 |
} |
1307 |
|
1308 |
/** |
Line 1521
Link Here
|
|
|
1710 |
* Should the build process fail if javadoc fails (as indicated by |
1711 |
* a non zero return code)? |
1712 |
* |
1713 |
*/ |
1714 |
public boolean getFailonerror() { |
1715 |
return this.failOnError; |
1716 |
} |
1717 |
|
1718 |
/** |
Line 1535
Link Here
|
|
|
1733 |
* Enables the -source switch, will be ignored if javadoc is not |
1734 |
* the 1.4 version or a different doclet than the standard doclet |
1735 |
* is used. |
1736 |
* |
1737 |
* @since Ant 1.5 |
1738 |
*/ |
1739 |
public String getSource() { |
1740 |
return this.source; |
1741 |
} |
1742 |
|
1743 |
/** |
Line 1547
Link Here
|
|
|
1756 |
* Get the current pakcageset. |
1757 |
* |
1758 |
* @return a Vector of DirSet instances. |
1759 |
*/ |
1760 |
public Vector getPackagesets() { |
1761 |
return this.packageSets; |
1762 |
} |
1763 |
|
1764 |
/** |
Line 1559
Link Here
|
|
|
1777 |
|
1778 |
|
1779 |
/** |
1780 |
* Get the current filesets. |
1781 |
* |
1782 |
* @return a Vector of FileSet instances. |
1783 |
*/ |
1784 |
public Vector getFilesets() { |
1785 |
return fileSets; |
1786 |
} |
1787 |
|