v2.17.1

Addresses:

• #93
• #94

https://www.npmjs.com/package/@cparra/apexdocs/v/2.17.1

v2.17.0

What's Changed

• Dependencies update by @cesarParra in #90
• Adding return type to method signature by @cesarParra in #92

Full Changelog: v2.16.0...v2.17.0

v2.16.0

Adds support for parsing a doc line that has multiple tags. Tags are not treated as annotations if they are wrapped in ticks (`)

for example

/**
 * @description something `@escaped` escaped
*/

---

What's Changed

• Bump yaml, husky and lint-staged by @dependabot in #83
• Bump fast-xml-parser from 4.0.7 to 4.2.4 by @dependabot in #84
• Bump tough-cookie from 4.0.0 to 4.1.3 by @dependabot in #85
• Bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in #87
• Releasing 2.16.0 by @cesarParra in #89
• Bump fast-xml-parser from 4.2.4 to 4.2.5 by @dependabot in #86

Full Changelog: v2.15.1...v2.16.0

v2.15.1

Includes fix for #81

v2.15.0

Includes

• #76

A new CLI argument has been added: documentationRootDir

If your documentation documents live in a subfolder of a bigger site, use this argument to specify the path to the subfolder (relative to the root of the site), to correctly generate links between documentation files.

v2.14.0

Includes:

• #72
• #73

v2.13.0

Improvements

Support for the @ignore tag.

An @ignore tag can now be used in any ApexDoc to have the annotated code be ignored during the documentation creation process.

Improved error handling

When dealing with uncaught exceptions, the process now exits with an exit code of 1

Upgraded to use the latest version of the Apex Reflection library, which support for the latest Apex improvements introduced during Winter 23

General improvements when generating OpenApi definitions

v2.12.0

General Improvements

Upgraded to latest version of the Apex Reflection library, which now ignores ApexDoc blocks in unexpected places of the code. This should improve the noise when parsing files with regular comments throughout the source code that are not meant to be apex docs, but still use the ApexDoc comment syntax /** ... */

OpenApi Improvements

RestResource annotations ending in a wildcard character are now cleanedup during the generation of the OpenApi definition file. e.g /Accounts/* will now simply be /Accounts/

2.11.0

Grouping improvements

• Fix for #48

OpenApi definition file improvements

• When parsing an HTTP related method, if no ApexDocs are given to override the request body definition, the method's arguments will be used to form the OpenApi's request body section for that endpoint
• Similarly, when no ApexDocs are given to override the response body, the method's return type will be used to form the response corresponding to the 200 status code.

v2.10.0

General updates

Namespace support

A new property has been added to allow for a package namespace to be specified. When set, the generated files will be created with the prepended namespace.

When generating an OpenApi definition, the namespace will be added to the file's server URL section, complying with how REST APIs for managed packages are exposed by Salesforce.

Upgraded to use the latest version of the Apex Reflection library

This version includes support for methods named void, which (for some reason) is allowed by Apex even though it is a keyword that should be reserved

OpenApi generator updates

Ability to specify the name of the output file through a new CLI argument

Ability to override the schema references when referencing custom classes from RestResource files.