@cparra/apexdocs 2.15.1 → 2.16.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.
Files changed (8) hide show
  1. package/README.md +10 -0
  2. package/docs/types/Misc-Group/nspc.AtFutureRecipes.md +4 -0
  3. package/docs/types/Misc-Group/nspc.EscapedAnnotations.md +4 -0
  4. package/docs/types/Misc-Group/nspc.MemberGrouping.md +13 -13
  5. package/docs/types/README.md +97 -91
  6. package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -0
  7. package/examples/force-app/main/default/classes/MemberGrouping.cls +1 -0
  8. package/package.json +4 -4
package/README.md CHANGED
@@ -69,6 +69,16 @@ public class MyClass {
69
69
  ```
70
70
 
71
71
  * Apex docs blocks can now all be in a single line
72
+
73
+ 📒 Note: If you wish to have multiple `@` tags in a single line but don't want them to be treated as ApexDoc annotations, you can
74
+ escape them by adding wrapping the annotation in ticks, for example
75
+
76
+ ```apex
77
+ /**
78
+ * @MyCustomAnnotation This is a custom annotation with an `@embedded` annotation
79
+ */
80
+ ```
81
+
72
82
  * Support for grouping blocks of related code within a class
73
83
  * Support for HTML tags
74
84
  * OpenApi REST specification generation
package/docs/types/Misc-Group/nspc.AtFutureRecipes.md ADDED
@@ -0,0 +1,4 @@
1
+ # nspc.AtFutureRecipes
2
+
3
+ Demonstrates the @future syntax and usage
4
+
package/docs/types/Misc-Group/nspc.EscapedAnnotations.md ADDED
@@ -0,0 +1,4 @@
1
+ # nspc.EscapedAnnotations
2
+
3
+ This sentence has an `@embedded` annotation.
4
+
package/docs/types/Misc-Group/nspc.MemberGrouping.md CHANGED
@@ -1,13 +1,13 @@
1
- # nspc.MemberGrouping
2
- ## Fields
3
- ### Group old syntax
4
-
5
- * `public anotherInGroup1` → `String`
6
- * `public inGroup1` → `String`
7
- ---
8
- ### Group new syntax
9
- Group's description
10
-
11
- * `public anotherInGroup2` → `String`
12
- * `public inGroup2` → `String` - Description for constant in group 2
13
- ---
1
+ # nspc.MemberGrouping
2
+ ## Fields
3
+ ### Group old syntax
4
+
5
+ * `public anotherInGroup1` → `String`
6
+ * `public inGroup1` → `String`
7
+ ---
8
+ ### Group new syntax
9
+ Group's description
10
+
11
+ * `public anotherInGroup2` → `String` - Description for another constant in group 2
12
+ * `public inGroup2` → `String` - Description for constant in group 2
13
+ ---
package/docs/types/README.md CHANGED
@@ -1,91 +1,97 @@
1
- # Sample Documentation
2
- ## Classes
3
-
4
- ### [nspc.AnotherInterface](types/Classes/nspc.AnotherInterface.md)
5
-
6
- Some desc
7
-
8
-
9
-
10
- ### [nspc.ChildClass](types/Classes/nspc.ChildClass.md)
11
-
12
- Some desc
13
-
14
-
15
- ## Misc Group
16
-
17
- ### [nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
18
-
19
-
20
- ### [nspc.InterfaceWithInheritance](types/Misc-Group/nspc.InterfaceWithInheritance.md)
21
-
22
-
23
- ### [nspc.MemberGrouping](types/Misc-Group/nspc.MemberGrouping.md)
24
-
25
-
26
- ### [nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
27
-
28
-
29
- ### [nspc.Reference1](types/Misc-Group/nspc.Reference1.md)
30
-
31
-
32
- ### [nspc.Reference2](types/Misc-Group/nspc.Reference2.md)
33
-
34
-
35
- ### [nspc.Reference3](types/Misc-Group/nspc.Reference3.md)
36
-
37
-
38
- ### [nspc.Reference4](types/Misc-Group/nspc.Reference4.md)
39
-
40
-
41
- ### [nspc.Reference5](types/Misc-Group/nspc.Reference5.md)
42
-
43
-
44
- ### [nspc.Reference6](types/Misc-Group/nspc.Reference6.md)
45
-
46
-
47
- ### [nspc.Reference7](types/Misc-Group/nspc.Reference7.md)
48
-
49
-
50
- ### [nspc.SampleClassWithoutModifier](types/Misc-Group/nspc.SampleClassWithoutModifier.md)
51
-
52
-
53
- ### [nspc.SampleRestResource](types/Misc-Group/nspc.SampleRestResource.md)
54
-
55
- Account related operations
56
-
57
-
58
-
59
- ### [nspc.SampleRestResourceWithInnerClass](types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
60
-
61
- Contact related operations
62
-
63
-
64
-
65
- ### [nspc.SampleRestResourceWithoutApexDocs](types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
66
-
67
- Order related operations
68
-
69
-
70
- ## Main
71
-
72
- ### [nspc.GroupedClass](types/Main/nspc.GroupedClass.md)
73
-
74
- Uses a block style apex doc
75
-
76
-
77
-
78
- ### [nspc.SampleClass](types/Main/nspc.SampleClass.md)
79
-
80
- This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
81
- But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
82
- You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
83
-
84
-
85
- ## Sample Interfaces
86
-
87
- ### [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
88
-
89
- This is an interface description.
90
-
91
-
1
+ # Sample Documentation
2
+ ## Classes
3
+
4
+ ### [nspc.AnotherInterface](types/Classes/nspc.AnotherInterface.md)
5
+
6
+ Some desc
7
+
8
+
9
+
10
+ ### [nspc.ChildClass](types/Classes/nspc.ChildClass.md)
11
+
12
+ Some desc
13
+
14
+
15
+ ## Misc Group
16
+
17
+ ### [nspc.EscapedAnnotations](types/Misc-Group/nspc.EscapedAnnotations.md)
18
+
19
+ This sentence has an `@embedded` annotation.
20
+
21
+
22
+
23
+ ### [nspc.GrandparentClass](types/Misc-Group/nspc.GrandparentClass.md)
24
+
25
+
26
+ ### [nspc.InterfaceWithInheritance](types/Misc-Group/nspc.InterfaceWithInheritance.md)
27
+
28
+
29
+ ### [nspc.MemberGrouping](types/Misc-Group/nspc.MemberGrouping.md)
30
+
31
+
32
+ ### [nspc.ParentClass](types/Misc-Group/nspc.ParentClass.md)
33
+
34
+
35
+ ### [nspc.Reference1](types/Misc-Group/nspc.Reference1.md)
36
+
37
+
38
+ ### [nspc.Reference2](types/Misc-Group/nspc.Reference2.md)
39
+
40
+
41
+ ### [nspc.Reference3](types/Misc-Group/nspc.Reference3.md)
42
+
43
+
44
+ ### [nspc.Reference4](types/Misc-Group/nspc.Reference4.md)
45
+
46
+
47
+ ### [nspc.Reference5](types/Misc-Group/nspc.Reference5.md)
48
+
49
+
50
+ ### [nspc.Reference6](types/Misc-Group/nspc.Reference6.md)
51
+
52
+
53
+ ### [nspc.Reference7](types/Misc-Group/nspc.Reference7.md)
54
+
55
+
56
+ ### [nspc.SampleClassWithoutModifier](types/Misc-Group/nspc.SampleClassWithoutModifier.md)
57
+
58
+
59
+ ### [nspc.SampleRestResource](types/Misc-Group/nspc.SampleRestResource.md)
60
+
61
+ Account related operations
62
+
63
+
64
+
65
+ ### [nspc.SampleRestResourceWithInnerClass](types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md)
66
+
67
+ Contact related operations
68
+
69
+
70
+
71
+ ### [nspc.SampleRestResourceWithoutApexDocs](types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md)
72
+
73
+ Order related operations
74
+
75
+
76
+ ## Main
77
+
78
+ ### [nspc.GroupedClass](types/Main/nspc.GroupedClass.md)
79
+
80
+ Uses a block style apex doc
81
+
82
+
83
+
84
+ ### [nspc.SampleClass](types/Main/nspc.SampleClass.md)
85
+
86
+ This is a class description. This class relates to [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
87
+ But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
88
+ You can also link using this syntax [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
89
+
90
+
91
+ ## Sample Interfaces
92
+
93
+ ### [nspc.SampleInterface](types/Sample-Interfaces/nspc.SampleInterface.md)
94
+
95
+ This is an interface description.
96
+
97
+
package/examples/force-app/main/default/classes/EscapedAnnotations.cls ADDED
@@ -0,0 +1,5 @@
1
+ /**
2
+ * @description This sentence has an `@embedded` annotation.
3
+ */
4
+ public with sharing class EscapedAnnotations {
5
+ }
package/examples/force-app/main/default/classes/MemberGrouping.cls CHANGED
@@ -11,6 +11,7 @@ public class MemberGrouping {
11
11
 
12
12
  /** @description Description for constant in group 2 */
13
13
  public static final String inGroup2;
14
+ /** @description Description for another constant in group 2 @future annotation */
14
15
  public static final String anotherInGroup2;
15
16
  /** @end-group */
16
17
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cparra/apexdocs",
3
- "version": "2.15.1",
3
+ "version": "2.16.1",
4
4
  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
5
  "keywords": [
6
6
  "apex",
@@ -47,9 +47,9 @@
47
47
  "eslint": "^8.0.1",
48
48
  "eslint-config-prettier": "^8.3.0",
49
49
  "eslint-plugin-prettier": "^4.0.0",
50
- "husky": "^4.2.3",
50
+ "husky": "^8.0.3",
51
51
  "jest": "^27.5.1",
52
- "lint-staged": "^12.3.7",
52
+ "lint-staged": "^13.2.1",
53
53
  "prettier": "^2.4.1",
54
54
  "rimraf": "^3.0.2",
55
55
  "ts-jest": "^27.1.3",
@@ -66,7 +66,7 @@
66
66
  ]
67
67
  },
68
68
  "dependencies": {
69
- "@cparra/apex-reflection": "2.3.1",
69
+ "@cparra/apex-reflection": "2.4.0",
70
70
  "chalk": "^4.1.2",
71
71
  "fast-xml-parser": "^4.0.1",
72
72
  "js-yaml": "^4.1.0",