From 3bd0beb48d71e0981ed9915e0f8c6e91a21ec0db Mon Sep 17 00:00:00 2001
From: Scott Wells <scott@illuminatedcloud.com>
Date: Tue, 7 Mar 2023 14:53:22 -0600
Subject: [PATCH] 1.0.0.1 documentation changes.

---
 .idea/gradle.xml     | 19 -------------------
 .idea/misc.xml       |  2 +-
 ACKNOWLEDGEMENTS.txt |  4 +++-
 README.md            |  2 ++
 RELEASE-NOTES.md     | 16 ++++++++++++++++
 5 files changed, 22 insertions(+), 21 deletions(-)
 delete mode 100644 .idea/gradle.xml
 create mode 100644 RELEASE-NOTES.md

diff --git a/.idea/gradle.xml b/.idea/gradle.xml
deleted file mode 100644
index 02b3e5b..0000000
--- a/.idea/gradle.xml
+++ /dev/null
@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GradleMigrationSettings" migrationVersion="1" />
-  <component name="GradleSettings">
-    <option name="linkedExternalProjectsSettings">
-      <GradleProjectSettings>
-        <option name="delegatedBuild" value="false" />
-        <option name="testRunner" value="PLATFORM" />
-        <option name="distributionType" value="DEFAULT_WRAPPED" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-        <option name="modules">
-          <set>
-            <option value="$PROJECT_DIR$" />
-          </set>
-        </option>
-      </GradleProjectSettings>
-    </option>
-  </component>
-</project>
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
index 1bee480..2af9b65 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -14,7 +14,7 @@
   <component name="PreferredVcsStorage">
     <preferredVcsName>ApexVCS</preferredVcsName>
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="semeru-11" project-jdk-type="JavaSDK">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="11" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
 </project>
\ No newline at end of file
diff --git a/ACKNOWLEDGEMENTS.txt b/ACKNOWLEDGEMENTS.txt
index e18a95c..c1e6970 100644
--- a/ACKNOWLEDGEMENTS.txt
+++ b/ACKNOWLEDGEMENTS.txt
@@ -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
diff --git a/README.md b/README.md
index a606499..f497d4b 100644
--- a/README.md
+++ b/README.md
@@ -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
 
@@ -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:
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
new file mode 100644
index 0000000..186222d
--- /dev/null
+++ b/RELEASE-NOTES.md
@@ -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>}`.