@cparra/apexdocs 2.25.0-alpha.8 → 2.25.0

package/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  rules: {},
+};

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 and Interfaces
+### Documenting Classes
 
-The following tags are supported at the class or interface level:
+The following tags are supported on the class 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.                 |
-| `@date`        | The date the class was created.          |
+| 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. |
 
 **Example**
 
@@ -207,13 +207,9 @@ public with sharing class TestClass {
 
 The following tags are supported on the enum level:
 
-| 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.                   |
+| Tag            | Description                            |
+|----------------|----------------------------------------|
+| `@description` | One or more lines describing the enum. |
 
 **Example**
 
@@ -226,25 +222,6 @@ 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:
@@ -276,7 +253,6 @@ 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**
 
@@ -292,43 +268,6 @@ 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/apexdocs.config.ts

@@ -0,0 +1,13 @@
+import { TargetFile, TargetType } from './src/settings';
+
+export default {
+  onBeforeFileWrite: (file: TargetFile): TargetFile => {
+    console.log('onBefore writing', file);
+    return file;
+  },
+  onAfterProcess: (files: TargetFile[]) => {
+    console.log('onAfterProcess files', files);
+  },
+  frontMatterHeader: (file: TargetType) => [`title: ${file.name}.cls`, `description: ${file.description}`],
+  sortMembersAlphabetically: true,
+};

package/docs/README.md

@@ -0,0 +1 @@
+Go to [docs](/types/README.md) for more information.

package/docs/index.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '',
+      repo: ''
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>