@cparra/apexdocs 2.1.1 → 2.1.4

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 (7) hide show
  1. package/ROADMAP.md +0 -2
  2. package/docs/Misc/SampleClassWithoutModifier.md +11 -11
  3. package/docs/README.md +16 -16
  4. package/docs/Sample-Classes/SampleClass.md +165 -165
  5. package/docs/Sample-Interfaces/SampleInterface.md +27 -27
  6. package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
  7. package/package.json +2 -2
package/ROADMAP.md CHANGED
@@ -14,5 +14,3 @@ files, instead of just overriding
14
14
  [] Add configuration setting that allows someone to set the "namespace"
15
15
 
16
16
  [] Homepage support similar to what docsify does
17
-
18
- [] TW template
package/docs/Misc/SampleClassWithoutModifier.md CHANGED
@@ -1,11 +1,11 @@
1
- # SampleClassWithoutModifier
2
-
3
- `ISTEST`
4
- ## Methods
5
- ### `static thisIsAClassWithoutAModifier()`
6
-
7
- `ISTEST`
8
-
9
- This is a test method
10
-
11
- ---
1
+ # SampleClassWithoutModifier
2
+
3
+ `ISTEST`
4
+ ## Methods
5
+ ### `static thisIsAClassWithoutAModifier()`
6
+
7
+ `ISTEST`
8
+
9
+ This is a test method
10
+
11
+ ---
package/docs/README.md CHANGED
@@ -1,16 +1,16 @@
1
- # Classes
2
- ## Sample Classes
3
-
4
- ### [SampleClass](/Sample-Classes/SampleClass.md)
5
-
6
- This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md) But this ClassThatDoesNotExist does not exist. You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
7
- ## Miscellaneous
8
-
9
- ### [SampleClassWithoutModifier](/Misc/SampleClassWithoutModifier.md)
10
-
11
-
12
- ## Sample Interfaces
13
-
14
- ### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
15
-
16
- This is an interface description.
1
+ # Classes
2
+ ## Sample Classes
3
+
4
+ ### [SampleClass](/Sample-Classes/SampleClass.md)
5
+
6
+ This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md) But this ClassThatDoesNotExist does not exist. You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
7
+ ## Miscellaneous
8
+
9
+ ### [SampleClassWithoutModifier](/Misc/SampleClassWithoutModifier.md)
10
+
11
+
12
+ ## Sample Interfaces
13
+
14
+ ### [SampleInterface](/Sample-Interfaces/SampleInterface.md)
15
+
16
+ This is an interface description.
package/docs/Sample-Classes/SampleClass.md CHANGED
@@ -1,165 +1,165 @@
1
- # SampleClass
2
-
3
- `NAMESPACEACCESSIBLE`
4
-
5
- This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md) But this ClassThatDoesNotExist does not exist. You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
6
-
7
-
8
- **Group** Sample Classes
9
-
10
-
11
- **CustomAnnotation** A Custom annotation
12
-
13
-
14
- **Author** Cesar Parra
15
-
16
-
17
- **See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
18
-
19
- ## Constructors
20
- ### My Super Group
21
- ##### `SampleClass()`
22
-
23
- `NAMESPACEACCESSIBLE`
24
-
25
- Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
26
-
27
- ###### Throws
28
- |Exception|Description|
29
- |---|---|
30
- |`ExcName`|some exception|
31
-
32
-
33
- **CustomAnnotation** A Custom method annotation
34
-
35
-
36
- **See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
37
-
38
- ###### Example
39
- ```apex
40
- // Example
41
- SampleClass sampleInstance = new SampleClass();
42
- ```
43
-
44
- ---
45
- ### Other
46
- ##### `SampleClass(String argument1, String argument2)`
47
-
48
- Constructs a SampleClass with an argument.
49
-
50
- ###### Parameters
51
- |Param|Description|
52
- |---|---|
53
- |`argument1`|Argument1 definition|
54
- |`argument2`|Argument2 definition|
55
-
56
- ---
57
- ## Fields
58
- ### Common Constants
59
-
60
- * `ANOTHER_CONSTANT` → `String`
61
- * `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
62
- ---
63
- ### Other variables
64
-
65
- * `someVariable` → `String`
66
- ---
67
- ## Properties
68
-
69
- ### `AnotherProp` → `Decimal`
70
-
71
- `AURAENABLED`
72
-
73
- This is a Decimal property.
74
-
75
- ### `MyProp` → `String`
76
-
77
- `AURAENABLED`
78
- `DEPRECATED`
79
-
80
- This is a String property.
81
-
82
- ---
83
- ## Methods
84
- ### `static sampleMethod(String argument1, String argument2)`
85
-
86
- `NAMESPACEACCESSIBLE`
87
-
88
- Executes commands based on the passed in argument.
89
-
90
- #### Parameters
91
- |Param|Description|
92
- |---|---|
93
- |`argument1`|Argument1 to debug|
94
- |`argument2`|Argument2 to debug|
95
-
96
- #### Return
97
-
98
- **Type**
99
-
100
- String
101
-
102
- **Description**
103
-
104
- Empty string
105
-
106
- #### Example
107
- ```apex
108
- String result = SampleClass.testMethod();
109
- System.debug(result);
110
- ```
111
-
112
- ### `static call()`
113
-
114
- Calls the method. This methods allows you to call it.
115
-
116
- ---
117
- ## Enums
118
- ### InnerEnum
119
-
120
- `NAMESPACEACCESSIBLE`
121
-
122
- This is a namespace accessible enum
123
-
124
-
125
- ---
126
- ## Classes
127
- ### AnotherInnerClass
128
-
129
- Inner class belonging to SampleClass.
130
-
131
- #### Properties
132
-
133
- ##### `InnerProp` → `String`
134
-
135
-
136
- Description of the inner property.
137
-
138
- ---
139
- #### Methods
140
- ##### `innerMethod()`
141
-
142
- Executes from the inner class.
143
-
144
- ---
145
-
146
- ### InnerClass
147
-
148
- Inner class belonging to SampleClass.
149
-
150
- #### Properties
151
-
152
- ##### `InnerProp` → `String`
153
-
154
-
155
- Description of the inner property.
156
-
157
- ---
158
- #### Methods
159
- ##### `innerMethod()`
160
-
161
- Executes from the inner class.
162
-
163
- ---
164
-
165
- ---
1
+ # SampleClass
2
+
3
+ `NAMESPACEACCESSIBLE`
4
+
5
+ This is a class description. This class relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md) But this ClassThatDoesNotExist does not exist. You can also link using this syntax [SampleInterface](/Sample-Interfaces/SampleInterface.md)
6
+
7
+
8
+ **Group** Sample Classes
9
+
10
+
11
+ **CustomAnnotation** A Custom annotation
12
+
13
+
14
+ **Author** Cesar Parra
15
+
16
+
17
+ **See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
18
+
19
+ ## Constructors
20
+ ### My Super Group
21
+ ##### `SampleClass()`
22
+
23
+ `NAMESPACEACCESSIBLE`
24
+
25
+ Constructs a SampleClass without any arguments. This relates to [SampleInterface](/Sample-Interfaces/SampleInterface.md)
26
+
27
+ ###### Throws
28
+ |Exception|Description|
29
+ |---|---|
30
+ |`ExcName`|some exception|
31
+
32
+
33
+ **CustomAnnotation** A Custom method annotation
34
+
35
+
36
+ **See** [SampleInterface](/Sample-Interfaces/SampleInterface.md)
37
+
38
+ ###### Example
39
+ ```apex
40
+ // Example
41
+ SampleClass sampleInstance = new SampleClass();
42
+ ```
43
+
44
+ ---
45
+ ### Other
46
+ ##### `SampleClass(String argument1, String argument2)`
47
+
48
+ Constructs a SampleClass with an argument.
49
+
50
+ ###### Parameters
51
+ |Param|Description|
52
+ |---|---|
53
+ |`argument1`|Argument1 definition|
54
+ |`argument2`|Argument2 definition|
55
+
56
+ ---
57
+ ## Fields
58
+ ### Common Constants
59
+
60
+ * `ANOTHER_CONSTANT` → `String`
61
+ * `A_CONSTANT` → `String` [`NAMESPACEACCESSIBLE` ] - This is a constant.
62
+ ---
63
+ ### Other variables
64
+
65
+ * `someVariable` → `String`
66
+ ---
67
+ ## Properties
68
+
69
+ ### `AnotherProp` → `Decimal`
70
+
71
+ `AURAENABLED`
72
+
73
+ This is a Decimal property.
74
+
75
+ ### `MyProp` → `String`
76
+
77
+ `AURAENABLED`
78
+ `DEPRECATED`
79
+
80
+ This is a String property.
81
+
82
+ ---
83
+ ## Methods
84
+ ### `static sampleMethod(String argument1, String argument2)`
85
+
86
+ `NAMESPACEACCESSIBLE`
87
+
88
+ Executes commands based on the passed in argument.
89
+
90
+ #### Parameters
91
+ |Param|Description|
92
+ |---|---|
93
+ |`argument1`|Argument1 to debug|
94
+ |`argument2`|Argument2 to debug|
95
+
96
+ #### Return
97
+
98
+ **Type**
99
+
100
+ String
101
+
102
+ **Description**
103
+
104
+ Empty string
105
+
106
+ #### Example
107
+ ```apex
108
+ String result = SampleClass.testMethod();
109
+ System.debug(result);
110
+ ```
111
+
112
+ ### `static call()`
113
+
114
+ Calls the method. This methods allows you to call it.
115
+
116
+ ---
117
+ ## Enums
118
+ ### InnerEnum
119
+
120
+ `NAMESPACEACCESSIBLE`
121
+
122
+ This is a namespace accessible enum
123
+
124
+
125
+ ---
126
+ ## Classes
127
+ ### AnotherInnerClass
128
+
129
+ Inner class belonging to SampleClass.
130
+
131
+ #### Properties
132
+
133
+ ##### `InnerProp` → `String`
134
+
135
+
136
+ Description of the inner property.
137
+
138
+ ---
139
+ #### Methods
140
+ ##### `innerMethod()`
141
+
142
+ Executes from the inner class.
143
+
144
+ ---
145
+
146
+ ### InnerClass
147
+
148
+ Inner class belonging to SampleClass.
149
+
150
+ #### Properties
151
+
152
+ ##### `InnerProp` → `String`
153
+
154
+
155
+ Description of the inner property.
156
+
157
+ ---
158
+ #### Methods
159
+ ##### `innerMethod()`
160
+
161
+ Executes from the inner class.
162
+
163
+ ---
164
+
165
+ ---
package/docs/Sample-Interfaces/SampleInterface.md CHANGED
@@ -1,27 +1,27 @@
1
- # SampleInterface
2
-
3
- This is an interface description.
4
-
5
-
6
- **Group** Sample Interfaces
7
-
8
- ## Methods
9
- ### `execute()`
10
-
11
- Executes the command.
12
-
13
- ### `getValue()`
14
-
15
- Returns a value based on the executed command.
16
-
17
- #### Return
18
-
19
- **Type**
20
-
21
- String
22
-
23
- **Description**
24
-
25
- The value
26
-
27
- ---
1
+ # SampleInterface
2
+
3
+ This is an interface description.
4
+
5
+
6
+ **Group** Sample Interfaces
7
+
8
+ ## Methods
9
+ ### `execute()`
10
+
11
+ Executes the command.
12
+
13
+ ### `getValue()`
14
+
15
+ Returns a value based on the executed command.
16
+
17
+ #### Return
18
+
19
+ **Type**
20
+
21
+ String
22
+
23
+ **Description**
24
+
25
+ The value
26
+
27
+ ---
package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls CHANGED
@@ -1,9 +1,9 @@
1
- @IsTest
2
- class SampleClassWithoutModifier {
3
- /**
4
- * @description This is a test method
5
- */
6
- @IsTest
7
- private static void thisIsAClassWithoutAModifier() {
8
- }
9
- }
1
+ @IsTest
2
+ class SampleClassWithoutModifier {
3
+ /**
4
+ * @description This is a test method
5
+ */
6
+ @IsTest
7
+ private static void thisIsAClassWithoutAModifier() {
8
+ }
9
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cparra/apexdocs",
3
- "version": "2.1.1",
3
+ "version": "2.1.4",
4
4
  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
5
  "keywords": [
6
6
  "apex",
@@ -63,7 +63,7 @@
63
63
  ]
64
64
  },
65
65
  "dependencies": {
66
- "@cparra/apex-reflection": "^1.1.1",
66
+ "@cparra/apex-reflection": "^1.1.3",
67
67
  "chalk": "^4.1.2",
68
68
  "html-entities": "^2.3.2",
69
69
  "yargs": "^16.0.3"