1.0.0.7 updates.

SCWells72 · May 25, 2023 · f6df163 · f6df163
1 parent 28c49c9
commit f6df163
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 1 deletion.
diff --git 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)
 * [Validation](#validation)
+* [Troubleshooting](#troubleshooting)
 * [License](#license)
 * [Release Notes](RELEASE-NOTES.md)
 
@@ -228,6 +229,7 @@ usage: apexdoc <options> | @<optionsFile>
  -c,--css <arg>                  custom stylesheet file
  -h,--help                       show usage details
  -version,--version              show version information
+ -verbose,--verbose              enable verbose error logging
 ```
 
 As indicated, command-line options can be specified explicitly or as the contents of an [options file](#options-file).
@@ -452,11 +454,16 @@ The following properties can be configured in the validator options JSON file:
 | `validateSinceTagValue`                                | If enabled, `@since` tags which do not specify a value are flagged. Enabled by default.                                                                                                                                                         |
 | `validateExampleTagValue`                              | If enabled, `@example` tags which do not specify a value are flagged. Enabled by default.                                                                                                                                                       |
 | `validateDeprecatedTagDescription`                     | If enabled, `@deprecated` tags which do not provide a description are flagged. Disabled by default.                                                                                                                                             |
+| `validateMarkdown`                                     | If enabled, reports issues found in Markdown. Enabled by default.                                                                                                                                                                               |
 
 Note that it is only necessary to include options _for which values are different from their defaults_ in an options file. The default values for all unspecified options will be used automatically.
 
 A [JSON schema](validator/apexdoc_validator.schema.json) is available and can be registered with most IDEs to provide code completion and validation for these options files. A comprehensive [example configuration file](validator/apexdoc_validator_example.json), is also available for reference, but as stated previously, _only customized properties_ need to be included in the options file.
 
+## Troubleshooting
+
+If IcApexDoc fails or reports errors due to caught exceptions, the `-verbose`/`--verbose` command-line argument can be used to enable logging of the full caught exception stack trace. Generally this would be included in a bug report in the public issue tracker along with steps to reproduce the issue.
+
 ## License
 
 IcApexDoc is 100% free to use under the [**Apache 2.0 License**](https://www.apache.org/licenses/LICENSE-2.0). Note that while portions of IcApexDoc have been derived from [**Illuminated Cloud 2**](https://www.illuminatedcloud.com/), that product&mdash;and its predecessor [**Illuminated Cloud 1**](https://www.illuminatedcloud.com/purchase/illuminated-cloud-1)&mdash;are **commercial products** offered under their own legal [**Terms and Conditions**](https://www.illuminatedcloud.com/purchase/terms-and-conditions). Access to or usage of IcApexDoc does not **in any way** entitle the user to a license for either Illuminated Cloud 2 or Illuminated Cloud 1.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,12 +1,20 @@
 # Release Notes
 
+* [1.0.0.7](#1007)
 * [1.0.0.6](#1006)
 * [1.0.0.5](#1005)
 * [1.0.0.4](#1004)
 * [1.0.0.3](#1003)
 * [1.0.0.2](#1002)
 * [1.0.0.1](#1001)
 
+## [1.0.0.7](https://github.com/SCWells72/IcApexDoc/releases/tag/1.0.0.7)
+
+* [Issue 11](https://github.com/SCWells72/IcApexDoc/issues/11) - Fixed an issue that would result in failed ApexDoc generation if Markdown included `$<something>` that would be interpreted incorrectly as a regular expression group reference.
+* Issues reported by Markdown-to-HTML conversion are included in ApexDoc validation output. This can be disabled if desired using the new `validateMarkdown` [ApexDoc validator](README.md#validator-options-file) option.
+* Fixed an issue with the `groupPage.vm` Velocity template that would result in an unbalanced `<div>` tag when group content is not present.
+* Added a `-verbose`/`--verbose` command-line option to print the full stack trace when exceptions are caught and logged. That behavior is disabled by default but can be enabled when [troubleshooting](README.md#troubleshooting) and reporting issues.
+
 ## [1.0.0.6](https://github.com/SCWells72/IcApexDoc/releases/tag/1.0.0.6)
 
 * [Issue 1](https://github.com/SCWells72/IcApexDoc/issues/1) - Added an **Index** tab that includes **all** visible declarations (according to the minimum visibility) partitioned by the first character of their namespace-relative (if appropriate) names hyperlinked to their respective declaration documentation. This should hopefully provide a quick and useful way to locate documentation for class constants, utility methods, etc., by name when the exact containing type name is not known.

diff --git a/validator/apexdoc_validator.schema.json b/validator/apexdoc_validator.schema.json
@@ -166,6 +166,16 @@
       "default": true,
       "description": "If enabled, @group tags which do not specify a group name are flagged. Enabled by default."
     },
+    "validateMisattributedGroupTag": {
+      "type": "boolean",
+      "default": true,
+      "description": "If enabled, @group tags used in the documentation comment for non-type/trigger declarations are flagged. Enabled by default."
+    },
+    "validateGroupContentTag": {
+      "type": "boolean",
+      "default": true,
+      "description": "If enabled, @group-content tags are flagged and the user is guided toward the -gc/--group-content option. Enabled by default."
+    },
     "validateDateTagValue": {
       "type": "boolean",
       "default": true,
@@ -185,6 +195,11 @@
       "type": "boolean",
       "default": false,
       "description": "If enabled, @deprecated tags which do not provide a description are flagged. Disabled by default."
+    },
+    "validateMarkdown": {
+      "type": "boolean",
+      "default": true,
+      "description": "If enabled, reports issues found in Markdown. Enabled by default."
     }
   }
 }
diff --git a/validator/apexdoc_validator_example.json b/validator/apexdoc_validator_example.json
@@ -37,11 +37,15 @@
   "validateAuthorTagValue": true,
 
   "validateGroupTagValue": true,
+  "validateMisattributedGroupTag": true,
+  "validateGroupContentTag": true,
 
   "validateDateTagValue": true,
   "validateSinceTagValue": true,
 
   "validateExampleTagValue": true,
 
-  "validateDeprecatedTagDescription": false
+  "validateDeprecatedTagDescription": false,
+
+  "validateMarkdown": true
 }