Skip to content

Commit

Permalink
1.0.0.1 documentation changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
SCWells72 committed Mar 7, 2023
1 parent 6f5e667 commit 3bd0beb
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 21 deletions.
19 changes: 0 additions & 19 deletions .idea/gradle.xml

This file was deleted.

2 changes: 1 addition & 1 deletion .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion ACKNOWLEDGEMENTS.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
In accordance with the respective licenses, IcApexDoc recognizes the following
third-party libraries which it uses directly:
third-party libraries which are used directly and their respective transitive
dependencies:

* Apache Commons CLI
* Apache Commons Collections 4
* Apache Commons IO
* Apache Commons Lang 3
* Apache Commons Text
* ClassGraph
* Google GSON
* Oracle Bean Validation API
* Jakarta XML Binding API
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ An API documentation generator for Salesforce Apex types and triggers and custom
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
* [Release Notes](RELEASE-NOTES.md)

## Overview

Expand Down Expand Up @@ -84,6 +85,7 @@ The following ApexDoc macros are supported:

* `{@link <reference>}` - Creates a link to the specified type or member.
* `<<reference>>` - Creates a link to the specified type or member. **NOTE:** This macro is specifically `<<...>>`; the angle brackets do not frame a variable.
* `{@code <code>}` - Formats the text as code.
* <code>\`&lt;code&gt;\`</code> - Formats the text between backticks as code.

References can be specified as:
Expand Down
16 changes: 16 additions & 0 deletions RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Release Notes

* [1.0.0.1](#1001)

## [1.0.0.1](https://github.com/SCWells72/IcApexDoc/releases/tag/1.0.0.1)

* Changed from a single jar distribution to a multi-jar distribution retaining the original dependency jars. This should be a no-op for users.
* The standard Apex classes are now compiled alongside the local source files. This resolves an issue with inheritance relationships against standard base classes and interfaces being properly conveyed into the generated HTML files.
* Note that I discovered a strange behavior in the Apex jorje parser with references to standard parameterized interfaces, specifically `System.Iterable`, `System.Iterator`, and `Database.Batchable`, where the type parameters must be removed from source handed to the compiler or errors are produced. IcApexDoc does this automatically, but this results in generated HTML that loses the type parameters for those interfaces. I have logged this as an open issue/question with the appropriate folks at Salesforce and will hopefully be able to address it without this negative side-effect once I hear back from them.
* Fixed an issue with stability of declaration sort order when a project contains multiple declarations with the same name but different declaration types, e.g., a class and a trigger with the same name.
* Fixed an issue with the `apexdoc` shell script not properly propagating command-line arguments with spaces.
* Removed a leading space from the `extends`/`implements` clauses of Apex type declaration signatures.
* Improved HTML generation for section details by using tables so that wrapping occurs properly. Note that this required some **updates to the CSS classes**, so if you've customized the CSS, please **reconcile** with the latest `default.css` as needed. I hope to keep these types of changes to a minimum going forward.
* Removed support for escaping of parameterized type references in HTML. This was causing no end of issues and is technically incorrect. The correct solutions are to:
1. Replace angle brackets with the respective HTML entities, e.g., `List<Type>` becomes `List&lt;Type&gt;`.
2. Surround the parameterized type reference with one of the macros for rendering code, e.g., <code>\`List&lt;Type&gt;\`</code> or `{@code List<Type>}`.

0 comments on commit 3bd0beb

Please sign in to comment.