@cparra/apexdocs 2.17.0 → 2.17.2
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 +2 -2
- package/docs/types/Main/nspc.SampleClass.md +2 -1
- package/docs/types/Misc-Group/nspc.InterfaceWithInheritance.md +1 -1
- package/docs/types/Misc-Group/nspc.SampleRestResource.md +2 -2
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +1 -1
- package/docs/types/Sample-Interfaces/nspc.SampleInterface.md +1 -1
- package/examples/force-app/main/default/classes/SampleClass.cls +5 -0
- package/lib/model/markdown-generation-util/method-declaration-util.js +2 -2
- 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 +2 -2
|
@@ -56,7 +56,7 @@ This method was overridden.
|
|
|
56
56
|
|
|
57
57
|
|Type|Description|
|
|
58
58
|
|---|---|
|
|
59
|
-
|
|
59
|
+
|`String`|A String.|
|
|
60
60
|
|
|
61
61
|
### `public void execute()`
|
|
62
62
|
|
|
@@ -70,7 +70,7 @@ Returns a value based on the executed command.
|
|
|
70
70
|
|
|
71
71
|
|Type|Description|
|
|
72
72
|
|---|---|
|
|
73
|
-
|
|
73
|
+
|`String`|The value|
|
|
74
74
|
|
|
75
75
|
### `public String overridableMethod()`
|
|
76
76
|
|
|
@@ -114,7 +114,7 @@ Executes commands based on the passed in argument.
|
|
|
114
114
|
|
|
115
115
|
|Type|Description|
|
|
116
116
|
|---|---|
|
|
117
|
-
|
|
117
|
+
|`String`|Empty string|
|
|
118
118
|
|
|
119
119
|
###### Example
|
|
120
120
|
```apex
|
|
@@ -130,6 +130,7 @@ Something here
|
|
|
130
130
|
|
|
131
131
|
**Arg1** The arg1 description
|
|
132
132
|
|
|
133
|
+
##### `public static Map<Id,List<String>> yetAnotherSampleMethod(String arg1)`
|
|
133
134
|
---
|
|
134
135
|
### Other
|
|
135
136
|
##### `public static void call()`
|
|
@@ -42,7 +42,7 @@ This is a sample HTTP Get method
|
|
|
42
42
|
|
|
43
43
|
|Type|Description|
|
|
44
44
|
|---|---|
|
|
45
|
-
|
|
45
|
+
|`Account`|An Account SObject.|
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
**Http Parameter** name: limit in: query required: true description: Limits the number of items on a page schema: type: integer
|
|
@@ -75,7 +75,7 @@ This is a sample HTTP Post method
|
|
|
75
75
|
|
|
76
76
|
|Type|Description|
|
|
77
77
|
|---|---|
|
|
78
|
-
|
|
78
|
+
|`String`|A String SObject.|
|
|
79
79
|
|
|
80
80
|
|
|
81
81
|
**Summary** Posts an Account 2
|
|
@@ -15,7 +15,7 @@ This is a sample HTTP Get method
|
|
|
15
15
|
|
|
16
16
|
|Type|Description|
|
|
17
17
|
|---|---|
|
|
18
|
-
|
|
18
|
+
|`InnerClass`|A SampleRestResourceWithInnerClass.InnerClass Object.|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
**Http Response** statusCode: 200 schema: SampleRestResourceWithInnerClass.InnerClass
|
|
@@ -94,6 +94,11 @@ public with sharing class SampleClass {
|
|
|
94
94
|
System.debug('something');
|
|
95
95
|
return '';
|
|
96
96
|
}
|
|
97
|
+
|
|
98
|
+
public static Map<Id, List<String>> yetAnotherSampleMethod(String arg1) {
|
|
99
|
+
System.debug('something');
|
|
100
|
+
return new Map<Id, List<String>>();
|
|
101
|
+
}
|
|
97
102
|
// @end-group
|
|
98
103
|
|
|
99
104
|
|
|
@@ -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.typeReference.
|
|
9
|
+
? `${currentMethod.typeReference.rawDeclaration} ${currentMethod.name}`
|
|
10
10
|
: className;
|
|
11
11
|
markdownFile.addTitle(`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``, startingHeadingLevel + 2);
|
|
12
12
|
// Inheritance tag
|
|
@@ -81,7 +81,7 @@ function addReturns(markdownFile, methodModel, startingHeadingLevel) {
|
|
|
81
81
|
}
|
|
82
82
|
markdownFile.addTitle('Returns', startingHeadingLevel + 3);
|
|
83
83
|
markdownFile.initializeTable('Type', 'Description');
|
|
84
|
-
markdownFile.addTableRow(methodModel.typeReference.rawDeclaration
|
|
84
|
+
markdownFile.addTableRow(`\`${methodModel.typeReference.rawDeclaration}\``, (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.returnAnnotation.bodyLines.join(' '));
|
|
85
85
|
markdownFile.addBlankLine();
|
|
86
86
|
}
|
|
87
87
|
function addThrowsBlock(markdownFile, docCommentAware, startingHeadingLevel) {
|
|
@@ -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,aAAa,CAAC,
|
|
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,cAAc,IAC3E,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,KAAK,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EACjD,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.17.
|
|
3
|
+
"version": "2.17.2",
|
|
4
4
|
"description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"apex",
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
]
|
|
67
67
|
},
|
|
68
68
|
"dependencies": {
|
|
69
|
-
"@cparra/apex-reflection": "2.4.
|
|
69
|
+
"@cparra/apex-reflection": "2.4.1",
|
|
70
70
|
"chalk": "^4.1.2",
|
|
71
71
|
"fast-xml-parser": "^4.0.1",
|
|
72
72
|
"js-yaml": "^4.1.0",
|
|
@@ -12,7 +12,7 @@ export function declareMethod(
|
|
|
12
12
|
): void {
|
|
13
13
|
methods.forEach((currentMethod) => {
|
|
14
14
|
const signatureName = isMethod(currentMethod)
|
|
15
|
-
? `${(currentMethod as MethodMirrorWithInheritance).typeReference.
|
|
15
|
+
? `${(currentMethod as MethodMirrorWithInheritance).typeReference.rawDeclaration} ${
|
|
16
16
|
(currentMethod as MethodMirrorWithInheritance).name
|
|
17
17
|
}`
|
|
18
18
|
: className;
|
|
@@ -123,7 +123,7 @@ function addReturns(
|
|
|
123
123
|
markdownFile.addTitle('Returns', startingHeadingLevel + 3);
|
|
124
124
|
markdownFile.initializeTable('Type', 'Description');
|
|
125
125
|
markdownFile.addTableRow(
|
|
126
|
-
methodModel.typeReference.rawDeclaration
|
|
126
|
+
`\`${methodModel.typeReference.rawDeclaration}\``,
|
|
127
127
|
methodModel.docComment?.returnAnnotation.bodyLines.join(' '),
|
|
128
128
|
);
|
|
129
129
|
markdownFile.addBlankLine();
|