@cparra/apexdocs 2.8.0 → 2.8.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/Main/SampleClass.md
CHANGED
|
@@ -1,188 +1,188 @@
|
|
|
1
|
-
# SampleClass
|
|
2
|
-
|
|
3
|
-
`NAMESPACEACCESSIBLE`
|
|
4
|
-
|
|
5
|
-
`APIVERSION: 54`
|
|
6
|
-
|
|
7
|
-
`STATUS: ACTIVE`
|
|
8
|
-
|
|
9
|
-
This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
10
|
-
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
|
|
11
|
-
You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
**Group** Main
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
**CustomAnnotation** A Custom annotation
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
**Author** Cesar Parra
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
24
|
-
|
|
25
|
-
## Constructors
|
|
26
|
-
### My Super Group
|
|
27
|
-
##### `SampleClass()`
|
|
28
|
-
|
|
29
|
-
`NAMESPACEACCESSIBLE`
|
|
30
|
-
|
|
31
|
-
Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
32
|
-
|
|
33
|
-
###### Throws
|
|
34
|
-
|
|
35
|
-
|Exception|Description|
|
|
36
|
-
|---|---|
|
|
37
|
-
|`ExcName`|some exception|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
**CustomAnnotation** A Custom method annotation
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
44
|
-
|
|
45
|
-
###### Example
|
|
46
|
-
```apex
|
|
47
|
-
// Example
|
|
48
|
-
SampleClass sampleInstance = new SampleClass();
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
### Other
|
|
54
|
-
##### `SampleClass(String argument1, String argument2)`
|
|
55
|
-
|
|
56
|
-
Constructs a SampleClass with an argument.
|
|
57
|
-
|
|
58
|
-
###### Parameters
|
|
59
|
-
|
|
60
|
-
|Param|Description|
|
|
61
|
-
|---|---|
|
|
62
|
-
|`argument1`|Argument1 definition|
|
|
63
|
-
|`argument2`|Argument2 definition|
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
## Fields
|
|
67
|
-
### Common Constants
|
|
68
|
-
|
|
69
|
-
* `ANOTHER_CONSTANT` → `String` (*Inherited*)
|
|
70
|
-
* `A_CONSTANT` → `String` (*Inherited*) [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
71
|
-
---
|
|
72
|
-
### 'General' Constants
|
|
73
|
-
|
|
74
|
-
* `GENERAL_ANOTHER_CONSTANT` → `String` (*Inherited*)
|
|
75
|
-
* `GENERAL_A_CONSTANT` → `String` (*Inherited*) [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
76
|
-
---
|
|
77
|
-
### Other variables
|
|
78
|
-
|
|
79
|
-
* `someVariable` → `String` (*Inherited*)
|
|
80
|
-
---
|
|
81
|
-
## Properties
|
|
82
|
-
|
|
83
|
-
### `AnotherProp` → `Decimal`
|
|
84
|
-
|
|
85
|
-
`AURAENABLED`
|
|
86
|
-
|
|
87
|
-
This is a Decimal property.
|
|
88
|
-
|
|
89
|
-
### `MyProp` → `String`
|
|
90
|
-
|
|
91
|
-
`AURAENABLED`
|
|
92
|
-
`DEPRECATED`
|
|
93
|
-
|
|
94
|
-
This is a String property.
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
## Methods
|
|
98
|
-
### `static sampleMethod(String argument1, String argument2)`
|
|
99
|
-
|
|
100
|
-
`NAMESPACEACCESSIBLE`
|
|
101
|
-
|
|
102
|
-
Executes commands based on the passed in argument.
|
|
103
|
-
|
|
104
|
-
#### Parameters
|
|
105
|
-
|
|
106
|
-
|Param|Description|
|
|
107
|
-
|---|---|
|
|
108
|
-
|`argument1`|Argument1 to debug|
|
|
109
|
-
|`argument2`|Argument2 to debug|
|
|
110
|
-
|
|
111
|
-
#### Return
|
|
112
|
-
|
|
113
|
-
**Type**
|
|
114
|
-
|
|
115
|
-
String
|
|
116
|
-
|
|
117
|
-
**Description**
|
|
118
|
-
|
|
119
|
-
Empty string
|
|
120
|
-
|
|
121
|
-
#### Example
|
|
122
|
-
```apex
|
|
123
|
-
String result = SampleClass.testMethod();
|
|
124
|
-
System.debug(result);
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
### `static anotherSampleMethod(String arg1)`
|
|
129
|
-
|
|
130
|
-
Something here
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
**Arg1** The arg1 description
|
|
134
|
-
|
|
135
|
-
### `static call()`
|
|
136
|
-
|
|
137
|
-
Calls the method. This methods allows you to call it.
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
## Enums
|
|
141
|
-
### InnerEnum
|
|
142
|
-
|
|
143
|
-
`NAMESPACEACCESSIBLE`
|
|
144
|
-
|
|
145
|
-
This is a namespace accessible enum
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
---
|
|
149
|
-
## Classes
|
|
150
|
-
### AnotherInnerClass
|
|
151
|
-
|
|
152
|
-
Inner class belonging to SampleClass.
|
|
153
|
-
|
|
154
|
-
#### Properties
|
|
155
|
-
|
|
156
|
-
##### `InnerProp` → `String`
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
Description of the inner property.
|
|
160
|
-
|
|
161
|
-
---
|
|
162
|
-
#### Methods
|
|
163
|
-
##### `innerMethod()`
|
|
164
|
-
|
|
165
|
-
Executes from the inner class.
|
|
166
|
-
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
### InnerClass
|
|
170
|
-
|
|
171
|
-
Inner class belonging to SampleClass.
|
|
172
|
-
|
|
173
|
-
#### Properties
|
|
174
|
-
|
|
175
|
-
##### `InnerProp` → `String`
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
Description of the inner property.
|
|
179
|
-
|
|
180
|
-
---
|
|
181
|
-
#### Methods
|
|
182
|
-
##### `innerMethod()`
|
|
183
|
-
|
|
184
|
-
Executes from the inner class.
|
|
185
|
-
|
|
186
|
-
---
|
|
187
|
-
|
|
188
|
-
---
|
|
1
|
+
# SampleClass
|
|
2
|
+
|
|
3
|
+
`NAMESPACEACCESSIBLE`
|
|
4
|
+
|
|
5
|
+
`APIVERSION: 54`
|
|
6
|
+
|
|
7
|
+
`STATUS: ACTIVE`
|
|
8
|
+
|
|
9
|
+
This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
10
|
+
But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
|
|
11
|
+
You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
**Group** Main
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
**CustomAnnotation** A Custom annotation
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
**Author** Cesar Parra
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
24
|
+
|
|
25
|
+
## Constructors
|
|
26
|
+
### My Super Group
|
|
27
|
+
##### `SampleClass()`
|
|
28
|
+
|
|
29
|
+
`NAMESPACEACCESSIBLE`
|
|
30
|
+
|
|
31
|
+
Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
32
|
+
|
|
33
|
+
###### Throws
|
|
34
|
+
|
|
35
|
+
|Exception|Description|
|
|
36
|
+
|---|---|
|
|
37
|
+
|`ExcName`|some exception|
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
**CustomAnnotation** A Custom method annotation
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
**See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
|
|
44
|
+
|
|
45
|
+
###### Example
|
|
46
|
+
```apex
|
|
47
|
+
// Example
|
|
48
|
+
SampleClass sampleInstance = new SampleClass();
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
### Other
|
|
54
|
+
##### `SampleClass(String argument1, String argument2)`
|
|
55
|
+
|
|
56
|
+
Constructs a SampleClass with an argument.
|
|
57
|
+
|
|
58
|
+
###### Parameters
|
|
59
|
+
|
|
60
|
+
|Param|Description|
|
|
61
|
+
|---|---|
|
|
62
|
+
|`argument1`|Argument1 definition|
|
|
63
|
+
|`argument2`|Argument2 definition|
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
## Fields
|
|
67
|
+
### Common Constants
|
|
68
|
+
|
|
69
|
+
* `ANOTHER_CONSTANT` → `String` (*Inherited*)
|
|
70
|
+
* `A_CONSTANT` → `String` (*Inherited*) [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
71
|
+
---
|
|
72
|
+
### 'General' Constants
|
|
73
|
+
|
|
74
|
+
* `GENERAL_ANOTHER_CONSTANT` → `String` (*Inherited*)
|
|
75
|
+
* `GENERAL_A_CONSTANT` → `String` (*Inherited*) [`NAMESPACEACCESSIBLE` ] - This is a constant.
|
|
76
|
+
---
|
|
77
|
+
### Other variables
|
|
78
|
+
|
|
79
|
+
* `someVariable` → `String` (*Inherited*)
|
|
80
|
+
---
|
|
81
|
+
## Properties
|
|
82
|
+
|
|
83
|
+
### `AnotherProp` → `Decimal`
|
|
84
|
+
|
|
85
|
+
`AURAENABLED`
|
|
86
|
+
|
|
87
|
+
This is a Decimal property.
|
|
88
|
+
|
|
89
|
+
### `MyProp` → `String`
|
|
90
|
+
|
|
91
|
+
`AURAENABLED`
|
|
92
|
+
`DEPRECATED`
|
|
93
|
+
|
|
94
|
+
This is a String property.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
## Methods
|
|
98
|
+
### `static sampleMethod(String argument1, String argument2)`
|
|
99
|
+
|
|
100
|
+
`NAMESPACEACCESSIBLE`
|
|
101
|
+
|
|
102
|
+
Executes commands based on the passed in argument.
|
|
103
|
+
|
|
104
|
+
#### Parameters
|
|
105
|
+
|
|
106
|
+
|Param|Description|
|
|
107
|
+
|---|---|
|
|
108
|
+
|`argument1`|Argument1 to debug|
|
|
109
|
+
|`argument2`|Argument2 to debug|
|
|
110
|
+
|
|
111
|
+
#### Return
|
|
112
|
+
|
|
113
|
+
**Type**
|
|
114
|
+
|
|
115
|
+
String
|
|
116
|
+
|
|
117
|
+
**Description**
|
|
118
|
+
|
|
119
|
+
Empty string
|
|
120
|
+
|
|
121
|
+
#### Example
|
|
122
|
+
```apex
|
|
123
|
+
String result = SampleClass.testMethod();
|
|
124
|
+
System.debug(result);
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### `static anotherSampleMethod(String arg1)`
|
|
129
|
+
|
|
130
|
+
Something here
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
**Arg1** The arg1 description
|
|
134
|
+
|
|
135
|
+
### `static call()`
|
|
136
|
+
|
|
137
|
+
Calls the method. This methods allows you to call it.
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
## Enums
|
|
141
|
+
### InnerEnum
|
|
142
|
+
|
|
143
|
+
`NAMESPACEACCESSIBLE`
|
|
144
|
+
|
|
145
|
+
This is a namespace accessible enum
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
## Classes
|
|
150
|
+
### AnotherInnerClass
|
|
151
|
+
|
|
152
|
+
Inner class belonging to SampleClass.
|
|
153
|
+
|
|
154
|
+
#### Properties
|
|
155
|
+
|
|
156
|
+
##### `InnerProp` → `String`
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
Description of the inner property.
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
#### Methods
|
|
163
|
+
##### `innerMethod()`
|
|
164
|
+
|
|
165
|
+
Executes from the inner class.
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
### InnerClass
|
|
170
|
+
|
|
171
|
+
Inner class belonging to SampleClass.
|
|
172
|
+
|
|
173
|
+
#### Properties
|
|
174
|
+
|
|
175
|
+
##### `InnerProp` → `String`
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
Description of the inner property.
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
#### Methods
|
|
182
|
+
##### `innerMethod()`
|
|
183
|
+
|
|
184
|
+
Executes from the inner class.
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
---
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cparra/apexdocs",
|
|
3
|
-
"version": "2.8.
|
|
3
|
+
"version": "2.8.2",
|
|
4
4
|
"description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"apex",
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
]
|
|
65
65
|
},
|
|
66
66
|
"dependencies": {
|
|
67
|
-
"@cparra/apex-reflection": "1.
|
|
67
|
+
"@cparra/apex-reflection": "1.11.0",
|
|
68
68
|
"chalk": "^4.1.2",
|
|
69
69
|
"fast-xml-parser": "^4.0.1",
|
|
70
70
|
"log-update": "4.0.0",
|
|
@@ -6,12 +6,12 @@ describe('File Reader', () => {
|
|
|
6
6
|
Settings.build({
|
|
7
7
|
sourceDirectory: '',
|
|
8
8
|
recursive: true,
|
|
9
|
-
configPath: '',
|
|
10
|
-
targetGenerator: 'jekyll',
|
|
11
|
-
group: true,
|
|
12
|
-
outputDir: '',
|
|
13
9
|
scope: [],
|
|
10
|
+
outputDir: '',
|
|
11
|
+
targetGenerator: 'jekyll',
|
|
14
12
|
indexOnly: false,
|
|
13
|
+
defaultGroupName: 'Misc',
|
|
14
|
+
sanitizeHtml: true,
|
|
15
15
|
} as SettingsConfig);
|
|
16
16
|
});
|
|
17
17
|
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { createManifest } from '../manifest-factory';
|
|
2
2
|
import { Type } from '@cparra/apex-reflection';
|
|
3
3
|
import { TypeParser } from '../parser';
|
|
4
|
+
import ApexBundle from '../../model/apex-bundle';
|
|
4
5
|
|
|
5
6
|
class TestParser implements TypeParser {
|
|
6
7
|
parse(): Type[] {
|
|
@@ -9,7 +10,7 @@ class TestParser implements TypeParser {
|
|
|
9
10
|
}
|
|
10
11
|
|
|
11
12
|
it('creates a manifest from the result of a type parser', () => {
|
|
12
|
-
const manifest = createManifest(new TestParser(), (
|
|
13
|
+
const manifest = createManifest(new TestParser(), (bundle: ApexBundle) => {
|
|
13
14
|
return {};
|
|
14
15
|
});
|
|
15
16
|
expect(manifest.types.length).toBe(0);
|