@cparra/apexdocs 2.23.0 → 2.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. package/.eslintrc.js +12 -12
  2. package/.github/workflows/close_stale.yml +22 -22
  3. package/.prettierrc.js +7 -7
  4. package/LICENSE +21 -21
  5. package/README.md +718 -718
  6. package/apexdocs.config.ts +13 -13
  7. package/docs/README.md +1 -1
  8. package/docs/restapi.json +589 -589
  9. package/docs/types/Classes/nspc.ChildClass.md +97 -97
  10. package/docs/types/Main/nspc.SampleClass.md +189 -189
  11. package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
  12. package/examples/force-app/main/default/classes/ChildClass.cls +42 -42
  13. package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -5
  14. package/examples/force-app/main/default/classes/GrandparentClass.cls +4 -4
  15. package/examples/force-app/main/default/classes/GroupedClass.cls +8 -8
  16. package/examples/force-app/main/default/classes/MemberGrouping.cls +17 -17
  17. package/examples/force-app/main/default/classes/ParentClass.cls +16 -16
  18. package/examples/force-app/main/default/classes/SampleClass.cls +166 -166
  19. package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml +5 -5
  20. package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
  21. package/examples/force-app/main/default/classes/SampleInterface.cls +16 -16
  22. package/examples/force-app/main/default/restapi/SampleRestResource.cls +195 -195
  23. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  24. package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +24 -24
  25. package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +15 -15
  26. package/examples/force-app/main/default/restapi/references/Reference1.cls +9 -9
  27. package/examples/force-app/main/default/restapi/references/Reference2.cls +9 -9
  28. package/examples/force-app/main/default/restapi/references/Reference3.cls +3 -3
  29. package/examples/force-app/main/default/restapi/references/Reference4.cls +3 -3
  30. package/examples/force-app/main/default/restapi/references/Reference5.cls +3 -3
  31. package/examples/force-app/main/default/restapi/references/Reference6.cls +6 -6
  32. package/examples/force-app/main/default/restapi/references/Reference7.cls +3 -3
  33. package/examples/includes/header.md +3 -3
  34. package/jest.config.js +5 -5
  35. package/lib/application/Apexdocs.d.ts +13 -13
  36. package/lib/application/Apexdocs.js +76 -76
  37. package/lib/cli/generate.d.ts +2 -2
  38. package/lib/cli/generate.js +130 -130
  39. package/lib/index.d.ts +1 -1
  40. package/lib/index.js +17 -17
  41. package/lib/model/apex-bundle.d.ts +6 -6
  42. package/lib/model/apex-bundle.js +10 -10
  43. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -7
  44. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +13 -13
  45. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -7
  46. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +11 -11
  47. package/lib/model/inheritance.d.ts +8 -8
  48. package/lib/model/inheritance.js +2 -2
  49. package/lib/model/manifest-diff.d.ts +27 -27
  50. package/lib/model/manifest-diff.js +68 -68
  51. package/lib/model/manifest.d.ts +22 -22
  52. package/lib/model/manifest.js +46 -46
  53. package/lib/model/markdown-file.d.ts +16 -16
  54. package/lib/model/markdown-file.js +106 -106
  55. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -8
  56. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +43 -43
  57. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
  58. package/lib/model/markdown-generation-util/field-declaration-util.js +54 -54
  59. package/lib/model/markdown-generation-util/index.d.ts +3 -3
  60. package/lib/model/markdown-generation-util/index.js +19 -19
  61. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -4
  62. package/lib/model/markdown-generation-util/method-declaration-util.js +114 -114
  63. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -3
  64. package/lib/model/markdown-generation-util/type-declaration-util.js +81 -81
  65. package/lib/model/markdown-home-file.d.ts +11 -11
  66. package/lib/model/markdown-home-file.js +53 -53
  67. package/lib/model/markdown-type-file.d.ts +26 -26
  68. package/lib/model/markdown-type-file.js +133 -133
  69. package/lib/model/openapi/apex-doc-types.d.ts +19 -19
  70. package/lib/model/openapi/apex-doc-types.js +4 -4
  71. package/lib/model/openapi/open-api-types.d.ts +93 -93
  72. package/lib/model/openapi/open-api-types.js +2 -2
  73. package/lib/model/openapi/open-api.d.ts +16 -16
  74. package/lib/model/openapi/open-api.js +33 -33
  75. package/lib/model/openapi/openapi-type-file.d.ts +7 -7
  76. package/lib/model/openapi/openapi-type-file.js +16 -16
  77. package/lib/model/outputFile.d.ts +10 -10
  78. package/lib/model/outputFile.js +28 -28
  79. package/lib/model/types-repository.d.ts +16 -16
  80. package/lib/model/types-repository.js +53 -53
  81. package/lib/service/apex-file-reader.d.ts +14 -14
  82. package/lib/service/apex-file-reader.js +45 -45
  83. package/lib/service/file-system.d.ts +14 -14
  84. package/lib/service/file-system.js +24 -24
  85. package/lib/service/file-writer.d.ts +6 -6
  86. package/lib/service/file-writer.js +33 -33
  87. package/lib/service/manifest-factory.d.ts +10 -10
  88. package/lib/service/manifest-factory.js +13 -13
  89. package/lib/service/metadata-processor.d.ts +3 -3
  90. package/lib/service/metadata-processor.js +16 -16
  91. package/lib/service/parser.d.ts +21 -21
  92. package/lib/service/parser.js +134 -134
  93. package/lib/service/state.d.ts +9 -9
  94. package/lib/service/state.js +19 -19
  95. package/lib/service/walkers/class-walker.d.ts +4 -4
  96. package/lib/service/walkers/class-walker.js +32 -32
  97. package/lib/service/walkers/enum-walker.d.ts +4 -4
  98. package/lib/service/walkers/enum-walker.js +10 -10
  99. package/lib/service/walkers/interface-walker.d.ts +4 -4
  100. package/lib/service/walkers/interface-walker.js +14 -14
  101. package/lib/service/walkers/walker-factory.d.ts +5 -5
  102. package/lib/service/walkers/walker-factory.js +20 -20
  103. package/lib/service/walkers/walker.d.ts +19 -19
  104. package/lib/service/walkers/walker.js +16 -16
  105. package/lib/settings.d.ts +64 -64
  106. package/lib/settings.js +88 -88
  107. package/lib/test-helpers/AnnotationBuilder.d.ts +12 -12
  108. package/lib/test-helpers/AnnotationBuilder.js +30 -30
  109. package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -18
  110. package/lib/test-helpers/ClassMirrorBuilder.js +53 -53
  111. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -8
  112. package/lib/test-helpers/DocCommentAnnotationBuilder.js +25 -25
  113. package/lib/test-helpers/DocCommentBuilder.d.ts +12 -12
  114. package/lib/test-helpers/DocCommentBuilder.js +37 -37
  115. package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -18
  116. package/lib/test-helpers/FieldMirrorBuilder.js +53 -53
  117. package/lib/test-helpers/MethodMirrorBuilder.d.ts +10 -10
  118. package/lib/test-helpers/MethodMirrorBuilder.js +36 -36
  119. package/lib/test-helpers/SettingsBuilder.d.ts +8 -8
  120. package/lib/test-helpers/SettingsBuilder.js +26 -26
  121. package/lib/transpiler/factory.d.ts +6 -6
  122. package/lib/transpiler/factory.js +31 -31
  123. package/lib/transpiler/file-container.d.ts +6 -6
  124. package/lib/transpiler/file-container.js +15 -15
  125. package/lib/transpiler/generator-choices.d.ts +1 -1
  126. package/lib/transpiler/generator-choices.js +2 -2
  127. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +8 -8
  128. package/lib/transpiler/markdown/class-file-generatorHelper.js +55 -55
  129. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -6
  130. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +12 -12
  131. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -11
  132. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -50
  133. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
  134. package/lib/transpiler/markdown/markdown-transpiler-base.js +23 -23
  135. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +6 -6
  136. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +13 -13
  137. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
  138. package/lib/transpiler/openapi/open-api-docs-processor.js +74 -74
  139. package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
  140. package/lib/transpiler/openapi/parsers/Builder.js +29 -29
  141. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
  142. package/lib/transpiler/openapi/parsers/MethodParser.js +166 -166
  143. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -7
  144. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +10 -10
  145. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -39
  146. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +225 -225
  147. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -10
  148. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +19 -19
  149. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -7
  150. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +21 -21
  151. package/lib/transpiler/processor-type-transpiler.d.ts +10 -10
  152. package/lib/transpiler/processor-type-transpiler.js +8 -8
  153. package/lib/transpiler/transpiler.d.ts +5 -5
  154. package/lib/transpiler/transpiler.js +26 -26
  155. package/lib/util/error-logger.d.ts +8 -8
  156. package/lib/util/error-logger.js +89 -89
  157. package/lib/util/logger.d.ts +21 -21
  158. package/lib/util/logger.js +57 -57
  159. package/lib/util/string-utils.d.ts +2 -2
  160. package/lib/util/string-utils.js +14 -14
  161. package/package.json +78 -78
  162. package/tsconfig.json +20 -20
  163. package/tslint.json +5 -5
@@ -1,97 +1,97 @@
1
- # nspc.ChildClass
2
-
3
- Some desc
4
-
5
-
6
- **Inheritance**
7
-
8
- [nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
9
- >
10
- [nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
11
- >
12
- ChildClass
13
-
14
-
15
- **Implemented types**
16
-
17
- [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
18
-
19
-
20
- **Group** Classes
21
-
22
- ## Fields
23
-
24
- ### `private aPrivateString` → `String`
25
-
26
-
27
- ### `private privateStringFromChild` → `String`
28
-
29
-
30
- ### `protected protectedGrandParentField` → `String`
31
-
32
- *Inherited*
33
-
34
- ### `protected protectedStringFromParent` → `String`
35
-
36
- *Inherited*
37
-
38
- This is a protected string, use carefully.
39
-
40
- ### `public publicStringFromParent` → `String`
41
-
42
- *Inherited*
43
-
44
- ---
45
- ## Properties
46
-
47
- ### `protected AProp` → `String`
48
-
49
- *Inherited*
50
-
51
- ---
52
- ## Methods
53
- ### `public void doSomething()`
54
- ### `public void execute()`
55
-
56
- Executes the command.
57
-
58
- ### `public String getValue()`
59
-
60
- Returns a value based on the executed command.
61
-
62
- #### Returns
63
-
64
- |Type|Description|
65
- |---|---|
66
- |`String`|The value|
67
-
68
- ### `public virtual String overridableMethod()`
69
-
70
- *Inherited*
71
-
72
- ### `public override String overridableMethodOverridden()`
73
-
74
- This method was overridden.
75
-
76
- #### Returns
77
-
78
- |Type|Description|
79
- |---|---|
80
- |`String`|A String.|
81
-
82
-
83
- ```mermaid
84
- sequenceDiagram
85
- participant dotcom
86
- participant iframe
87
- participant viewscreen
88
- dotcom->>iframe: loads html w/ iframe url
89
- iframe->>viewscreen: request template
90
- viewscreen->>iframe: html & javascript
91
- iframe->>dotcom: iframe ready
92
- dotcom->>iframe: set mermaid data on iframe
93
- iframe->>iframe: render mermaid
94
- ```
95
-
96
-
97
- ---
1
+ # nspc.ChildClass
2
+
3
+ Some desc
4
+
5
+
6
+ **Inheritance**
7
+
8
+ [nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
9
+ >
10
+ [nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
11
+ >
12
+ ChildClass
13
+
14
+
15
+ **Implemented types**
16
+
17
+ [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
18
+
19
+
20
+ **Group** Classes
21
+
22
+ ## Fields
23
+
24
+ ### `private aPrivateString` → `String`
25
+
26
+
27
+ ### `private privateStringFromChild` → `String`
28
+
29
+
30
+ ### `protected protectedGrandParentField` → `String`
31
+
32
+ *Inherited*
33
+
34
+ ### `protected protectedStringFromParent` → `String`
35
+
36
+ *Inherited*
37
+
38
+ This is a protected string, use carefully.
39
+
40
+ ### `public publicStringFromParent` → `String`
41
+
42
+ *Inherited*
43
+
44
+ ---
45
+ ## Properties
46
+
47
+ ### `protected AProp` → `String`
48
+
49
+ *Inherited*
50
+
51
+ ---
52
+ ## Methods
53
+ ### `public void doSomething()`
54
+ ### `public void execute()`
55
+
56
+ Executes the command.
57
+
58
+ ### `public String getValue()`
59
+
60
+ Returns a value based on the executed command.
61
+
62
+ #### Returns
63
+
64
+ |Type|Description|
65
+ |---|---|
66
+ |`String`|The value|
67
+
68
+ ### `public virtual String overridableMethod()`
69
+
70
+ *Inherited*
71
+
72
+ ### `public override String overridableMethodOverridden()`
73
+
74
+ This method was overridden.
75
+
76
+ #### Returns
77
+
78
+ |Type|Description|
79
+ |---|---|
80
+ |`String`|A String.|
81
+
82
+
83
+ ```mermaid
84
+ sequenceDiagram
85
+ participant dotcom
86
+ participant iframe
87
+ participant viewscreen
88
+ dotcom->>iframe: loads html w/ iframe url
89
+ iframe->>viewscreen: request template
90
+ viewscreen->>iframe: html & javascript
91
+ iframe->>dotcom: iframe ready
92
+ dotcom->>iframe: set mermaid data on iframe
93
+ iframe->>iframe: render mermaid
94
+ ```
95
+
96
+
97
+ ---
@@ -1,189 +1,189 @@
1
- # virtual nspc.SampleClass
2
-
3
- `NAMESPACEACCESSIBLE`
4
-
5
- This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
6
- But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
7
- You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
8
-
9
-
10
- **Group** Main
11
-
12
-
13
- **CustomAnnotation** A Custom annotation
14
-
15
-
16
- **Author** Cesar Parra
17
-
18
-
19
- **See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
20
-
21
- ## Constructors
22
- ### My Super Group
23
- ##### `public SampleClass()`
24
-
25
- `NAMESPACEACCESSIBLE`
26
-
27
- Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
28
-
29
- ###### Throws
30
-
31
- |Exception|Description|
32
- |---|---|
33
- |`ExcName`|some exception|
34
-
35
-
36
- **CustomAnnotation** A Custom method annotation
37
-
38
-
39
- **See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
40
-
41
- ###### Example
42
- ```apex
43
- // Example
44
- SampleClass sampleInstance = new SampleClass();
45
- ```
46
-
47
-
48
- ---
49
- ### Other
50
- ##### `public SampleClass(String argument1, String argument2)`
51
-
52
- Constructs a SampleClass with an argument.
53
-
54
- ###### Parameters
55
-
56
- |Param|Description|
57
- |---|---|
58
- |`argument1`|Argument1 definition|
59
- |`argument2`|Argument2 definition|
60
-
61
- ---
62
- ## Fields
63
- ### Common Constants
64
-
65
- * `public A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
66
- * `public ANOTHER_CONSTANT` → `String`
67
- * `public listOfStrings` → `List<String>`
68
- ---
69
- ### 'General' Constants
70
-
71
- * `public GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
72
- * `public GENERAL_ANOTHER_CONSTANT` → `String`
73
- ---
74
- ### Other
75
-
76
- * `private somePrivateStuff` → `String`
77
- ---
78
- ### Other variables
79
-
80
- * `public someVariable` → `String`
81
- ---
82
- ## Properties
83
-
84
- ### `public AnotherProp` → `Decimal`
85
-
86
- `AURAENABLED`
87
-
88
- This is a Decimal property.
89
-
90
- ### `public MyProp` → `String`
91
-
92
- `AURAENABLED`
93
- `DEPRECATED`
94
-
95
- This is a String property.
96
-
97
- ---
98
- ## Methods
99
- ### A method group
100
- ##### `public static String anotherSampleMethod(String arg1)`
101
-
102
- Something here
103
-
104
-
105
- **Arg1** The arg1 description
106
-
107
- ##### `public static String sampleMethod(String argument1, String argument2)`
108
-
109
- `NAMESPACEACCESSIBLE`
110
-
111
- Executes commands based on the passed in argument.
112
-
113
- ###### Parameters
114
-
115
- |Param|Description|
116
- |---|---|
117
- |`argument1`|Argument1 to debug|
118
- |`argument2`|Argument2 to debug|
119
-
120
- ###### Returns
121
-
122
- |Type|Description|
123
- |---|---|
124
- |`String`|Empty string|
125
-
126
- ###### Example
127
- ```apex
128
- String result = SampleClass.testMethod();
129
- System.debug(result);
130
- ```
131
-
132
-
133
- ##### `public static Map<Id,List<String>> yetAnotherSampleMethod(String arg1)`
134
- ---
135
- ### Other
136
- ##### `public static void call()`
137
-
138
- Calls the method. This methods allows you to call it.
139
-
140
- ---
141
- ## Enums
142
- ### InnerEnum
143
-
144
- `NAMESPACEACCESSIBLE`
145
-
146
- This is a namespace accessible enum
147
-
148
-
149
- ---
150
- ## Classes
151
- ### AnotherInnerClass
152
-
153
- Inner class belonging to SampleClass.
154
-
155
- #### Properties
156
-
157
- ##### `public InnerProp` → `String`
158
-
159
-
160
- Description of the inner property.
161
-
162
- ---
163
- #### Methods
164
- ##### `public void innerMethod()`
165
-
166
- Executes from the inner class.
167
-
168
- ---
169
-
170
- ### InnerClass
171
-
172
- Inner class belonging to SampleClass.
173
-
174
- #### Properties
175
-
176
- ##### `public InnerProp` → `String`
177
-
178
-
179
- Description of the inner property.
180
-
181
- ---
182
- #### Methods
183
- ##### `public void innerMethod()`
184
-
185
- Executes from the inner class.
186
-
187
- ---
188
-
189
- ---
1
+ # virtual nspc.SampleClass
2
+
3
+ `NAMESPACEACCESSIBLE`
4
+
5
+ This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
6
+ But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
7
+ You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
8
+
9
+
10
+ **Group** Main
11
+
12
+
13
+ **CustomAnnotation** A Custom annotation
14
+
15
+
16
+ **Author** Cesar Parra
17
+
18
+
19
+ **See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
20
+
21
+ ## Constructors
22
+ ### My Super Group
23
+ ##### `public SampleClass()`
24
+
25
+ `NAMESPACEACCESSIBLE`
26
+
27
+ Constructs a SampleClass without any arguments. This relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
28
+
29
+ ###### Throws
30
+
31
+ |Exception|Description|
32
+ |---|---|
33
+ |`ExcName`|some exception|
34
+
35
+
36
+ **CustomAnnotation** A Custom method annotation
37
+
38
+
39
+ **See** [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
40
+
41
+ ###### Example
42
+ ```apex
43
+ // Example
44
+ SampleClass sampleInstance = new SampleClass();
45
+ ```
46
+
47
+
48
+ ---
49
+ ### Other
50
+ ##### `public SampleClass(String argument1, String argument2)`
51
+
52
+ Constructs a SampleClass with an argument.
53
+
54
+ ###### Parameters
55
+
56
+ |Param|Description|
57
+ |---|---|
58
+ |`argument1`|Argument1 definition|
59
+ |`argument2`|Argument2 definition|
60
+
61
+ ---
62
+ ## Fields
63
+ ### Common Constants
64
+
65
+ * `public A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
66
+ * `public ANOTHER_CONSTANT` → `String`
67
+ * `public listOfStrings` → `List<String>`
68
+ ---
69
+ ### 'General' Constants
70
+
71
+ * `public GENERAL_A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
72
+ * `public GENERAL_ANOTHER_CONSTANT` → `String`
73
+ ---
74
+ ### Other
75
+
76
+ * `private somePrivateStuff` → `String`
77
+ ---
78
+ ### Other variables
79
+
80
+ * `public someVariable` → `String`
81
+ ---
82
+ ## Properties
83
+
84
+ ### `public AnotherProp` → `Decimal`
85
+
86
+ `AURAENABLED`
87
+
88
+ This is a Decimal property.
89
+
90
+ ### `public MyProp` → `String`
91
+
92
+ `AURAENABLED`
93
+ `DEPRECATED`
94
+
95
+ This is a String property.
96
+
97
+ ---
98
+ ## Methods
99
+ ### A method group
100
+ ##### `public static String anotherSampleMethod(String arg1)`
101
+
102
+ Something here
103
+
104
+
105
+ **Arg1** The arg1 description
106
+
107
+ ##### `public static String sampleMethod(String argument1, String argument2)`
108
+
109
+ `NAMESPACEACCESSIBLE`
110
+
111
+ Executes commands based on the passed in argument.
112
+
113
+ ###### Parameters
114
+
115
+ |Param|Description|
116
+ |---|---|
117
+ |`argument1`|Argument1 to debug|
118
+ |`argument2`|Argument2 to debug|
119
+
120
+ ###### Returns
121
+
122
+ |Type|Description|
123
+ |---|---|
124
+ |`String`|Empty string|
125
+
126
+ ###### Example
127
+ ```apex
128
+ String result = SampleClass.testMethod();
129
+ System.debug(result);
130
+ ```
131
+
132
+
133
+ ##### `public static Map<Id,List<String>> yetAnotherSampleMethod(String arg1)`
134
+ ---
135
+ ### Other
136
+ ##### `public static void call()`
137
+
138
+ Calls the method. This methods allows you to call it.
139
+
140
+ ---
141
+ ## Enums
142
+ ### InnerEnum
143
+
144
+ `NAMESPACEACCESSIBLE`
145
+
146
+ This is a namespace accessible enum
147
+
148
+
149
+ ---
150
+ ## Classes
151
+ ### AnotherInnerClass
152
+
153
+ Inner class belonging to SampleClass.
154
+
155
+ #### Properties
156
+
157
+ ##### `public InnerProp` → `String`
158
+
159
+
160
+ Description of the inner property.
161
+
162
+ ---
163
+ #### Methods
164
+ ##### `public void innerMethod()`
165
+
166
+ Executes from the inner class.
167
+
168
+ ---
169
+
170
+ ### InnerClass
171
+
172
+ Inner class belonging to SampleClass.
173
+
174
+ #### Properties
175
+
176
+ ##### `public InnerProp` → `String`
177
+
178
+
179
+ Description of the inner property.
180
+
181
+ ---
182
+ #### Methods
183
+ ##### `public void innerMethod()`
184
+
185
+ Executes from the inner class.
186
+
187
+ ---
188
+
189
+ ---
@@ -1,16 +1,16 @@
1
- /**
2
- * @description Some desc
3
- * @group Classes
4
- * @mermaid
5
- * sequenceDiagram
6
- * participant dotcom
7
- * participant iframe
8
- * participant viewscreen
9
- * dotcom->>iframe: loads html w/ iframe url
10
- * iframe->>viewscreen: request template
11
- * viewscreen->>iframe: html & javascript
12
- * iframe->>dotcom: iframe ready
13
- * dotcom->>iframe: set mermaid data on iframe
14
- * iframe->>iframe: render mermaid
15
- */
16
- public interface AnotherInterface{}
1
+ /**
2
+ * @description Some desc
3
+ * @group Classes
4
+ * @mermaid
5
+ * sequenceDiagram
6
+ * participant dotcom
7
+ * participant iframe
8
+ * participant viewscreen
9
+ * dotcom->>iframe: loads html w/ iframe url
10
+ * iframe->>viewscreen: request template
11
+ * viewscreen->>iframe: html & javascript
12
+ * iframe->>dotcom: iframe ready
13
+ * dotcom->>iframe: set mermaid data on iframe
14
+ * iframe->>iframe: render mermaid
15
+ */
16
+ public interface AnotherInterface{}
@@ -1,42 +1,42 @@
1
- /**
2
- * @description Some desc
3
- * @group Classes
4
- */
5
- public class ChildClass extends ParentClass implements SampleInterface {
6
- private String privateStringFromChild;
7
- private String aPrivateString;
8
-
9
- public void doSomething() {
10
- System.debug('Do something');
11
- }
12
-
13
- /**
14
- * @description This method was overridden.
15
- * @return A String.
16
- * @mermaid
17
- * sequenceDiagram
18
- * participant dotcom
19
- * participant iframe
20
- * participant viewscreen
21
- * dotcom->>iframe: loads html w/ iframe url
22
- * iframe->>viewscreen: request template
23
- * viewscreen->>iframe: html & javascript
24
- * iframe->>dotcom: iframe ready
25
- * dotcom->>iframe: set mermaid data on iframe
26
- * iframe->>iframe: render mermaid
27
- */
28
- public override String overridableMethodOverridden() {
29
- return null ?? '';
30
- }
31
-
32
- /**
33
- * @description Executes the command.
34
- */
35
- public void execute();
36
-
37
- /**
38
- * @description Returns a value based on the executed command.
39
- * @return The value
40
- */
41
- public String getValue();
42
- }
1
+ /**
2
+ * @description Some desc
3
+ * @group Classes
4
+ */
5
+ public class ChildClass extends ParentClass implements SampleInterface {
6
+ private String privateStringFromChild;
7
+ private String aPrivateString;
8
+
9
+ public void doSomething() {
10
+ System.debug('Do something');
11
+ }
12
+
13
+ /**
14
+ * @description This method was overridden.
15
+ * @return A String.
16
+ * @mermaid
17
+ * sequenceDiagram
18
+ * participant dotcom
19
+ * participant iframe
20
+ * participant viewscreen
21
+ * dotcom->>iframe: loads html w/ iframe url
22
+ * iframe->>viewscreen: request template
23
+ * viewscreen->>iframe: html & javascript
24
+ * iframe->>dotcom: iframe ready
25
+ * dotcom->>iframe: set mermaid data on iframe
26
+ * iframe->>iframe: render mermaid
27
+ */
28
+ public override String overridableMethodOverridden() {
29
+ return null ?? '';
30
+ }
31
+
32
+ /**
33
+ * @description Executes the command.
34
+ */
35
+ public void execute();
36
+
37
+ /**
38
+ * @description Returns a value based on the executed command.
39
+ * @return The value
40
+ */
41
+ public String getValue();
42
+ }