2.0.0
Version 2.0.0 has been released.
Version shares almost* all the same functionality (and more) of 1.X , but is a rewrite from the ground up of the tool,
so please be aware if migrating from a 1.X version.
The Apex code parsing logic for the 1.X codebase was almost a one-to-one translation of the Java based ApexDoc tool to
Javascript. With 2.X the parsing logic has been improved and extracted out of this codebase, and into its own standalone
NPM module which is solely focused on Apex code reflection: https://www.npmjs.com/package/@cparra/apex-reflection
This allows for an improved code quality of both code bases and an increased ease of introducing future improvements and
fixing issues.
Differences between the versions
When migrating from 1.X please be aware of these changes between the major versions:
Deprecated features
- The
--groupCLI parameter has been deprecated. All files are grouped by default.
Features from 1.X not supported in 2.X
- The
--configPathCLI parameter has been temporarily deprecated. We are planning on reintroducing it but the config
file will use a different format.
New features
- All Apex annotations are now supported through the
--scopeCLI parameter, not justnamespaceaccessible. This means
that scopes likeauraenabled,invocablemethod,invocablevariable,remoteaction, and all other valid Apex
annotations are supported. - Just like Javadoc, both
@throwsand@exceptionare supported when referencing an exception thrown by a method or
constructor. - Any custom annotation defined in the Apexdoc is at the class level are supported, for example the following will be
output to the resulting markdown file:
/**
* @MyCustomAnnotation This is a custom annotation
*/
public class MyClass {
}