@cparra/apexdocs 2.0.0 → 2.0.1
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.
- package/ROADMAP.md +0 -2
- package/docs/Misc/SampleClassWithoutModifier.md +11 -0
- package/docs/README.md +8 -0
- package/docs/Sample-Classes/SampleClass.md +9 -0
- package/examples/force-app/main/default/classes/SampleClass.cls +6 -0
- package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -0
- package/package.json +3 -3
package/ROADMAP.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
[] Automatic Resolution of links (@see and {@link FileName})
|
|
2
|
-
|
|
3
1
|
[] Respect access modifiers where the properties/methods are different from the class declaration. For example,
|
|
4
2
|
AuraEnabled properties do not live in an AuraEnabled class, so there's no way to just generate docs to showcase the
|
|
5
3
|
AuraEnabled properties of a class without some sort of combination of also exposing other public/globals
|
package/docs/README.md
CHANGED
|
@@ -7,6 +7,14 @@
|
|
|
7
7
|
This is a class description. This class relates to {@link SampleInterface} But this {@link ClassThatDoesNotExist} does not exist. You can also link using this syntax <<SampleInterface>>
|
|
8
8
|
|
|
9
9
|
|
|
10
|
+
##
|
|
11
|
+
|
|
12
|
+
## [SampleClassWithoutModifier](/Misc/SampleClassWithoutModifier.md)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
10
18
|
## Sample Interfaces
|
|
11
19
|
|
|
12
20
|
## [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
@@ -47,6 +47,15 @@ Constructs a SampleClass with an argument.
|
|
|
47
47
|
|Param|Description|
|
|
48
48
|
|---|---|
|
|
49
49
|
|`argument`|Argument definition|
|
|
50
|
+
---
|
|
51
|
+
## Fields
|
|
52
|
+
|
|
53
|
+
### `A_CONSTANT` → `String`
|
|
54
|
+
|
|
55
|
+
This is a constant.
|
|
56
|
+
|
|
57
|
+
### `someVariable` → `String`
|
|
58
|
+
|
|
50
59
|
---
|
|
51
60
|
## Properties
|
|
52
61
|
|
|
@@ -19,6 +19,12 @@ public with sharing class SampleClass {
|
|
|
19
19
|
C
|
|
20
20
|
}
|
|
21
21
|
|
|
22
|
+
/**
|
|
23
|
+
* @description This is a constant.
|
|
24
|
+
*/
|
|
25
|
+
public static final String A_CONSTANT = 'My Constant Value';
|
|
26
|
+
public String someVariable = 'test';
|
|
27
|
+
|
|
22
28
|
/**
|
|
23
29
|
* @description Constructs a SampleClass without any arguments. This relates to {@link SampleInterface}
|
|
24
30
|
* @throws ExcName some exception
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cparra/apexdocs",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"apex",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"postversion": "git push && git push --tags",
|
|
25
25
|
"docs:init": "docsify init docs",
|
|
26
26
|
"docs:serve": "docsify serve docs",
|
|
27
|
-
"execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public -g docsify"
|
|
27
|
+
"execute:example": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify"
|
|
28
28
|
},
|
|
29
29
|
"author": "Cesar Parra",
|
|
30
30
|
"license": "MIT",
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
]
|
|
64
64
|
},
|
|
65
65
|
"dependencies": {
|
|
66
|
-
"@cparra/apex-reflection": "^
|
|
66
|
+
"@cparra/apex-reflection": "^1.0.0",
|
|
67
67
|
"chalk": "^4.1.2",
|
|
68
68
|
"html-entities": "^2.3.2",
|
|
69
69
|
"yargs": "^16.0.3"
|