@cparra/apexdocs 3.0.0 → 3.1.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 (264) hide show
  1. package/README.md +11 -5
  2. package/dist/cli/generate.js +1 -1
  3. package/dist/index.js +1 -1
  4. package/dist/logger-BATX7-be.js +3278 -0
  5. package/package.json +4 -1
  6. package/.github/workflows/ci.yaml +0 -22
  7. package/.github/workflows/close_stale.yml +0 -22
  8. package/.prettierrc.js +0 -7
  9. package/__mocks__/chalk.js +0 -12
  10. package/__mocks__/log-update.js +0 -6
  11. package/eslint.config.mjs +0 -10
  12. package/examples/README.md +0 -5
  13. package/examples/docsify/README.md +0 -17
  14. package/examples/docsify/apexdocs.config.ts +0 -13
  15. package/examples/docsify/classes/ASampleClass.cls +0 -57
  16. package/examples/docsify/classes/CodeControl.cls +0 -19
  17. package/examples/docsify/classes/SampleClass.cls +0 -95
  18. package/examples/docsify/classes/SampleInterface.cls +0 -17
  19. package/examples/docsify/classes/SomeDto.cls +0 -122
  20. package/examples/docsify/docs/.nojekyll +0 -0
  21. package/examples/docsify/docs/README.md +0 -25
  22. package/examples/docsify/docs/_config.yml +0 -1
  23. package/examples/docsify/docs/index.html +0 -22
  24. package/examples/docsify/docs/miscellaneous/ASampleClass.md +0 -88
  25. package/examples/docsify/docs/miscellaneous/CodeControl.md +0 -107
  26. package/examples/docsify/docs/miscellaneous/SomeDto.md +0 -244
  27. package/examples/docsify/docs/sample-classes/SampleClass.md +0 -171
  28. package/examples/docsify/docs/sample-interfaces/SampleInterface.md +0 -36
  29. package/examples/docsify/package-lock.json +0 -2459
  30. package/examples/docsify/package.json +0 -14
  31. package/examples/imported/.forceignore +0 -12
  32. package/examples/imported/README.md +0 -6
  33. package/examples/imported/config/project-scratch-def.json +0 -5
  34. package/examples/imported/docs/index.md +0 -109
  35. package/examples/imported/docs/miscellaneous/BaseClass.md +0 -13
  36. package/examples/imported/docs/miscellaneous/MultiInheritanceClass.md +0 -69
  37. package/examples/imported/docs/miscellaneous/ParentInterface.md +0 -12
  38. package/examples/imported/docs/miscellaneous/ReferencedEnum.md +0 -5
  39. package/examples/imported/docs/miscellaneous/SampleException.md +0 -21
  40. package/examples/imported/docs/miscellaneous/SampleInterface.md +0 -113
  41. package/examples/imported/docs/miscellaneous/Url.md +0 -308
  42. package/examples/imported/docs/sample-enums/SampleEnum.md +0 -33
  43. package/examples/imported/docs/samplegroup/SampleClass.md +0 -167
  44. package/examples/imported/force-app/classes/BaseClass.cls +0 -3
  45. package/examples/imported/force-app/classes/MultiInheritanceClass.cls +0 -1
  46. package/examples/imported/force-app/classes/ParentInterface.cls +0 -3
  47. package/examples/imported/force-app/classes/ReferencedEnum.cls +0 -3
  48. package/examples/imported/force-app/classes/SampleClass.cls +0 -72
  49. package/examples/imported/force-app/classes/SampleEnum.cls +0 -30
  50. package/examples/imported/force-app/classes/SampleException.cls +0 -17
  51. package/examples/imported/force-app/classes/SampleInterface.cls +0 -50
  52. package/examples/imported/force-app/classes/Url.cls +0 -196
  53. package/examples/imported/package-lock.json +0 -665
  54. package/examples/imported/package.json +0 -6
  55. package/examples/imported/scripts/process-docs.mjs +0 -16
  56. package/examples/imported/sfdx-project.json +0 -12
  57. package/examples/markdown/.forceignore +0 -12
  58. package/examples/markdown/README.md +0 -7
  59. package/examples/markdown/config/project-scratch-def.json +0 -5
  60. package/examples/markdown/docs/index.md +0 -109
  61. package/examples/markdown/docs/miscellaneous/BaseClass.md +0 -16
  62. package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +0 -72
  63. package/examples/markdown/docs/miscellaneous/ParentInterface.md +0 -15
  64. package/examples/markdown/docs/miscellaneous/ReferencedEnum.md +0 -8
  65. package/examples/markdown/docs/miscellaneous/SampleException.md +0 -24
  66. package/examples/markdown/docs/miscellaneous/SampleInterface.md +0 -116
  67. package/examples/markdown/docs/miscellaneous/Url.md +0 -311
  68. package/examples/markdown/docs/sample-enums/SampleEnum.md +0 -36
  69. package/examples/markdown/docs/samplegroup/SampleClass.md +0 -170
  70. package/examples/markdown/force-app/classes/BaseClass.cls +0 -3
  71. package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +0 -1
  72. package/examples/markdown/force-app/classes/ParentInterface.cls +0 -3
  73. package/examples/markdown/force-app/classes/ReferencedEnum.cls +0 -3
  74. package/examples/markdown/force-app/classes/SampleClass.cls +0 -72
  75. package/examples/markdown/force-app/classes/SampleEnum.cls +0 -30
  76. package/examples/markdown/force-app/classes/SampleException.cls +0 -17
  77. package/examples/markdown/force-app/classes/SampleInterface.cls +0 -50
  78. package/examples/markdown/force-app/classes/Url.cls +0 -196
  79. package/examples/markdown/package-lock.json +0 -665
  80. package/examples/markdown/package.json +0 -20
  81. package/examples/markdown/sfdx-project.json +0 -12
  82. package/examples/markdown-jsconfig/.forceignore +0 -12
  83. package/examples/markdown-jsconfig/README.md +0 -9
  84. package/examples/markdown-jsconfig/apexdocs.config.mjs +0 -22
  85. package/examples/markdown-jsconfig/config/project-scratch-def.json +0 -5
  86. package/examples/markdown-jsconfig/docs/index.md +0 -12
  87. package/examples/markdown-jsconfig/docs/miscellaneous/Url.md +0 -315
  88. package/examples/markdown-jsconfig/force-app/classes/Url.cls +0 -196
  89. package/examples/markdown-jsconfig/package-lock.json +0 -665
  90. package/examples/markdown-jsconfig/package.json +0 -15
  91. package/examples/markdown-jsconfig/sfdx-project.json +0 -12
  92. package/examples/open-api/README.md +0 -5
  93. package/examples/open-api/config/project-scratch-def.json +0 -13
  94. package/examples/open-api/docs/openapi.json +0 -14
  95. package/examples/open-api/force-app/main/default/classes/ChildClass.cls +0 -42
  96. package/examples/open-api/force-app/main/default/classes/SampleClass.cls +0 -167
  97. package/examples/open-api/force-app/main/default/restapi/SampleRestResource.cls +0 -195
  98. package/examples/open-api/force-app/main/default/restapi/SampleRestResourceToSkip.cls +0 -35
  99. package/examples/open-api/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +0 -24
  100. package/examples/open-api/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +0 -15
  101. package/examples/open-api/force-app/main/default/restapi/references/Reference1.cls +0 -9
  102. package/examples/open-api/force-app/main/default/restapi/references/Reference2.cls +0 -9
  103. package/examples/open-api/force-app/main/default/restapi/references/Reference3.cls +0 -3
  104. package/examples/open-api/force-app/main/default/restapi/references/Reference4.cls +0 -3
  105. package/examples/open-api/force-app/main/default/restapi/references/Reference5.cls +0 -3
  106. package/examples/open-api/force-app/main/default/restapi/references/Reference6.cls +0 -6
  107. package/examples/open-api/force-app/main/default/restapi/references/Reference7.cls +0 -3
  108. package/examples/open-api/package-lock.json +0 -724
  109. package/examples/open-api/package.json +0 -20
  110. package/examples/open-api/sfdx-project.json +0 -12
  111. package/examples/vitepress/.forceignore +0 -12
  112. package/examples/vitepress/README.md +0 -25
  113. package/examples/vitepress/apexdocs.config.ts +0 -113
  114. package/examples/vitepress/config/project-scratch-def.json +0 -13
  115. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +0 -259
  116. package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +0 -7
  117. package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +0 -40
  118. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +0 -11474
  119. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +0 -7
  120. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +0 -9172
  121. package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +0 -7
  122. package/examples/vitepress/docs/.vitepress/cache/deps/package.json +0 -3
  123. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +0 -4339
  124. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +0 -7
  125. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +0 -567
  126. package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +0 -7
  127. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +0 -323
  128. package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +0 -7
  129. package/examples/vitepress/docs/.vitepress/config.mts +0 -21
  130. package/examples/vitepress/docs/.vitepress/sidebar.json +0 -119
  131. package/examples/vitepress/docs/api-examples.md +0 -49
  132. package/examples/vitepress/docs/index-frontmatter.md +0 -16
  133. package/examples/vitepress/docs/index.md +0 -56
  134. package/examples/vitepress/docs/markdown-examples.md +0 -85
  135. package/examples/vitepress/docs/miscellaneous/BaseClass.md +0 -20
  136. package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md +0 -76
  137. package/examples/vitepress/docs/miscellaneous/ParentInterface.md +0 -19
  138. package/examples/vitepress/docs/miscellaneous/ReferencedEnum.md +0 -15
  139. package/examples/vitepress/docs/miscellaneous/SampleException.md +0 -28
  140. package/examples/vitepress/docs/miscellaneous/SampleInterface.md +0 -116
  141. package/examples/vitepress/docs/miscellaneous/Url.md +0 -317
  142. package/examples/vitepress/docs/sample-enums/SampleEnum.md +0 -40
  143. package/examples/vitepress/docs/samplegroup/SampleClass.md +0 -174
  144. package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +0 -3
  145. package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +0 -1
  146. package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +0 -3
  147. package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +0 -5
  148. package/examples/vitepress/force-app/main/default/classes/Url.cls +0 -198
  149. package/examples/vitepress/force-app/main/default/classes/feature-a/SampleClass.cls +0 -73
  150. package/examples/vitepress/force-app/main/default/classes/feature-a/SampleEnum.cls +0 -30
  151. package/examples/vitepress/force-app/main/default/classes/feature-a/SampleException.cls +0 -17
  152. package/examples/vitepress/force-app/main/default/classes/feature-a/SampleInterface.cls +0 -46
  153. package/examples/vitepress/package-lock.json +0 -2574
  154. package/examples/vitepress/package.json +0 -18
  155. package/examples/vitepress/sfdx-project.json +0 -12
  156. package/jest.config.js +0 -10
  157. package/jest.d.ts +0 -7
  158. package/src/application/Apexdocs.ts +0 -69
  159. package/src/application/__tests__/apex-file-reader.spec.ts +0 -128
  160. package/src/application/apex-file-reader.ts +0 -56
  161. package/src/application/file-system.ts +0 -69
  162. package/src/application/file-writer.ts +0 -43
  163. package/src/application/generators/markdown.ts +0 -45
  164. package/src/application/generators/openapi.ts +0 -75
  165. package/src/cli/args.ts +0 -55
  166. package/src/cli/commands/markdown.ts +0 -56
  167. package/src/cli/commands/openapi.ts +0 -36
  168. package/src/cli/generate.ts +0 -32
  169. package/src/core/__test__/manifest.spec.ts +0 -16
  170. package/src/core/manifest.ts +0 -90
  171. package/src/core/markdown/__test__/expect-extensions.ts +0 -32
  172. package/src/core/markdown/__test__/generating-class-docs.spec.ts +0 -362
  173. package/src/core/markdown/__test__/generating-docs.spec.ts +0 -378
  174. package/src/core/markdown/__test__/generating-enum-docs.spec.ts +0 -61
  175. package/src/core/markdown/__test__/generating-interface-docs.spec.ts +0 -169
  176. package/src/core/markdown/__test__/generating-reference-guide.spec.ts +0 -196
  177. package/src/core/markdown/__test__/inheritance-chain.test.ts +0 -54
  178. package/src/core/markdown/__test__/test-helpers.ts +0 -25
  179. package/src/core/markdown/adapters/__tests__/documentables.spec.ts +0 -109
  180. package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +0 -150
  181. package/src/core/markdown/adapters/__tests__/link-generator.spec.ts +0 -130
  182. package/src/core/markdown/adapters/__tests__/references.spec.ts +0 -136
  183. package/src/core/markdown/adapters/apex-types.ts +0 -238
  184. package/src/core/markdown/adapters/documentables.ts +0 -115
  185. package/src/core/markdown/adapters/fields-and-properties.ts +0 -45
  186. package/src/core/markdown/adapters/generate-link.ts +0 -82
  187. package/src/core/markdown/adapters/inline.ts +0 -143
  188. package/src/core/markdown/adapters/methods-and-constructors.ts +0 -133
  189. package/src/core/markdown/adapters/reference-guide.ts +0 -37
  190. package/src/core/markdown/adapters/renderable-bundle.ts +0 -61
  191. package/src/core/markdown/adapters/renderable-to-page-data.ts +0 -91
  192. package/src/core/markdown/adapters/type-utils.ts +0 -13
  193. package/src/core/markdown/adapters/types.d.ts +0 -180
  194. package/src/core/markdown/generate-docs.ts +0 -210
  195. package/src/core/markdown/reflection/__test__/filter-scope.spec.ts +0 -290
  196. package/src/core/markdown/reflection/__test__/helpers.ts +0 -18
  197. package/src/core/markdown/reflection/__test__/remove-excluded-tags.spec.ts +0 -200
  198. package/src/core/markdown/reflection/filter-scope.ts +0 -13
  199. package/src/core/markdown/reflection/inheritance-chain-expanion.ts +0 -22
  200. package/src/core/markdown/reflection/inheritance-chain.ts +0 -23
  201. package/src/core/markdown/reflection/inherited-member-expansion.ts +0 -105
  202. package/src/core/markdown/reflection/reflect-source.ts +0 -123
  203. package/src/core/markdown/reflection/remove-excluded-tags.ts +0 -168
  204. package/src/core/markdown/reflection/sort-types-and-members.ts +0 -61
  205. package/src/core/markdown/templates/class-template.ts +0 -75
  206. package/src/core/markdown/templates/constructors-partial-template.ts +0 -32
  207. package/src/core/markdown/templates/documentable-partial-template.ts +0 -26
  208. package/src/core/markdown/templates/enum-template.ts +0 -12
  209. package/src/core/markdown/templates/fieldsPartialTemplate.ts +0 -23
  210. package/src/core/markdown/templates/grouped-members-partial-template.ts +0 -6
  211. package/src/core/markdown/templates/hookable.ts +0 -7
  212. package/src/core/markdown/templates/interface-template.ts +0 -16
  213. package/src/core/markdown/templates/methods-partial-template.ts +0 -43
  214. package/src/core/markdown/templates/reference-guide.ts +0 -14
  215. package/src/core/markdown/templates/template.ts +0 -114
  216. package/src/core/markdown/templates/type-doc-partial.ts +0 -27
  217. package/src/core/markdown/utils.ts +0 -3
  218. package/src/core/openApiSettings.ts +0 -41
  219. package/src/core/openapi/__tests__/manifest-factory.spec.ts +0 -16
  220. package/src/core/openapi/__tests__/open-api-docs-processor.spec.ts +0 -59
  221. package/src/core/openapi/__tests__/open-api.spec.ts +0 -22
  222. package/src/core/openapi/apex-doc-types.ts +0 -26
  223. package/src/core/openapi/apex-type-wrappers/ClassMirrorWrapper.ts +0 -12
  224. package/src/core/openapi/apex-type-wrappers/MethodMirrorWrapper.ts +0 -11
  225. package/src/core/openapi/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +0 -15
  226. package/src/core/openapi/file-container.ts +0 -13
  227. package/src/core/openapi/manifest-factory.ts +0 -16
  228. package/src/core/openapi/open-api-docs-processor.ts +0 -93
  229. package/src/core/openapi/open-api-types.ts +0 -119
  230. package/src/core/openapi/open-api.ts +0 -45
  231. package/src/core/openapi/openapi-type-file.ts +0 -12
  232. package/src/core/openapi/parser.ts +0 -163
  233. package/src/core/openapi/parsers/Builder.ts +0 -40
  234. package/src/core/openapi/parsers/MethodParser.ts +0 -249
  235. package/src/core/openapi/parsers/ParameterObjectBuilder.ts +0 -13
  236. package/src/core/openapi/parsers/ReferenceBuilder.ts +0 -299
  237. package/src/core/openapi/parsers/RequestBodyBuilder.ts +0 -19
  238. package/src/core/openapi/parsers/ResponsesBuilder.ts +0 -21
  239. package/src/core/openapi/parsers/__tests__/MethodParser.spec.ts +0 -44
  240. package/src/core/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +0 -68
  241. package/src/core/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +0 -751
  242. package/src/core/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +0 -64
  243. package/src/core/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +0 -55
  244. package/src/core/openapi/transpiler.ts +0 -17
  245. package/src/core/openapi/types-repository.ts +0 -54
  246. package/src/core/parse-apex-metadata.ts +0 -30
  247. package/src/core/shared/types.d.ts +0 -150
  248. package/src/core/shared/utils.ts +0 -5
  249. package/src/defaults.ts +0 -21
  250. package/src/index.ts +0 -110
  251. package/src/test-helpers/AnnotationBuilder.ts +0 -29
  252. package/src/test-helpers/ClassMirrorBuilder.ts +0 -69
  253. package/src/test-helpers/DocCommentAnnotationBuilder.ts +0 -24
  254. package/src/test-helpers/DocCommentBuilder.ts +0 -36
  255. package/src/test-helpers/FieldMirrorBuilder.ts +0 -59
  256. package/src/test-helpers/InterfaceMirrorBuilder.ts +0 -39
  257. package/src/test-helpers/MethodMirrorBuilder.ts +0 -77
  258. package/src/test-helpers/SettingsBuilder.ts +0 -17
  259. package/src/util/error-logger.ts +0 -92
  260. package/src/util/fp.ts +0 -3
  261. package/src/util/logger.ts +0 -51
  262. package/src/util/string-utils.ts +0 -7
  263. package/tsconfig.json +0 -25
  264. package/tslint.json +0 -6
@@ -1,107 +0,0 @@
1
- # CodeControl Class
2
-
3
- ## Fields
4
- ### Picklist constant for Code_Control__mdt.Logging__c
5
- #### `LOGGING_CONTROL_NONE`
6
-
7
- ##### Signature
8
- ```apex
9
- public static final LOGGING_CONTROL_NONE
10
- ```
11
-
12
- ##### Type
13
- String
14
-
15
- ---
16
-
17
- #### `LOGGING_CONTROL_DEBUG`
18
-
19
- ##### Signature
20
- ```apex
21
- public static final LOGGING_CONTROL_DEBUG
22
- ```
23
-
24
- ##### Type
25
- String
26
-
27
- ---
28
-
29
- #### `LOGGING_CONTROL_ERROR`
30
-
31
- ##### Signature
32
- ```apex
33
- public static final LOGGING_CONTROL_ERROR
34
- ```
35
-
36
- ##### Type
37
- String
38
-
39
- ### Picklist constants for Code_Control__mdt.Enabled__c
40
- #### `TRIGGER_CONTROL_ENABLED`
41
-
42
- ##### Signature
43
- ```apex
44
- public static final TRIGGER_CONTROL_ENABLED
45
- ```
46
-
47
- ##### Type
48
- String
49
-
50
- ---
51
-
52
- #### `TRIGGER_CONTROL_DISABLED`
53
-
54
- ##### Signature
55
- ```apex
56
- public static final TRIGGER_CONTROL_DISABLED
57
- ```
58
-
59
- ##### Type
60
- String
61
-
62
- ---
63
-
64
- #### `FEATURE_CONTROL_ENABLED`
65
-
66
- ##### Signature
67
- ```apex
68
- public static final FEATURE_CONTROL_ENABLED
69
- ```
70
-
71
- ##### Type
72
- String
73
-
74
- ---
75
-
76
- #### `FEATURE_CONTROL_DISABLED`
77
-
78
- ##### Signature
79
- ```apex
80
- public static final FEATURE_CONTROL_DISABLED
81
- ```
82
-
83
- ##### Type
84
- String
85
-
86
- ### Other
87
- #### `WILDCARD_SOURCE`
88
-
89
- ##### Signature
90
- ```apex
91
- public static final WILDCARD_SOURCE
92
- ```
93
-
94
- ##### Type
95
- String
96
-
97
- ---
98
-
99
- #### `SYSTEM_WIDE_SOURCE`
100
-
101
- ##### Signature
102
- ```apex
103
- public static final SYSTEM_WIDE_SOURCE
104
- ```
105
-
106
- ##### Type
107
- String
@@ -1,244 +0,0 @@
1
- # SomeDto Class
2
-
3
- Some description
4
-
5
- **See** [ASampleClass](miscellaneous/ASampleClass.md)
6
-
7
- ## Properties
8
- ### `Items`
9
-
10
- `AURAENABLED`
11
-
12
- #### Signature
13
- ```apex
14
- public Items
15
- ```
16
-
17
- #### Type
18
- List<CartItemDto>
19
-
20
- ---
21
-
22
- ### `SubTotal`
23
-
24
- `AURAENABLED`
25
-
26
- #### Signature
27
- ```apex
28
- public SubTotal
29
- ```
30
-
31
- #### Type
32
- Decimal
33
-
34
- ---
35
-
36
- ### `Total`
37
-
38
- `AURAENABLED`
39
-
40
- #### Signature
41
- ```apex
42
- public Total
43
- ```
44
-
45
- #### Type
46
- Decimal
47
-
48
- ---
49
-
50
- ### `Discounts`
51
-
52
- `AURAENABLED`
53
-
54
- #### Signature
55
- ```apex
56
- public Discounts
57
- ```
58
-
59
- #### Type
60
- Decimal
61
-
62
- ## Constructors
63
- ### `SomeDto(proForma)`
64
-
65
- Constructs a CartDto
66
-
67
- #### Signature
68
- ```apex
69
- public SomeDto(nams.Order proForma)
70
- ```
71
-
72
- #### Parameters
73
- | Name | Type | Description |
74
- |------|------|-------------|
75
- | proForma | nams.Order | The pro forma |
76
-
77
- ## Classes
78
- ### CartItemDto Class
79
-
80
- Used in cartItem.html
81
-
82
- #### Properties
83
- ##### `Id`
84
-
85
- `AURAENABLED`
86
-
87
- Id Unique identifier for this object.
88
-
89
- ###### Signature
90
- ```apex
91
- public Id
92
- ```
93
-
94
- ###### Type
95
- String
96
-
97
- ---
98
-
99
- ##### `Description`
100
-
101
- `AURAENABLED`
102
-
103
- Description The description to display for this item.
104
-
105
- ###### Signature
106
- ```apex
107
- public Description
108
- ```
109
-
110
- ###### Type
111
- String
112
-
113
- ---
114
-
115
- ##### `Quantity`
116
-
117
- `AURAENABLED`
118
-
119
- Quantity Amount of this item currently in the cart.
120
-
121
- ###### Signature
122
- ```apex
123
- public Quantity
124
- ```
125
-
126
- ###### Type
127
- Decimal
128
-
129
- ---
130
-
131
- ##### `Price`
132
-
133
- `AURAENABLED`
134
-
135
- Price Calculated price for this item.
136
-
137
- ###### Signature
138
- ```apex
139
- public Price
140
- ```
141
-
142
- ###### Type
143
- Decimal
144
-
145
- ---
146
-
147
- ##### `CurrencyCode`
148
-
149
- `AURAENABLED`
150
-
151
- The currency code for this item.
152
-
153
- ###### Signature
154
- ```apex
155
- public CurrencyCode
156
- ```
157
-
158
- ###### Type
159
- String
160
-
161
- ---
162
-
163
- ##### `ProductImage`
164
-
165
- `AURAENABLED`
166
-
167
- ProductImage Main display image to display for this item.
168
-
169
- ###### Signature
170
- ```apex
171
- public ProductImage
172
- ```
173
-
174
- ###### Type
175
- String
176
-
177
- ---
178
-
179
- ##### `IsDiscounted`
180
-
181
- `AURAENABLED`
182
-
183
- IsDiscounted Whether the item has been discounted or not.
184
-
185
- ###### Signature
186
- ```apex
187
- public IsDiscounted
188
- ```
189
-
190
- ###### Type
191
- Boolean
192
-
193
- ---
194
-
195
- ##### `AdjustedPrice`
196
-
197
- `AURAENABLED`
198
-
199
- AdjustedPrice If the item has been discounted, this contains the adjusted (lower) price.
200
-
201
- ###### Signature
202
- ```apex
203
- public AdjustedPrice
204
- ```
205
-
206
- ###### Type
207
- Decimal
208
-
209
- ---
210
-
211
- ##### `DiscountReason`
212
-
213
- `AURAENABLED`
214
-
215
- DiscountReason If the item has been discounted, this contains a human-readable reason for the discount.
216
-
217
- ###### Signature
218
- ```apex
219
- public DiscountReason
220
- ```
221
-
222
- ###### Type
223
- String
224
-
225
- #### Constructors
226
- ##### `CartItemDto(id, description, quantity, price, currencyCode, productImage, isDiscounted, adjustedAmount, discountReason)`
227
-
228
- ###### Signature
229
- ```apex
230
- public CartItemDto(String id, String description, Decimal quantity, Decimal price, String currencyCode, String productImage, Boolean isDiscounted, Decimal adjustedAmount, String discountReason)
231
- ```
232
-
233
- ###### Parameters
234
- | Name | Type | Description |
235
- |------|------|-------------|
236
- | id | String | |
237
- | description | String | |
238
- | quantity | Decimal | |
239
- | price | Decimal | |
240
- | currencyCode | String | |
241
- | productImage | String | |
242
- | isDiscounted | Boolean | |
243
- | adjustedAmount | Decimal | |
244
- | discountReason | String | |
@@ -1,171 +0,0 @@
1
- # SampleClass Class
2
-
3
- `NAMESPACEACCESSIBLE`
4
-
5
- This is a class description.
6
-
7
- **Group** Sample Classes
8
-
9
- **See** [SampleInterface](sample-interfaces/SampleInterface.md)
10
-
11
- ## Properties
12
- ### `MyProp`
13
-
14
- This is a String property.
15
-
16
- #### Signature
17
- ```apex
18
- public MyProp
19
- ```
20
-
21
- #### Type
22
- String
23
-
24
- ---
25
-
26
- ### `AnotherProp`
27
-
28
- This is a Decimal property.
29
-
30
- #### Signature
31
- ```apex
32
- public AnotherProp
33
- ```
34
-
35
- #### Type
36
- Decimal
37
-
38
- ## Constructors
39
- ### `SampleClass()`
40
-
41
- `NAMESPACEACCESSIBLE`
42
-
43
- Constructs a SampleClass without any arguments.
44
-
45
- #### Signature
46
- ```apex
47
- public SampleClass()
48
- ```
49
-
50
- #### Example
51
- ```apex
52
- SampleClass sampleInstance = new SampleClass();
53
- ```
54
-
55
- ---
56
-
57
- ### `SampleClass(argument)`
58
-
59
- Constructs a SampleClass with an argument.
60
-
61
- #### Signature
62
- ```apex
63
- public SampleClass(String argument)
64
- ```
65
-
66
- #### Parameters
67
- | Name | Type | Description |
68
- |------|------|-------------|
69
- | argument | String | Some argument |
70
-
71
- ## Methods
72
- ### `someTestMethod(argument)`
73
-
74
- `NAMESPACEACCESSIBLE`
75
-
76
- Executes commands based on the passed in argument.
77
-
78
- #### Signature
79
- ```apex
80
- public static String someTestMethod(String argument)
81
- ```
82
-
83
- #### Parameters
84
- | Name | Type | Description |
85
- |------|------|-------------|
86
- | argument | String | |
87
-
88
- #### Return Type
89
- **String**
90
-
91
- #### Example
92
- ```apex
93
- String result = SampleClass.testMethod();
94
- System.debug(result);
95
- ```
96
-
97
- ---
98
-
99
- ### `call()`
100
-
101
- Calls the method.
102
- This methods allows you to call it.
103
-
104
- #### Signature
105
- ```apex
106
- public static void call()
107
- ```
108
-
109
- #### Return Type
110
- **void**
111
-
112
- ## Classes
113
- ### InnerClass Class
114
-
115
- Inner class belonging to SampleClass.
116
-
117
- #### Properties
118
- ##### `InnerProp`
119
-
120
- Description of the inner property.
121
-
122
- ###### Signature
123
- ```apex
124
- public InnerProp
125
- ```
126
-
127
- ###### Type
128
- String
129
-
130
- #### Methods
131
- ##### `innerMethod()`
132
-
133
- Executes from the inner class.
134
-
135
- ###### Signature
136
- ```apex
137
- public void innerMethod()
138
- ```
139
-
140
- ###### Return Type
141
- **void**
142
-
143
- ### AnotherInnerClass Class
144
-
145
- Inner class belonging to SampleClass.
146
-
147
- #### Properties
148
- ##### `InnerProp`
149
-
150
- Description of the inner property.
151
-
152
- ###### Signature
153
- ```apex
154
- public InnerProp
155
- ```
156
-
157
- ###### Type
158
- String
159
-
160
- #### Methods
161
- ##### `innerMethod()`
162
-
163
- Executes from the inner class.
164
-
165
- ###### Signature
166
- ```apex
167
- public void innerMethod()
168
- ```
169
-
170
- ###### Return Type
171
- **void**
@@ -1,36 +0,0 @@
1
- # SampleInterface Interface
2
-
3
- This is an interface description.
4
-
5
- **Group** Sample Interfaces
6
-
7
- **See** [SampleClass](sample-classes/SampleClass.md)
8
-
9
- ## Methods
10
- ### `execute()`
11
-
12
- Executes the command.
13
-
14
- #### Signature
15
- ```apex
16
- public void execute()
17
- ```
18
-
19
- #### Return Type
20
- **void**
21
-
22
- ---
23
-
24
- ### `getValue()`
25
-
26
- Returns a value based on the executed command.
27
-
28
- #### Signature
29
- ```apex
30
- public String getValue()
31
- ```
32
-
33
- #### Return Type
34
- **String**
35
-
36
- Empty value