@cparra/apexdocs 2.25.0 → 3.0.0-alpha.10

package/.github/workflows/ci.yaml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: ["master", "develop"]
+  pull_request:
+    branches: ["main", "develop"]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+          cache: "npm"
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

package/README.md

@@ -178,20 +178,20 @@ which is what gets used by this library behind the scenes to generate the docume
 
 ApexDocs picks up blocks of comments throughout your `.cls` files. The block must begin with `/**` and end with `*/`.
 
-### Documenting Classes
+### Documenting Classes and Interfaces
 
-The following tags are supported on the class level:
+The following tags are supported at the class or interface level:
 
 **Note** Any custom generated tag is also supported. Custom tags can be added with at symbol (`@`) followed by the name
 of the tag. For example `@custom-tag`
 
-| Tag            | Description                                                                                                                                |
-|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
-| `@description` | One or more lines describing the class.                                                                                                    |
-| `@see`         | The name of a related class.                                                                                                               |
-| `@group`       | The group to which the class belongs to.                                                                                                   |
-| `@author`      | The author of the class. Note that this only gets added if it is explicitly defined through the configuration class that it should.        |
-| `@date`        | The date the class was created. Note that this only gets added if it is explicitly defined through the configuration class that it should. |
+| Tag            | Description                              |
+|----------------|------------------------------------------|
+| `@description` | One or more lines describing the class.  |
+| `@see`         | The name of a related class.             |
+| `@group`       | The group to which the class belongs to. |
+| `@author`      | The author of the class.                 |
+| `@date`        | The date the class was created.          |
 
 **Example**
 
@@ -207,9 +207,13 @@ public with sharing class TestClass {
 
 The following tags are supported on the enum level:
 
-| Tag            | Description                            |
-|----------------|----------------------------------------|
-| `@description` | One or more lines describing the enum. |
+| Tag            | Description                                      |
+|----------------|--------------------------------------------------|
+| `@description` | One or more lines describing the enum.           |
+| `@see`         | The name of a related class, enum, or interface. |
+| `@group`       | The group to which the enum belongs to.          |
+| `@author`      | The author of the enum.                          |
+| `@date`        | The date the enum was created.                   |
 
 **Example**
 
@@ -222,6 +226,25 @@ public Enum ExampleEnum {
 }
 ```
 
+### Documenting Enum Values
+
+The following tags are supported on the enum value level:
+
+| Tag            | Description                             |
+|----------------|-----------------------------------------|
+| `@description` | One or more lines describing the value. |
+
+**Example**
+
+```apex
+public enum ExampleEnum {
+    /** @description This is my enum value description. */
+    VALUE_1,
+    /** @description This is my other enum value description. */
+    VALUE_2
+}
+```
+
 ### Documenting Properties
 
 The following tags are supported on the property level:
@@ -253,6 +276,7 @@ The following tags are supported on the method level:
 | `@example`                   | Example of how the code can be used or called.    |
 | `@throws` _ExceptionName_    | Description of an exception thrown by the method. |
 | `@exception` _ExceptionName_ | Same as `@throws`. V2 only                        |
+| `@mermaid`                   | Diagrams in Mermaid format.                       |
 
 **Example**
 
@@ -268,6 +292,43 @@ public static Object call(String action) {
 }
 ```
 
+### Using custom tags
+
+You can use custom tags to document your code. Custom tags can be added with at symbol (`@`) followed by the name
+of the tag. Apexdocs will automatically format tags which words are separated by a dash (`-`) by separating them with a
+space and uppercasing them. For example, `@custom-tag` will be displayed as `Custom Tag`.
+
+Within a custom tag, you can also add code blocks by using the triple backtick syntax. This is useful when you want to
+display code snippets within your documentation.
+
+**Example**
+
+```apex
+   /**
+    * @custom-tag This is a custom tag
+    * @custom-tag-with-code
+    * ```
+    * System.debug('Hello World');
+    * ```
+    */
+   public class MyClass {
+   }
+```
+
+Note that the language of the code block will be set to `apex` by default, but you can change it by adding the language
+name after the triple backticks. For example, to display a JavaScript code block you can use:
+
+```apex
+   /**
+    * @custom-tag-with-code
+    * ```javascript
+    * console.log('Hello World');
+    * ```
+    */
+   public class MyClass {
+   }
+```
+
 ### Grouping Declarations Within A Class
 
 A class might have members that should be grouped together. For example, you can have a class for constants with

package/__mocks__/chalk.js

@@ -0,0 +1,12 @@
+// __mocks__/chalk.js
+module.exports = new Proxy(
+  {},
+  {
+    get: function (target, property) {
+      return property === 'default' ? this : (text) => text;
+    },
+    green: function (text) {
+      return text;
+    },
+  },
+);

package/__mocks__/log-update.js

@@ -0,0 +1,6 @@
+// This is a basic mock that can be expanded based on your needs.
+// It mocks the main function of log-update to just log to console or do nothing.
+module.exports = {
+  // Mock the main function to just log the text or do nothing
+  default: function () {},
+};