@cparra/apexdocs 1.13.4 → 1.13.8

package/docs/Sample-Classes/SampleClass.md

@@ -1,30 +1,115 @@
-# SampleClass class
-
-`NamespaceAccessible`
-
-This is a class description.
-
----
-## Constructors
-### `SampleClass()`
-
-Constructs a SampleClass without any arguments.
-#### Example
-```
-<pre>
-SampleClass sampleInstance = new SampleClass();
-```
-
----
-## Methods
-### `testMethod(String argument)` → `String`
-
-Executes commands based on the passed in argument.
-#### Example
-```
-<pre>
-String result = SampleClass.testMethod();
-System.debug(result);
-```
-
----
+---
+layout: default
+---
+# SampleClass class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+## Related
+
+[SampleInterface](../Sample-Interfaces/SampleInterface.md)
+
+
+[SampleClass2](../Sample-Classes/SampleClass2.md)
+
+---
+## Constructors
+### `SampleClass()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass without any arguments.
+#### Example
+```
+<pre>
+SampleClass sampleInstance = new SampleClass();
+```
+
+### `SampleClass(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass with an argument.
+#### Parameters
+
+| Param | Description |
+| ----- | ----------- |
+|`argument` |  Some argument |
+
+---
+## Properties
+
+### `AnotherProp` → `Decimal`
+
+`NamespaceAccessible`
+
+This is a Decimal property.
+
+### `MyProp` → `String`
+
+`NamespaceAccessible`
+
+This is a String property.
+
+---
+## Methods
+### `call()` → `void`
+
+`NamespaceAccessible`
+
+Calls the method. This methods allows you to call it.
+
+### `testMethod(String argument)` → `String`
+
+`NamespaceAccessible`
+
+Executes commands based on the passed in argument.
+
+#### Example
+```
+<pre>
+String result = SampleClass.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClass.AnotherInnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClass.InnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---

package/docs/Sample-Classes/SampleClass2.md

@@ -0,0 +1,115 @@
+---
+layout: default
+---
+# SampleClass2 class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+## Related
+
+[SampleInterface](../Sample-Interfaces/SampleInterface.md)
+
+
+[SampleClass](../Sample-Classes/SampleClass.md)
+
+---
+## Constructors
+### `SampleClass2()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass2 without any arguments.
+#### Example
+```
+<pre>
+SampleClass2 sampleInstance = new SampleClass2();
+```
+
+### `SampleClass2(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass2 with an argument.
+#### Parameters
+
+| Param | Description |
+| ----- | ----------- |
+|`argument` |  Some argument |
+
+---
+## Properties
+
+### `AnotherProp` → `Decimal`
+
+`NamespaceAccessible`
+
+This is a Decimal property.
+
+### `MyProp` → `String`
+
+`NamespaceAccessible`
+
+This is a String property.
+
+---
+## Methods
+### `call()` → `void`
+
+`NamespaceAccessible`
+
+Calls the method. This methods allows you to call it.
+
+### `testMethod(String argument)` → `String`
+
+`NamespaceAccessible`
+
+Executes commands based on the passed in argument.
+
+#### Example
+```
+<pre>
+String result = SampleClass2.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClass2.AnotherInnerClass class
+
+Inner class belonging to SampleClass2.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClass2.InnerClass class
+
+Inner class belonging to SampleClass2.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---

package/docs/Sample-Interfaces/SampleInterface.md

@@ -1,13 +1,32 @@
-# SampleInterface interface
-
-This is an interface description.
-
----
-## Methods
-### `execute()` → `void`
-
-Executes the command.
-### `getValue()` → `String`
-
-Returns a value based on the executed command.
----
+---
+layout: default
+---
+# SampleInterface interface
+
+This is an interface description.
+
+## Related
+
+[SampleClass](../Sample-Classes/SampleClass.md)
+
+---
+## Methods
+### `execute()` → `void`
+
+Executes the command.
+
+### `getValue()` → `String`
+
+Returns a value based on the executed command.
+
+#### Return
+
+**Type**
+
+String
+
+**Description**
+
+Empty value
+
+---

package/docs/index.md

@@ -1,20 +1,27 @@
----
-layout: default
----
-# Classes
-## Sample Classes
-
-### [SampleClass](/Sample-Classes/SampleClass.md)
-
-
-This is a class description.
-
-
-## Sample Interfaces
-
-### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
-
-
-This is an interface description.
-
-
+---
+layout: default
+---
+# Classes
+## Sample Classes
+
+### [SampleClass](/Sample-Classes/SampleClass.md)
+
+
+This is a class description.
+
+
+
+### [SampleClass2](/Sample-Classes/SampleClass2.md)
+
+
+This is a class description.
+
+
+## Sample Interfaces
+
+### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
+
+
+This is an interface description.
+
+

package/docs/single-file/Sample-Classes/SampleClass.md

@@ -0,0 +1,115 @@
+---
+layout: default
+---
+# SampleClass class
+
+`NamespaceAccessible`
+
+This is a class description.
+
+## Related
+
+SampleInterface
+
+
+SampleClass2
+
+---
+## Constructors
+### `SampleClass()`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass without any arguments.
+#### Example
+```
+<pre>
+SampleClass sampleInstance = new SampleClass();
+```
+
+### `SampleClass(String argument)`
+
+`NamespaceAccessible`
+
+Constructs a SampleClass with an argument.
+#### Parameters
+
+| Param | Description |
+| ----- | ----------- |
+|`argument` |  Some argument. Of type String. |
+
+---
+## Properties
+
+### `AnotherProp` → `Decimal`
+
+`NamespaceAccessible`
+
+This is a Decimal property.
+
+### `MyProp` → `String`
+
+`NamespaceAccessible`
+
+This is a String property.
+
+---
+## Methods
+### `call()` → `void`
+
+`NamespaceAccessible`
+
+Calls the method. This methods allows you to call it.
+
+### `testMethod(String argument)` → `String`
+
+`NamespaceAccessible`
+
+Executes commands based on the passed in argument.
+
+#### Example
+```
+<pre>
+String result = SampleClass.testMethod();
+System.debug(result);
+```
+
+---
+## Inner Classes
+
+### SampleClass.AnotherInnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---
+### SampleClass.InnerClass class
+
+Inner class belonging to SampleClass.
+
+---
+#### Properties
+
+##### `InnerProp` → `public`
+
+Description of the inner property.
+
+---
+#### Methods
+##### `innerMethod()` → `void`
+
+Executes from the inner class.
+
+---

package/examples/apex/SampleClass.cls

@@ -1,6 +1,8 @@
 /**
  * @description This is a class description.
  * @group Sample Classes
+ * @see SampleInterface
+ * @see SampleClass2
  */
 @NamespaceAccessible
 public with sharing class SampleClass {
@@ -17,6 +19,7 @@ public with sharing class SampleClass {
 
     /**
      * @description Constructs a SampleClass with an argument.
+     * @param argument Some argument
      */
     public SampleClass(String argument) {
         System.debug('Constructor');
@@ -40,7 +43,8 @@ public with sharing class SampleClass {
      * @description Calls the method.
      * This methods allows you to call it.
      */
-    public static void call() { }
+    public static void call() {
+    }
 
     /**
      * @description This is a String property.
@@ -59,7 +63,9 @@ public with sharing class SampleClass {
         /**
          * @description Description of the inner property.
          */
-        public InnerProp { get; set; }
+        public InnerProp {
+            get; set;
+        }
 
         /**
          * @description Executes from the inner class.
@@ -71,12 +77,14 @@ public with sharing class SampleClass {
 
     /**
      * @description Inner class belonging to SampleClass.
-    */
+     */
     public class AnotherInnerClass {
         /**
          * @description Description of the inner property.
          */
-        public InnerProp { get; set; }
+        public InnerProp {
+            get; set;
+        }
 
         /**
          * @description Executes from the inner class.
@@ -85,4 +93,4 @@ public with sharing class SampleClass {
             System.debug('Executing inner method.');
         }
     }
-}
+}

package/examples/apex/SampleClass2.cls

@@ -0,0 +1,96 @@
+/**
+ * @description This is a class description.
+ * @group Sample Classes
+ * @see SampleInterface
+ * @see SampleClass
+ */
+@NamespaceAccessible
+public with sharing class SampleClass2 {
+    /**
+     * @description Constructs a SampleClass2 without any arguments.
+     * @example
+     * <pre>
+     * SampleClass2 sampleInstance = new SampleClass2();
+     */
+    @NamespaceAccessible
+    public SampleClass2() {
+        System.debug('Constructor');
+    }
+
+    /**
+     * @description Constructs a SampleClass2 with an argument.
+     * @param argument Some argument
+     */
+    public SampleClass2(String argument) {
+        System.debug('Constructor');
+    }
+
+    /**
+     * @description Executes commands based on the passed in argument.
+     * @example
+     * <pre>
+     * String result = SampleClass2.testMethod();
+     * System.debug(result);
+     */
+    @NamespaceAccessible
+    public static String testMethod(String argument) {
+        System.debug('Execute');
+        return '';
+    }
+
+
+    /**
+     * @description Calls the method.
+     * This methods allows you to call it.
+     */
+    public static void call() {
+    }
+
+    /**
+     * @description This is a String property.
+     */
+    public String MyProp { get; set; }
+
+    /**
+     * @description This is a Decimal property.
+     */
+    public Decimal AnotherProp { get; private set; }
+
+    /**
+     * @description Inner class belonging to SampleClass2.
+     */
+    public class InnerClass {
+        /**
+         * @description Description of the inner property.
+         */
+        public InnerProp {
+            get; set;
+        }
+
+        /**
+         * @description Executes from the inner class.
+         */
+        public void innerMethod() {
+            System.debug('Executing inner method.');
+        }
+    }
+
+    /**
+     * @description Inner class belonging to SampleClass2.
+     */
+    public class AnotherInnerClass {
+        /**
+         * @description Description of the inner property.
+         */
+        public InnerProp {
+            get; set;
+        }
+
+        /**
+         * @description Executes from the inner class.
+         */
+        public void innerMethod() {
+            System.debug('Executing inner method.');
+        }
+    }
+}

package/examples/apex/SampleInterface.cls

@@ -1,6 +1,7 @@
 /**
  * @description This is an interface description.
  * @group Sample Interfaces
+ * @see SampleClass
  */
 public interface SampleInterface {
     /**
@@ -10,6 +11,7 @@ public interface SampleInterface {
 
     /**
      * @description Returns a value based on the executed command.
+     * @return Empty value
      */
     String getValue();
-}
+}

package/lib/AsJsDocsProcessor.d.ts

@@ -1,6 +1,6 @@
 import DocsProcessor from './DocsProcessor';
 import JsHelper from './JsHelper';
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default class AsJsDocsProcessor extends DocsProcessor {
     process(classModel: ClassModel, outputDir: string): void;
     generateDocsForClass(generator: JsHelper, classModel: ClassModel): void;

package/lib/ClassFileGeneratorHelper.d.ts

@@ -1,5 +1,5 @@
-import ClassModel from './model/ClassModel';
+import ClassModel from './Model/ClassModel';
 export default class ClassFileGeneratorHelper {
     static getSanitizedGroup(classModel: ClassModel): string;
-    static getFileLink(classModel: ClassModel): string;
+    static getFileLink(classModel: ClassModel, forRelatedReference?: boolean): string;
 }

package/lib/ClassFileGeneratorHelper.js

@@ -9,9 +9,14 @@ class ClassFileGeneratorHelper {
             .replace(/ /g, '-')
             .replace('.', '');
     }
-    static getFileLink(classModel) {
-        var _a, _b;
-        const root = ((_a = Configuration_1.default.getConfig()) === null || _a === void 0 ? void 0 : _a.root) ? (_b = Configuration_1.default.getConfig()) === null || _b === void 0 ? void 0 : _b.root : '';
+    static getFileLink(classModel, forRelatedReference = false) {
+        var _a, _b, _c, _d;
+        let defaultRoot = '';
+        if (forRelatedReference && Settings_1.default.getInstance().getShouldGroup()) {
+            defaultRoot = (_b = (_a = Settings_1.default.getInstance()
+                .getDocsProcessor()) === null || _a === void 0 ? void 0 : _a.defaultRoot()) !== null && _b !== void 0 ? _b : '';
+        }
+        const root = ((_c = Configuration_1.default.getConfig()) === null || _c === void 0 ? void 0 : _c.root) ? (_d = Configuration_1.default.getConfig()) === null || _d === void 0 ? void 0 : _d.root : defaultRoot;
         let fileLink;
         if (Settings_1.default.getInstance().getShouldGroup()) {
             fileLink = `[${classModel.getClassName()}](${root}/${this.getSanitizedGroup(classModel)}/${classModel.getClassName()}.md)`;

package/lib/ClassFileGeneratorHelper.test.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ClassFileGeneratorHelper_1 = require("./ClassFileGeneratorHelper");
-const ClassModel_1 = require("./model/ClassModel");
+const ClassModel_1 = require("./Model/ClassModel");
 const Settings_1 = require("./Settings");
 test('that getSanitizedGroup returns the same string when there is nothing to sanitize', () => {
     const testClass = new ClassModel_1.default();

package/lib/{command → Command}/Generate.d.ts

@@ -1,2 +1,2 @@
-import ClassModel from '../model/ClassModel';
+import ClassModel from '../Model/ClassModel';
 export declare function generate(sourceDirectory: string, recursive?: boolean, scope?: string[], outputDir?: string, targetGenerator?: string, configPath?: string, group?: boolean): ClassModel[];

package/lib/{command → Command}/Generate.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const path = require("path");
 const Settings_1 = require("../Settings");
-const FileParser_1 = require("../parser/FileParser");
+const FileParser_1 = require("../Parser/FileParser");
 const DocsifyDocsProcessor_1 = require("../DocsifyDocsProcessor");
 const JekyllDocsProcessor_1 = require("../JekyllDocsProcessor");
 const AsJsDocsProcessor_1 = require("../AsJsDocsProcessor");