ReleaseNotes

SfApexDoc Releases

Home | Doc Format | Usage | Release Notes

1.3.0 Discontinued support for Eclipse plugin (11/22/2019)

fixed "Exception parsing /**/ (empty comment); String index out of range: -1
updated links to Salesforce primitive types (String, SObject, etc.)
correctly handle multiple properties declared on the same line (e.g. String a, b, c;)
added command line parameter to disable method and property sorting
document private classes with no access specifier (properties and methods are not yet supported)

1.2.5 Allow specification of list of files to process (10/22/2014)

fixed issue #30 (closed): Bad source path causes plugin to fail silently
if present, "SfApexDocFiles.txt" is parsed for a list of files to include. It is assumed that the file is in the working directory; file names include extension, but not directory information

1.2.4 Added support for webservice methods and @throws (3/21/2014)

fixed links to nested classes; link is now to parent class, rather than non-existent page
added support for @throws; properties and methods may specify one or more @throws tags (i.e. "@throws MyClass.MyException when something extreme happens")
added support for webservice methods; these methods will now be included in the documentation whenever the "global" or "webservice" scope is specified

1.2.3 Single printable page and customizable CSS / images (3/1/2014)

"all" page (_all.html) is now generated and displays all docs in a single, expanded page
renamed the logo file; resource files no longer overwrite existing files. This means that you can modify your CSS and images and not worry about them getting overwritten by subsequent builds.

1.2.2 CSS fixes and file selection dialog correction (1/24/2014)

cells in the documentation table are now v-aligned to the top
the browse buttons for the Home and Author pages were invoking a Save dialog, instead of an Open dialog

1.2.1 Non-doc comments and nested class handling (1/4/2014)

better handling of non-doc comments (/* */)
sort properties and methods of nested classes
corrected usage message - scope params are comma-separated, not semi-colon-separated

1.2.0 Nested classes (12/16/2013)

Issue 3: Nested classes
moved all CSS from java code to .CSS file

1.1.1 Defect fixes, code cleanup (10/26/2013)

added Schedulable and Batchable interfaces as links
improved handling of
```
 tags
```
added linking of subclasses
Issue 19: Eclipse plugin can only be run once
Issue 18: Eclipse plugin - remember preferences

1.1.0 Eclipse plugin, multi-line signatures (9/3/2013)

removed unit testing code from SfApexDoc.jar
created Eclipse plugin
fixed parsing of class, method, and property signatures spanning multiple lines

1.0.2 Better signature parsing, sorting (8/31/2013)

instead of terminating on error, display file name, line index, line -- and continue processing
fixed case sensitivity of "class" keyword; CLASS and Interface are now recognized
methods and properties are sorted alphabetically
added lots more unit tests

1.0.1 Links to types, unit tests, and GitLab project (8/25/2013)

SfApexDoc is now on GitLab!
added lots of unit tests
create links in declaration lines and @See tabs for most Apex types and project custom types
allow single-line comments (i.e. /** @author me */)
@Description tag is now optional
added processing for interfaces
added class/interface declaration subtitle line

1.0.0 Initial port from ApexDoc (8/23/2013)

upgraded JRE to 1.6
removed Eclipse plugin code
command line 'scope' values are now delimited by "," instead of ";"
many improvements in parsing flexibility

Home | Doc Format | Usage | Release Notes