Skip to content

2.0.0

Choose a tag to compare

@cesarParra cesarParra released this 19 Mar 13:47
· 486 commits to master since this release

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 --group CLI parameter has been deprecated. All files are grouped by default.

Features from 1.X not supported in 2.X

  • The --configPath CLI 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 --scope CLI parameter, not just namespaceaccessible. This means
    that scopes like auraenabled, invocablemethod, invocablevariable, remoteaction, and all other valid Apex
    annotations are supported.
  • Just like Javadoc, both @throws and @exception are 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 {
}