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 --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 {
}

v1.13.7

Fixing issues with jekyll sites not correctly linking to related classes when using @see and {@link ClassName} annotations.

v2.0.0-alpha.14

Ground up refactoring using the Apex Reflection library for Apex code parsing.

v1.13.4

• Encoding HTML characters for anything outputted by the Markdown generator. 35f4887

v1.13.2...v1.13.4

Method types with `<>` and spaces now returned correctly.

Fixes issue #12 where method types with <> and spaces in between were not correctly generating the return type.

v1.11.0

• Issue #9 where the @return param was missing from the generated docs was fixed. Thanks to @NicolasGach for reporting and submitting the fix!

v1.10.2

Fixed rendering issues with void private methods where the description was showing as a stand-alone title.

V1.10.1

• Fixed issue #4
• yargs dependecy updated to latest available version.

v1.10.0

Added support for the namespaceaccessble scope.

When this scope is defined any code marked as @NamespaceAccessible will be included as part of the documentation, even if the additional scope of the code is not specified. For example, if you have a NamespaceAccessible public class and specify the namespaceaccessble scope but not the public scope, the code will still be picked up.

v1.9.0

• A default group name can now be set for classes that do not have an @group annotation to override the default "Miscellaneous"
• Can now specify the programming language to use when generating code example blocks, which gives you the ability to add syntax highlighting to the generated files.
• Support for @throws annotation
• Support for {@link ClassName} syntax to generate a hyperlink between classes.