@cparra/apexdocs 2.16.0 → 2.17.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.
- package/docs/types/Classes/nspc.ChildClass.md +5 -5
- package/docs/types/Main/nspc.SampleClass.md +5 -5
- package/docs/types/Misc-Group/nspc.InterfaceWithInheritance.md +2 -2
- package/docs/types/Misc-Group/nspc.ParentClass.md +2 -2
- package/docs/types/Misc-Group/nspc.SampleClassWithoutModifier.md +1 -1
- package/docs/types/Misc-Group/nspc.SampleRestResource.md +3 -3
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +1 -1
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +2 -2
- package/docs/types/Sample-Interfaces/nspc.SampleInterface.md +2 -2
- package/lib/model/markdown-generation-util/method-declaration-util.js +1 -1
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
- package/package.json +2 -2
- package/src/model/markdown-generation-util/method-declaration-util.ts +3 -1
- package/docs/types/Misc-Group/nspc.AtFutureRecipes.md +0 -4
|
@@ -47,8 +47,8 @@ This is a protected string, use carefully.
|
|
|
47
47
|
|
|
48
48
|
---
|
|
49
49
|
## Methods
|
|
50
|
-
### `public doSomething()`
|
|
51
|
-
### `public override overridableMethodOverridden()`
|
|
50
|
+
### `public void doSomething()`
|
|
51
|
+
### `public override String overridableMethodOverridden()`
|
|
52
52
|
|
|
53
53
|
This method was overridden.
|
|
54
54
|
|
|
@@ -58,11 +58,11 @@ This method was overridden.
|
|
|
58
58
|
|---|---|
|
|
59
59
|
|String|A String.|
|
|
60
60
|
|
|
61
|
-
### `public execute()`
|
|
61
|
+
### `public void execute()`
|
|
62
62
|
|
|
63
63
|
Executes the command.
|
|
64
64
|
|
|
65
|
-
### `public getValue()`
|
|
65
|
+
### `public String getValue()`
|
|
66
66
|
|
|
67
67
|
Returns a value based on the executed command.
|
|
68
68
|
|
|
@@ -72,7 +72,7 @@ Returns a value based on the executed command.
|
|
|
72
72
|
|---|---|
|
|
73
73
|
|String|The value|
|
|
74
74
|
|
|
75
|
-
### `public overridableMethod()`
|
|
75
|
+
### `public String overridableMethod()`
|
|
76
76
|
|
|
77
77
|
*Inherited*
|
|
78
78
|
|
|
@@ -97,7 +97,7 @@ This is a String property.
|
|
|
97
97
|
---
|
|
98
98
|
## Methods
|
|
99
99
|
### A method group
|
|
100
|
-
##### `public static sampleMethod(String argument1, String argument2)`
|
|
100
|
+
##### `public static String sampleMethod(String argument1, String argument2)`
|
|
101
101
|
|
|
102
102
|
`NAMESPACEACCESSIBLE`
|
|
103
103
|
|
|
@@ -123,7 +123,7 @@ System.debug(result);
|
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
|
|
126
|
-
##### `public static anotherSampleMethod(String arg1)`
|
|
126
|
+
##### `public static String anotherSampleMethod(String arg1)`
|
|
127
127
|
|
|
128
128
|
Something here
|
|
129
129
|
|
|
@@ -132,7 +132,7 @@ Something here
|
|
|
132
132
|
|
|
133
133
|
---
|
|
134
134
|
### Other
|
|
135
|
-
##### `public static call()`
|
|
135
|
+
##### `public static void call()`
|
|
136
136
|
|
|
137
137
|
Calls the method. This methods allows you to call it.
|
|
138
138
|
|
|
@@ -160,7 +160,7 @@ Description of the inner property.
|
|
|
160
160
|
|
|
161
161
|
---
|
|
162
162
|
#### Methods
|
|
163
|
-
##### `public innerMethod()`
|
|
163
|
+
##### `public void innerMethod()`
|
|
164
164
|
|
|
165
165
|
Executes from the inner class.
|
|
166
166
|
|
|
@@ -179,7 +179,7 @@ Description of the inner property.
|
|
|
179
179
|
|
|
180
180
|
---
|
|
181
181
|
#### Methods
|
|
182
|
-
##### `public innerMethod()`
|
|
182
|
+
##### `public void innerMethod()`
|
|
183
183
|
|
|
184
184
|
Executes from the inner class.
|
|
185
185
|
|
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
,
|
|
7
7
|
[nspc.AnotherInterface](types/Classes/nspc.AnotherInterface.md)
|
|
8
8
|
## Methods
|
|
9
|
-
### `global execute()`
|
|
9
|
+
### `global void execute()`
|
|
10
10
|
|
|
11
11
|
*Inherited*
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
Executes the command.
|
|
15
15
|
|
|
16
|
-
### `global getValue()`
|
|
16
|
+
### `global String getValue()`
|
|
17
17
|
|
|
18
18
|
*Inherited*
|
|
19
19
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Account related operations
|
|
6
6
|
|
|
7
7
|
## Methods
|
|
8
|
-
### `global static doDelete()`
|
|
8
|
+
### `global static void doDelete()`
|
|
9
9
|
|
|
10
10
|
`HTTPDELETE`
|
|
11
11
|
|
|
@@ -32,7 +32,7 @@ Sample HTTP Delete method with references to other types.
|
|
|
32
32
|
|
|
33
33
|
**Http Response** statusCode: 307 schema: Reference7[untypedObject:Reference2]
|
|
34
34
|
|
|
35
|
-
### `global static doGet()`
|
|
35
|
+
### `global static Account doGet()`
|
|
36
36
|
|
|
37
37
|
`HTTPGET`
|
|
38
38
|
|
|
@@ -65,7 +65,7 @@ This is a sample HTTP Get method
|
|
|
65
65
|
|
|
66
66
|
**Http Response** statusCode: 100 schema: type: object properties: anotherObject: description: An object inside of an object type: object properties: message: type: string somethingElse: type: number
|
|
67
67
|
|
|
68
|
-
### `global static doPost(String name, String phone, String website)`
|
|
68
|
+
### `global static String doPost(String name, String phone, String website)`
|
|
69
69
|
|
|
70
70
|
`HTTPPOST`
|
|
71
71
|
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
Order related operations
|
|
6
6
|
|
|
7
7
|
## Methods
|
|
8
|
-
### `global static doGet(String param1, Reference1 param2)`
|
|
8
|
+
### `global static String doGet(String param1, Reference1 param2)`
|
|
9
9
|
|
|
10
10
|
`HTTPGET`
|
|
11
|
-
### `global static doPatch(String param1, Reference1 param2)`
|
|
11
|
+
### `global static String doPatch(String param1, Reference1 param2)`
|
|
12
12
|
|
|
13
13
|
`HTTPPATCH`
|
|
14
14
|
---
|
|
@@ -6,11 +6,11 @@ This is an interface description.
|
|
|
6
6
|
**Group** Sample Interfaces
|
|
7
7
|
|
|
8
8
|
## Methods
|
|
9
|
-
### `global execute()`
|
|
9
|
+
### `global void execute()`
|
|
10
10
|
|
|
11
11
|
Executes the command.
|
|
12
12
|
|
|
13
|
-
### `global getValue()`
|
|
13
|
+
### `global String getValue()`
|
|
14
14
|
|
|
15
15
|
Returns a value based on the executed command.
|
|
16
16
|
|
|
@@ -6,7 +6,7 @@ function declareMethod(markdownFile, methods, startingHeadingLevel, className =
|
|
|
6
6
|
methods.forEach((currentMethod) => {
|
|
7
7
|
var _a, _b;
|
|
8
8
|
const signatureName = isMethod(currentMethod)
|
|
9
|
-
? `${currentMethod.name}`
|
|
9
|
+
? `${currentMethod.typeReference.type} ${currentMethod.name}`
|
|
10
10
|
: className;
|
|
11
11
|
markdownFile.addTitle(`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``, startingHeadingLevel + 2);
|
|
12
12
|
// Inheritance tag
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"method-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/method-declaration-util.ts"],"names":[],"mappings":";;;AAGA,+EAA+E;AAG/E,SAAgB,aAAa,CAC3B,YAA0B,EAC1B,OAA4D,EAC5D,oBAA4B,EAC5B,SAAS,GAAG,EAAE;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;QAChC,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC3C,CAAC,CAAC,GAAI,aAA6C,CAAC,IAAI,EAAE;
|
|
1
|
+
{"version":3,"file":"method-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/method-declaration-util.ts"],"names":[],"mappings":";;;AAGA,+EAA+E;AAG/E,SAAgB,aAAa,CAC3B,YAA0B,EAC1B,OAA4D,EAC5D,oBAA4B,EAC5B,SAAS,GAAG,EAAE;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;QAChC,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC3C,CAAC,CAAC,GAAI,aAA6C,CAAC,aAAa,CAAC,IAAI,IACjE,aAA6C,CAAC,IACjD,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;QACd,YAAY,CAAC,QAAQ,CACnB,KAAK,cAAc,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,EAAE,aAAa,CAAC,IAAI,EACpF,oBAAoB,GAAG,CAAC,CACzB,CAAC;QAEF,kBAAkB;QAClB,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC3B,MAAM,cAAc,GAAG,aAA4C,CAAC;YACpE,IAAI,cAAc,CAAC,SAAS,EAAE;gBAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBACpC,YAAY,CAAC,YAAY,EAAE,CAAC;aAC7B;SACF;QAED,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,WAAW,EAAE;YACzC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3D,YAAY,CAAC,YAAY,EAAE,CAAC;SAC7B;QAED,IAAI,aAAa,CAAC,UAAU,CAAC,MAAM,EAAE;YACnC,aAAa,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;SAClE;QAED,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE;YAC3B,UAAU,CAAC,YAAY,EAAE,aAA4C,EAAE,oBAAoB,CAAC,CAAC;SAC9F;QAED,cAAc,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAElE,IAAA,4DAA8B,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAE5D,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,iBAAiB,EAAE;YAC/C,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;SAC/D;IACH,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAxDD,sCAwDC;AAUD,SAAS,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,cAA8B;IAC1F,IAAI,SAAS,GAAG,GAAG,IAAI,GAAG,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAK,cAA8C,CAAC,eAAe,CAAC,MAAM,EAAE;QACtG,SAAS;YACP,cAAc;gBACd,GAAG;gBACF,cAA8C,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;gBACzE,GAAG;gBACH,SAAS,CAAC;KACb;SAAM;QACL,SAAS,GAAG,cAAc,GAAG,GAAG,GAAG,SAAS,CAAC;KAC9C;IACD,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,CACvD,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CACjE,CAAC;IACF,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,GAAG,SAAS,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,WAA4D,EAC5D,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,MAAM,CAAA,EAAE;QACpD,4FAA4F;QAC5F,OAAO;KACR;IAED,YAAY,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC9D,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAErD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;QACnE,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;QAC5C,MAAM,gBAAgB,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CACjB,YAA0B,EAC1B,WAAwC,EACxC,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAA,EAAE;QAC7C,OAAO;KACR;IAED,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACpD,YAAY,CAAC,WAAW,CACtB,WAAW,CAAC,aAAa,CAAC,cAAc,EACxC,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAC7D,CAAC;IACF,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,cAAc,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAChH,IAAI,CAAC,CAAA,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,MAAM,CAAA,EAAE;QACzD,OAAO;KACR;IACD,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC1D,YAAY,CAAC,eAAe,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAEzD,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACnE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC/C,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,YAAY,CAAC,WAAW,CAAC,KAAK,aAAa,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAC5G,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,cAAc,EAAE,CAAC;IAC9B,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACvE,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,QAAQ,CACf,MAAwE;IAExE,OAAQ,MAAsC,CAAC,aAAa,KAAK,SAAS,CAAC;AAC7E,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cparra/apexdocs",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.17.0",
|
|
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/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
|
|
27
|
+
"execute:example": "rimraf ./docs/types && node lib/cli/generate.js -s examples/force-app -t docs/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
|
|
28
28
|
"execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
|
|
29
29
|
"execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
|
|
30
30
|
},
|
|
@@ -12,7 +12,9 @@ export function declareMethod(
|
|
|
12
12
|
): void {
|
|
13
13
|
methods.forEach((currentMethod) => {
|
|
14
14
|
const signatureName = isMethod(currentMethod)
|
|
15
|
-
? `${(currentMethod as MethodMirrorWithInheritance).
|
|
15
|
+
? `${(currentMethod as MethodMirrorWithInheritance).typeReference.type} ${
|
|
16
|
+
(currentMethod as MethodMirrorWithInheritance).name
|
|
17
|
+
}`
|
|
16
18
|
: className;
|
|
17
19
|
markdownFile.addTitle(
|
|
18
20
|
`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``,
|