@cparra/apexdocs 2.25.0-alpha.1 → 2.25.0-alpha.3

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 (393) hide show
  1. package/README.md +37 -0
  2. package/{lib → dist}/__spec__/core/expect-extensions.js +3 -2
  3. package/dist/__spec__/core/expect-extensions.js.map +1 -0
  4. package/{lib → dist}/__spec__/core/generating-class-docs.spec.js +54 -37
  5. package/dist/__spec__/core/generating-class-docs.spec.js.map +1 -0
  6. package/{lib → dist}/__spec__/core/generating-enum-docs.spec.js +25 -22
  7. package/dist/__spec__/core/generating-enum-docs.spec.js.map +1 -0
  8. package/{lib → dist}/__spec__/core/generating-interface-docs.spec.js +33 -30
  9. package/dist/__spec__/core/generating-interface-docs.spec.js.map +1 -0
  10. package/{lib → dist}/__spec__/core/generating-reference-guide.spec.js +8 -7
  11. package/dist/__spec__/core/generating-reference-guide.spec.js.map +1 -0
  12. package/dist/__spec__/core/test-helpers.d.ts +2 -0
  13. package/dist/__spec__/core/test-helpers.js +12 -0
  14. package/dist/__spec__/core/test-helpers.js.map +1 -0
  15. package/{lib → dist}/application/Apexdocs.d.ts +4 -2
  16. package/{lib → dist}/application/Apexdocs.js +49 -16
  17. package/dist/application/Apexdocs.js.map +1 -0
  18. package/dist/application/generators/generate-markdown-files.d.ts +3 -0
  19. package/dist/application/generators/generate-markdown-files.js +64 -0
  20. package/dist/application/generators/generate-markdown-files.js.map +1 -0
  21. package/dist/cli/args.d.ts +39 -0
  22. package/{lib/cli/generate.js → dist/cli/args.js} +37 -40
  23. package/dist/cli/args.js.map +1 -0
  24. package/dist/cli/generate.js +291 -0
  25. package/dist/cli/generate.js.map +1 -0
  26. package/dist/core/__test__/inheritance-chain.test.d.ts +1 -0
  27. package/dist/core/__test__/inheritance-chain.test.js +42 -0
  28. package/dist/core/__test__/inheritance-chain.test.js.map +1 -0
  29. package/dist/core/adapters/apex-types.d.ts +6 -0
  30. package/{lib → dist/core}/adapters/apex-types.js +18 -21
  31. package/dist/core/adapters/apex-types.js.map +1 -0
  32. package/{lib → dist/core}/adapters/documentables.d.ts +1 -1
  33. package/dist/core/adapters/documentables.js +154 -0
  34. package/dist/core/adapters/documentables.js.map +1 -0
  35. package/{lib → dist/core}/adapters/fields-and-properties.d.ts +1 -2
  36. package/{lib → dist/core}/adapters/fields-and-properties.js +11 -6
  37. package/dist/core/adapters/fields-and-properties.js.map +1 -0
  38. package/{lib → dist/core}/adapters/methods-and-constructors.d.ts +1 -1
  39. package/{lib → dist/core}/adapters/methods-and-constructors.js +24 -16
  40. package/dist/core/adapters/methods-and-constructors.js.map +1 -0
  41. package/{lib → dist/core}/adapters/references.d.ts +2 -3
  42. package/{lib → dist/core}/adapters/references.js +5 -9
  43. package/dist/core/adapters/references.js.map +1 -0
  44. package/dist/core/adapters/type-utils.d.ts +3 -0
  45. package/dist/core/adapters/type-utils.js +12 -0
  46. package/dist/core/adapters/type-utils.js.map +1 -0
  47. package/dist/core/apex-bundle.js.map +1 -0
  48. package/{lib → dist}/core/generate-docs.d.ts +8 -3
  49. package/{lib → dist}/core/generate-docs.js +79 -24
  50. package/dist/core/generate-docs.js.map +1 -0
  51. package/dist/core/inheritance-chain.d.ts +2 -0
  52. package/{lib/index.js → dist/core/inheritance-chain.js} +11 -4
  53. package/dist/core/inheritance-chain.js.map +1 -0
  54. package/dist/core/manifest.js.map +1 -0
  55. package/{lib → dist}/core/template.js +12 -7
  56. package/{lib → dist}/core/template.js.map +1 -1
  57. package/{lib → dist}/core/templates/reference-guide.js +1 -1
  58. package/dist/index.d.ts +2 -0
  59. package/dist/index.js +1 -0
  60. package/{lib → dist}/model/markdown-file.d.ts +1 -1
  61. package/{lib → dist}/model/markdown-file.js +1 -1
  62. package/dist/model/markdown-file.js.map +1 -0
  63. package/{lib → dist}/model/markdown-generation-util/doc-comment-annotation-util.js +3 -2
  64. package/dist/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -0
  65. package/{lib → dist}/model/markdown-generation-util/field-declaration-util.d.ts +1 -1
  66. package/{lib → dist}/model/markdown-generation-util/field-declaration-util.js +2 -1
  67. package/dist/model/markdown-generation-util/field-declaration-util.js.map +1 -0
  68. package/{lib → dist}/model/markdown-generation-util/method-declaration-util.d.ts +1 -1
  69. package/{lib → dist}/model/markdown-generation-util/method-declaration-util.js +2 -1
  70. package/dist/model/markdown-generation-util/method-declaration-util.js.map +1 -0
  71. package/{lib → dist}/model/markdown-generation-util/type-declaration-util.js +2 -1
  72. package/dist/model/markdown-generation-util/type-declaration-util.js.map +1 -0
  73. package/{lib → dist}/model/markdown-type-file.d.ts +1 -1
  74. package/dist/model/markdown-type-file.js.map +1 -0
  75. package/{lib → dist}/service/apex-file-reader.d.ts +1 -1
  76. package/{lib → dist}/service/apex-file-reader.js +1 -1
  77. package/{lib → dist}/service/apex-file-reader.js.map +1 -1
  78. package/{lib → dist}/service/manifest-factory.d.ts +2 -2
  79. package/{lib → dist}/service/manifest-factory.js +3 -2
  80. package/dist/service/manifest-factory.js.map +1 -0
  81. package/{lib → dist}/service/parser.d.ts +1 -1
  82. package/{lib → dist}/settings.d.ts +3 -0
  83. package/{lib → dist}/settings.js +3 -0
  84. package/{lib → dist}/settings.js.map +1 -1
  85. package/{lib → dist}/test-helpers/ClassMirrorBuilder.d.ts +4 -0
  86. package/{lib → dist}/test-helpers/ClassMirrorBuilder.js +11 -1
  87. package/dist/test-helpers/ClassMirrorBuilder.js.map +1 -0
  88. package/{lib → dist}/test-helpers/SettingsBuilder.js +1 -0
  89. package/{lib → dist}/test-helpers/SettingsBuilder.js.map +1 -1
  90. package/{lib → dist}/transpiler/factory.js +2 -4
  91. package/dist/transpiler/factory.js.map +1 -0
  92. package/{lib → dist}/transpiler/markdown/class-file-generatorHelper.d.ts +0 -2
  93. package/{lib → dist}/transpiler/markdown/class-file-generatorHelper.js +1 -15
  94. package/dist/transpiler/markdown/class-file-generatorHelper.js.map +1 -0
  95. package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.js +3 -3
  96. package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.js +1 -1
  97. package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.js +6 -4
  98. package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -1
  99. package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +1 -1
  100. package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.js +2 -2
  101. package/{lib → dist}/util/logger.js +1 -1
  102. package/{lib → dist}/util/logger.js.map +1 -1
  103. package/{lib → dist}/util/string-utils.js +2 -2
  104. package/{lib → dist}/util/string-utils.js.map +1 -1
  105. package/examples/plain-markdown/docs/Miscellaneous/ns.MultiInheritanceClass.md +73 -0
  106. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +19 -1
  107. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +6 -2
  108. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +3 -1
  109. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +2 -2
  110. package/examples/plain-markdown/docs/index.md +12 -13
  111. package/examples/plain-markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
  112. package/examples/plain-markdown/force-app/classes/SampleException.cls +16 -0
  113. package/jest.config.js +1 -1
  114. package/package.json +13 -15
  115. package/src/__spec__/core/generating-class-docs.spec.ts +57 -37
  116. package/src/__spec__/core/generating-enum-docs.spec.ts +25 -22
  117. package/src/__spec__/core/generating-interface-docs.spec.ts +33 -30
  118. package/src/__spec__/core/generating-reference-guide.spec.ts +8 -7
  119. package/src/__spec__/core/test-helpers.ts +9 -0
  120. package/src/application/Apexdocs.ts +56 -19
  121. package/src/application/generators/generate-markdown-files.ts +53 -0
  122. package/src/cli/args.ts +136 -0
  123. package/src/cli/generate.ts +11 -135
  124. package/src/core/__test__/inheritance-chain.test.ts +54 -0
  125. package/src/{adapters → core/adapters}/__tests__/interface-adapter.spec.ts +13 -11
  126. package/src/{adapters → core/adapters}/__tests__/references.spec.ts +11 -1
  127. package/src/{adapters → core/adapters}/apex-types.ts +54 -44
  128. package/src/core/adapters/documentables.ts +195 -0
  129. package/src/{adapters → core/adapters}/fields-and-properties.ts +13 -11
  130. package/src/{adapters → core/adapters}/methods-and-constructors.ts +31 -20
  131. package/src/{adapters → core/adapters}/references.ts +3 -6
  132. package/src/core/adapters/type-utils.ts +9 -0
  133. package/src/core/{renderable → adapters}/types.d.ts +36 -5
  134. package/src/core/generate-docs.ts +106 -31
  135. package/src/core/inheritance-chain.ts +23 -0
  136. package/src/core/template.ts +12 -9
  137. package/src/core/templates/reference-guide.ts +1 -1
  138. package/src/model/__tests__/manifest.spec.ts +1 -1
  139. package/src/model/markdown-file.ts +1 -1
  140. package/src/model/markdown-generation-util/field-declaration-util.ts +1 -1
  141. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  142. package/src/model/markdown-type-file.ts +5 -1
  143. package/src/service/__tests__/apex-file-reader.spec.ts +1 -0
  144. package/src/service/apex-file-reader.ts +1 -1
  145. package/src/service/manifest-factory.ts +2 -2
  146. package/src/service/parser.ts +1 -1
  147. package/src/settings.ts +6 -0
  148. package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
  149. package/src/test-helpers/SettingsBuilder.ts +1 -0
  150. package/src/transpiler/factory.ts +2 -4
  151. package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -18
  152. package/src/transpiler/markdown/plain-markdown/class-template.ts +3 -3
  153. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +1 -1
  154. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +6 -4
  155. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +1 -1
  156. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +2 -2
  157. package/src/util/logger.ts +1 -1
  158. package/tsconfig.json +1 -1
  159. package/docs/.nojekyll +0 -0
  160. package/docs/__old/README.md +0 -1
  161. package/docs/__old/index.html +0 -22
  162. package/docs/__old/restapi.json +0 -589
  163. package/docs/__old/types/Classes/nspc.AnotherInterface.md +0 -22
  164. package/docs/__old/types/Classes/nspc.ChildClass.md +0 -97
  165. package/docs/__old/types/Main/nspc.GroupedClass.md +0 -10
  166. package/docs/__old/types/Main/nspc.SampleClass.md +0 -189
  167. package/docs/__old/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
  168. package/docs/__old/types/Misc-Group/nspc.GrandparentClass.md +0 -13
  169. package/docs/__old/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
  170. package/docs/__old/types/Misc-Group/nspc.MemberGrouping.md +0 -13
  171. package/docs/__old/types/Misc-Group/nspc.ParentClass.md +0 -37
  172. package/docs/__old/types/Misc-Group/nspc.Reference1.md +0 -18
  173. package/docs/__old/types/Misc-Group/nspc.Reference2.md +0 -12
  174. package/docs/__old/types/Misc-Group/nspc.Reference3.md +0 -7
  175. package/docs/__old/types/Misc-Group/nspc.Reference4.md +0 -7
  176. package/docs/__old/types/Misc-Group/nspc.Reference5.md +0 -7
  177. package/docs/__old/types/Misc-Group/nspc.Reference6.md +0 -9
  178. package/docs/__old/types/Misc-Group/nspc.Reference7.md +0 -7
  179. package/docs/__old/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
  180. package/docs/__old/types/Misc-Group/nspc.SampleRestResource.md +0 -104
  181. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -33
  182. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
  183. package/docs/__old/types/README.md +0 -97
  184. package/docs/__old/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
  185. package/examples/includes/header.md +0 -3
  186. package/lib/__spec__/core/expect-extensions.js.map +0 -1
  187. package/lib/__spec__/core/generating-class-docs.spec.js.map +0 -1
  188. package/lib/__spec__/core/generating-enum-docs.spec.js.map +0 -1
  189. package/lib/__spec__/core/generating-interface-docs.spec.js.map +0 -1
  190. package/lib/__spec__/core/generating-reference-guide.spec.js.map +0 -1
  191. package/lib/adapters/apex-types.d.ts +0 -7
  192. package/lib/adapters/apex-types.js.map +0 -1
  193. package/lib/adapters/documentables.js +0 -56
  194. package/lib/adapters/documentables.js.map +0 -1
  195. package/lib/adapters/fields-and-properties.js.map +0 -1
  196. package/lib/adapters/methods-and-constructors.js.map +0 -1
  197. package/lib/adapters/references.js.map +0 -1
  198. package/lib/adapters/type-utils.d.ts +0 -2
  199. package/lib/adapters/type-utils.js +0 -7
  200. package/lib/adapters/type-utils.js.map +0 -1
  201. package/lib/application/Apexdocs.js.map +0 -1
  202. package/lib/cli/generate.js.map +0 -1
  203. package/lib/core/generate-docs.js.map +0 -1
  204. package/lib/index.d.ts +0 -2
  205. package/lib/model/apex-bundle.js.map +0 -1
  206. package/lib/model/inheritance.d.ts +0 -8
  207. package/lib/model/inheritance.js +0 -3
  208. package/lib/model/inheritance.js.map +0 -1
  209. package/lib/model/manifest.js.map +0 -1
  210. package/lib/model/markdown-file.js.map +0 -1
  211. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
  212. package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
  213. package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
  214. package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
  215. package/lib/model/markdown-type-file.js.map +0 -1
  216. package/lib/service/manifest-factory.js.map +0 -1
  217. package/lib/test-helpers/ClassMirrorBuilder.js.map +0 -1
  218. package/lib/transpiler/factory.js.map +0 -1
  219. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
  220. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -9
  221. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -42
  222. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
  223. package/src/adapters/documentables.ts +0 -93
  224. package/src/adapters/type-utils.ts +0 -5
  225. package/src/adapters/types.d.ts +0 -8
  226. package/src/model/inheritance.ts +0 -7
  227. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -42
  228. /package/{lib → dist}/__spec__/core/expect-extensions.d.ts +0 -0
  229. /package/{lib → dist}/__spec__/core/generating-class-docs.spec.d.ts +0 -0
  230. /package/{lib → dist}/__spec__/core/generating-enum-docs.spec.d.ts +0 -0
  231. /package/{lib → dist}/__spec__/core/generating-interface-docs.spec.d.ts +0 -0
  232. /package/{lib → dist}/__spec__/core/generating-reference-guide.spec.d.ts +0 -0
  233. /package/{lib → dist}/cli/generate.d.ts +0 -0
  234. /package/{lib/model → dist/core}/apex-bundle.d.ts +0 -0
  235. /package/{lib/model → dist/core}/apex-bundle.js +0 -0
  236. /package/{lib/model → dist/core}/manifest.d.ts +0 -0
  237. /package/{lib/model → dist/core}/manifest.js +0 -0
  238. /package/{lib → dist}/core/template.d.ts +0 -0
  239. /package/{lib → dist}/core/templates/reference-guide.d.ts +0 -0
  240. /package/{lib → dist}/core/templates/reference-guide.js.map +0 -0
  241. /package/{lib → dist}/index.js.map +0 -0
  242. /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -0
  243. /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -0
  244. /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -0
  245. /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -0
  246. /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -0
  247. /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -0
  248. /package/{lib → dist}/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -0
  249. /package/{lib → dist}/model/markdown-generation-util/index.d.ts +0 -0
  250. /package/{lib → dist}/model/markdown-generation-util/index.js +0 -0
  251. /package/{lib → dist}/model/markdown-generation-util/index.js.map +0 -0
  252. /package/{lib → dist}/model/markdown-generation-util/type-declaration-util.d.ts +0 -0
  253. /package/{lib → dist}/model/markdown-home-file.d.ts +0 -0
  254. /package/{lib → dist}/model/markdown-home-file.js +0 -0
  255. /package/{lib → dist}/model/markdown-home-file.js.map +0 -0
  256. /package/{lib → dist}/model/markdown-type-file.js +0 -0
  257. /package/{lib → dist}/model/openapi/apex-doc-types.d.ts +0 -0
  258. /package/{lib → dist}/model/openapi/apex-doc-types.js +0 -0
  259. /package/{lib → dist}/model/openapi/apex-doc-types.js.map +0 -0
  260. /package/{lib → dist}/model/openapi/open-api-types.d.ts +0 -0
  261. /package/{lib → dist}/model/openapi/open-api-types.js +0 -0
  262. /package/{lib → dist}/model/openapi/open-api-types.js.map +0 -0
  263. /package/{lib → dist}/model/openapi/open-api.d.ts +0 -0
  264. /package/{lib → dist}/model/openapi/open-api.js +0 -0
  265. /package/{lib → dist}/model/openapi/open-api.js.map +0 -0
  266. /package/{lib → dist}/model/openapi/openapi-type-file.d.ts +0 -0
  267. /package/{lib → dist}/model/openapi/openapi-type-file.js +0 -0
  268. /package/{lib → dist}/model/openapi/openapi-type-file.js.map +0 -0
  269. /package/{lib → dist}/model/outputFile.d.ts +0 -0
  270. /package/{lib → dist}/model/outputFile.js +0 -0
  271. /package/{lib → dist}/model/outputFile.js.map +0 -0
  272. /package/{lib → dist}/model/types-repository.d.ts +0 -0
  273. /package/{lib → dist}/model/types-repository.js +0 -0
  274. /package/{lib → dist}/model/types-repository.js.map +0 -0
  275. /package/{lib → dist}/service/file-system.d.ts +0 -0
  276. /package/{lib → dist}/service/file-system.js +0 -0
  277. /package/{lib → dist}/service/file-system.js.map +0 -0
  278. /package/{lib → dist}/service/file-writer.d.ts +0 -0
  279. /package/{lib → dist}/service/file-writer.js +0 -0
  280. /package/{lib → dist}/service/file-writer.js.map +0 -0
  281. /package/{lib → dist}/service/metadata-processor.d.ts +0 -0
  282. /package/{lib → dist}/service/metadata-processor.js +0 -0
  283. /package/{lib → dist}/service/metadata-processor.js.map +0 -0
  284. /package/{lib → dist}/service/parser.js +0 -0
  285. /package/{lib → dist}/service/parser.js.map +0 -0
  286. /package/{lib → dist}/service/state.d.ts +0 -0
  287. /package/{lib → dist}/service/state.js +0 -0
  288. /package/{lib → dist}/service/state.js.map +0 -0
  289. /package/{lib → dist}/service/walkers/class-walker.d.ts +0 -0
  290. /package/{lib → dist}/service/walkers/class-walker.js +0 -0
  291. /package/{lib → dist}/service/walkers/class-walker.js.map +0 -0
  292. /package/{lib → dist}/service/walkers/enum-walker.d.ts +0 -0
  293. /package/{lib → dist}/service/walkers/enum-walker.js +0 -0
  294. /package/{lib → dist}/service/walkers/enum-walker.js.map +0 -0
  295. /package/{lib → dist}/service/walkers/interface-walker.d.ts +0 -0
  296. /package/{lib → dist}/service/walkers/interface-walker.js +0 -0
  297. /package/{lib → dist}/service/walkers/interface-walker.js.map +0 -0
  298. /package/{lib → dist}/service/walkers/walker-factory.d.ts +0 -0
  299. /package/{lib → dist}/service/walkers/walker-factory.js +0 -0
  300. /package/{lib → dist}/service/walkers/walker-factory.js.map +0 -0
  301. /package/{lib → dist}/service/walkers/walker.d.ts +0 -0
  302. /package/{lib → dist}/service/walkers/walker.js +0 -0
  303. /package/{lib → dist}/service/walkers/walker.js.map +0 -0
  304. /package/{lib → dist}/test-helpers/AnnotationBuilder.d.ts +0 -0
  305. /package/{lib → dist}/test-helpers/AnnotationBuilder.js +0 -0
  306. /package/{lib → dist}/test-helpers/AnnotationBuilder.js.map +0 -0
  307. /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -0
  308. /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.js +0 -0
  309. /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.js.map +0 -0
  310. /package/{lib → dist}/test-helpers/DocCommentBuilder.d.ts +0 -0
  311. /package/{lib → dist}/test-helpers/DocCommentBuilder.js +0 -0
  312. /package/{lib → dist}/test-helpers/DocCommentBuilder.js.map +0 -0
  313. /package/{lib → dist}/test-helpers/FieldMirrorBuilder.d.ts +0 -0
  314. /package/{lib → dist}/test-helpers/FieldMirrorBuilder.js +0 -0
  315. /package/{lib → dist}/test-helpers/FieldMirrorBuilder.js.map +0 -0
  316. /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.d.ts +0 -0
  317. /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.js +0 -0
  318. /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.js.map +0 -0
  319. /package/{lib → dist}/test-helpers/MethodMirrorBuilder.d.ts +0 -0
  320. /package/{lib → dist}/test-helpers/MethodMirrorBuilder.js +0 -0
  321. /package/{lib → dist}/test-helpers/MethodMirrorBuilder.js.map +0 -0
  322. /package/{lib → dist}/test-helpers/SettingsBuilder.d.ts +0 -0
  323. /package/{lib → dist}/transpiler/factory.d.ts +0 -0
  324. /package/{lib → dist}/transpiler/file-container.d.ts +0 -0
  325. /package/{lib → dist}/transpiler/file-container.js +0 -0
  326. /package/{lib → dist}/transpiler/file-container.js.map +0 -0
  327. /package/{lib → dist}/transpiler/generator-choices.d.ts +0 -0
  328. /package/{lib → dist}/transpiler/generator-choices.js +0 -0
  329. /package/{lib → dist}/transpiler/generator-choices.js.map +0 -0
  330. /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -0
  331. /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.js +0 -0
  332. /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -0
  333. /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -0
  334. /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -0
  335. /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -0
  336. /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.d.ts +0 -0
  337. /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.js +0 -0
  338. /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.js.map +0 -0
  339. /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.d.ts +0 -0
  340. /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.js.map +0 -0
  341. /package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -0
  342. /package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -0
  343. /package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -0
  344. /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -0
  345. /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.js +0 -0
  346. /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.js.map +0 -0
  347. /package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -0
  348. /package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -0
  349. /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -0
  350. /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -0
  351. /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -0
  352. /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -0
  353. /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.js +0 -0
  354. /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.js.map +0 -0
  355. /package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -0
  356. /package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -0
  357. /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -0
  358. /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -0
  359. /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -0
  360. /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.d.ts +0 -0
  361. /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.js +0 -0
  362. /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.js.map +0 -0
  363. /package/{lib → dist}/transpiler/openapi/parsers/Builder.d.ts +0 -0
  364. /package/{lib → dist}/transpiler/openapi/parsers/Builder.js +0 -0
  365. /package/{lib → dist}/transpiler/openapi/parsers/Builder.js.map +0 -0
  366. /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.d.ts +0 -0
  367. /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.js +0 -0
  368. /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.js.map +0 -0
  369. /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -0
  370. /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -0
  371. /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -0
  372. /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -0
  373. /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.js +0 -0
  374. /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -0
  375. /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -0
  376. /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -0
  377. /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -0
  378. /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -0
  379. /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.js +0 -0
  380. /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -0
  381. /package/{lib → dist}/transpiler/processor-type-transpiler.d.ts +0 -0
  382. /package/{lib → dist}/transpiler/processor-type-transpiler.js +0 -0
  383. /package/{lib → dist}/transpiler/processor-type-transpiler.js.map +0 -0
  384. /package/{lib → dist}/transpiler/transpiler.d.ts +0 -0
  385. /package/{lib → dist}/transpiler/transpiler.js +0 -0
  386. /package/{lib → dist}/transpiler/transpiler.js.map +0 -0
  387. /package/{lib → dist}/util/error-logger.d.ts +0 -0
  388. /package/{lib → dist}/util/error-logger.js +0 -0
  389. /package/{lib → dist}/util/error-logger.js.map +0 -0
  390. /package/{lib → dist}/util/logger.d.ts +0 -0
  391. /package/{lib → dist}/util/string-utils.d.ts +0 -0
  392. /package/src/{model → core}/apex-bundle.ts +0 -0
  393. /package/src/{model → core}/manifest.ts +0 -0
@@ -9,9 +9,9 @@ exports.classMarkdownTemplate = `
9
9
 
10
10
  {{> typeDocumentation}}
11
11
 
12
- {{#if extends}}
13
- **Extends**
14
- {{link extends}}
12
+ {{#if extends.length}}
13
+ **Inheritance**
14
+ {{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
15
15
  {{/if}}
16
16
 
17
17
  {{#if implements}}
@@ -9,7 +9,7 @@ exports.constructorsPartialTemplate = `
9
9
  {{#> documentablePartialTemplate}}
10
10
 
11
11
  {{ heading signature.headingLevel signature.heading }}
12
- {{ code "apex" signature.value }}
12
+ {{ code signature.value }}
13
13
 
14
14
  {{#if parameters.value}}
15
15
  {{ heading parameters.headingLevel parameters.heading }}
@@ -6,10 +6,12 @@ exports.documentablePartialTemplate = `
6
6
  \`{{this}}\`
7
7
  {{/each}}
8
8
 
9
- {{withLinks doc.description}}
9
+ {{{renderContent doc.description}}}
10
10
 
11
11
  {{#each doc.customTags}}
12
- **{{splitAndCapitalize name}}** {{withLinks description}}
12
+ **{{splitAndCapitalize name}}**
13
+
14
+ {{{renderContent description}}}
13
15
 
14
16
  {{/each}}
15
17
 
@@ -17,12 +19,12 @@ exports.documentablePartialTemplate = `
17
19
 
18
20
  {{#if doc.mermaid.value}}
19
21
  {{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
20
- {{code "mermaid" doc.mermaid.value}}
22
+ {{code doc.mermaid.value}}
21
23
  {{/if}}
22
24
 
23
25
  {{#if doc.example.value}}
24
26
  {{ heading doc.example.headingLevel doc.example.heading }}
25
- {{code "apex" doc.example.value}}
27
+ {{code doc.example.value}}
26
28
  {{/if}}
27
29
  `.trim();
28
30
  //# sourceMappingURL=documentable-partial-template.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;CAuB1C,CAAC,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"documentable-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/documentable-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;CAyB1C,CAAC,IAAI,EAAE,CAAC"}
@@ -13,7 +13,7 @@ exports.fieldsPartialTemplate = `
13
13
  {{#> documentablePartialTemplate }}
14
14
 
15
15
  {{ heading signature.headingLevel signature.heading }}
16
- {{ code "apex" signature.value }}
16
+ {{ code signature.value }}
17
17
 
18
18
  {{ heading type.headingLevel type.heading }}
19
19
  {{link type.value}}
@@ -13,14 +13,14 @@ exports.methodsPartialTemplate = `
13
13
  {{#> documentablePartialTemplate}}
14
14
 
15
15
  {{ heading signature.headingLevel signature.heading }}
16
- {{ code "apex" signature.value }}
16
+ {{ code signature.value }}
17
17
 
18
18
  {{#if parameters.value}}
19
19
  {{ heading parameters.headingLevel parameters.heading }}
20
20
  | Name | Type | Description |
21
21
  |------|------|-------------|
22
22
  {{#each parameters.value}}
23
- | {{name}} | {{link type}} | {{withLinks description}} |
23
+ | {{name}} | {{link type}} | {{{renderContent description}}} |
24
24
  {{/each}}
25
25
  {{/if}}
26
26
 
@@ -56,6 +56,6 @@ class Logger {
56
56
  }
57
57
  }
58
58
  exports.Logger = Logger;
59
- Logger.currentFrame = -1;
59
+ Logger.currentFrame = 0;
60
60
  Logger.frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
61
61
  //# sourceMappingURL=logger.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,4DAAmC;AAEnC;;GAEG;AACH,MAAa,MAAM;IAKjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,WAAW,GAAG,IAAI,EAAE,QAAyB,OAAO,EAAE,eAAe,GAAG,IAAI;QAChH,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YACtB,UAAU,GAAG,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QAC3E,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAA,oBAAS,EAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,oBAAS,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;;AAjDH,wBAkDC;AAjDQ,mBAAY,GAAG,CAAC,CAAC,CAAC;AAElB,aAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC"}
1
+ {"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/util/logger.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,4DAAmC;AAEnC;;GAEG;AACH,MAAa,MAAM;IAKjB;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,OAAe,EAAE,GAAG,IAAc;QAClD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAc;QACpD,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE;YAChB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,WAAW,GAAG,IAAI,EAAE,QAAyB,OAAO,EAAE,eAAe,GAAG,IAAI;QAChH,IAAI,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACxB,CAAC;QACD,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,IAAI,UAAU,CAAC;QACf,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YACtB,UAAU,GAAG,GAAG,eAAK,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QAC7E,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,GAAG,eAAK,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC;QAC3E,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAA,oBAAS,EAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,oBAAS,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;;AAjDH,wBAkDC;AAjDQ,mBAAY,GAAG,CAAC,CAAC;AAEjB,aAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC"}
@@ -1,10 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.camel2title = void 0;
4
- exports.truncate = truncate;
3
+ exports.camel2title = exports.truncate = void 0;
5
4
  function truncate(str, n) {
6
5
  return str.length > n ? str.substr(0, n - 1) + '&hellip;' : str;
7
6
  }
7
+ exports.truncate = truncate;
8
8
  const camel2title = (camelCase) => camelCase
9
9
  .replace(/\//g, ' ')
10
10
  .replace(/([A-Z])/g, (match) => ` ${match}`)
@@ -1 +1 @@
1
- {"version":3,"file":"string-utils.js","sourceRoot":"","sources":["../../src/util/string-utils.ts"],"names":[],"mappings":";;;AAAA,4BAEC;AAFD,SAAgB,QAAQ,CAAC,GAAW,EAAE,CAAS;IAC7C,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;AAClE,CAAC;AAEM,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAE,EAAE,CAC/C,SAAS;KACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;KACnB,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;KAC3C,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAChD,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAC7C,IAAI,EAAE,CAAC;AANC,QAAA,WAAW,eAMZ"}
1
+ {"version":3,"file":"string-utils.js","sourceRoot":"","sources":["../../src/util/string-utils.ts"],"names":[],"mappings":";;;AAAA,SAAgB,QAAQ,CAAC,GAAW,EAAE,CAAS;IAC7C,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC;AAClE,CAAC;AAFD,4BAEC;AAEM,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAE,EAAE,CAC/C,SAAS;KACN,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;KACnB,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;KAC3C,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAChD,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KAC7C,IAAI,EAAE,CAAC;AANC,QAAA,WAAW,eAMZ"}
@@ -0,0 +1,73 @@
1
+ # MultiInheritanceClass Class
2
+
3
+ ## Namespace
4
+ ns
5
+
6
+ **Inheritance**
7
+ [ns.SampleClass](../SampleGroup/ns.SampleClass.md) < [ns.BaseClass](./ns.BaseClass.md)
8
+
9
+ ## Fields
10
+ ### `sampleEnumFromBase`
11
+
12
+ *Inherited*
13
+
14
+ #### Signature
15
+ ```apex
16
+ public sampleEnumFromBase
17
+ ```
18
+
19
+ #### Type
20
+ [ns.SampleEnum](../Sample-Enums/ns.SampleEnum.md)
21
+
22
+ ## Properties
23
+ ### Group Name
24
+ #### `someProperty`
25
+
26
+ *Inherited*
27
+
28
+ ##### Signature
29
+ ```apex
30
+ public someProperty
31
+ ```
32
+
33
+ ##### Type
34
+ String
35
+
36
+ ## Methods
37
+ ### Available Methods
38
+ #### `doSomething()`
39
+
40
+ *Inherited*
41
+
42
+ ##### Signature
43
+ ```apex
44
+ public void doSomething()
45
+ ```
46
+
47
+ ##### Return Type
48
+ **void**
49
+
50
+ ### Deprecated Methods
51
+ #### `sayHello()`
52
+
53
+ *Inherited*
54
+
55
+ `DEPRECATED`
56
+
57
+ This is a sample method.
58
+
59
+ ##### Signature
60
+ ```apex
61
+ public virtual String sayHello()
62
+ ```
63
+
64
+ ##### Return Type
65
+ **String**
66
+
67
+ A string value.
68
+
69
+ ##### Example
70
+ ```apex
71
+ SampleClass sample = new SampleClass();
72
+ sample.doSomething();
73
+ ```
@@ -1,7 +1,25 @@
1
1
  # SampleException Class
2
2
 
3
+ This is a sample exception.
4
+
5
+ **Usage**
6
+
7
+ You can use the exception the following way.
8
+
9
+ You can also take a look at [ns.SampleClass](../SampleGroup/ns.SampleClass.md) to see how it is used.
10
+
11
+ This is a dangerous HTML tag: &lt;script&gt;alert(&#x27;Hello&#x27;);&lt;/script&gt;
12
+
13
+ ```apex
14
+ try {
15
+ throw new SampleException();
16
+ } catch (SampleException e) {
17
+ System.debug('Caught exception');
18
+ }
19
+ ```
20
+
3
21
  ## Namespace
4
22
  ns
5
23
 
6
- **Extends**
24
+ **Inheritance**
7
25
  Exception
@@ -39,9 +39,13 @@ sampleInterface.sampleMethod();
39
39
 
40
40
  This is a sample method
41
41
 
42
- **Custom Tag** This is a custom tag
42
+ **Custom Tag**
43
43
 
44
- **Another Custom Tag** This is another custom tag
44
+ This is a custom tag
45
+
46
+ **Another Custom Tag**
47
+
48
+ This is another custom tag
45
49
 
46
50
  #### Signature
47
51
  ```apex
@@ -6,7 +6,9 @@ This is a sample enum. This references [ns.ReferencedEnum](../Miscellaneous/ns.R
6
6
 
7
7
  This description has several lines
8
8
 
9
- **Some Custom** Test. I can also have a [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) here.
9
+ **Some Custom**
10
+
11
+ Test. I can also have a [ns.ReferencedEnum](../Miscellaneous/ns.ReferencedEnum.md) here.
10
12
 
11
13
  And it can be multiline.
12
14
 
@@ -16,7 +16,7 @@ SampleClass sample = new SampleClass();
16
16
  sample.doSomething();
17
17
  ```
18
18
 
19
- **Extends**
19
+ **Inheritance**
20
20
  [ns.BaseClass](../Miscellaneous/ns.BaseClass.md)
21
21
 
22
22
  **Implements**
@@ -31,7 +31,7 @@ This is a sample field.
31
31
 
32
32
  ##### Signature
33
33
  ```apex
34
- private name
34
+ private final name
35
35
  ```
36
36
 
37
37
  ##### Type
@@ -1,36 +1,35 @@
1
- # Classes
1
+ # Apex Reference Guide
2
+
2
3
  ## Miscellaneous
3
4
 
4
5
  ### [ns.BaseClass](./Miscellaneous/ns.BaseClass.md)
5
6
 
7
+ ### [ns.MultiInheritanceClass](./Miscellaneous/ns.MultiInheritanceClass.md)
6
8
 
7
9
  ### [ns.ParentInterface](./Miscellaneous/ns.ParentInterface.md)
8
10
 
9
-
10
11
  ### [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md)
11
12
 
12
-
13
13
  ### [ns.SampleException](./Miscellaneous/ns.SampleException.md)
14
14
 
15
+ This is a sample exception.
15
16
 
16
17
  ### [ns.SampleInterface](./Miscellaneous/ns.SampleInterface.md)
17
18
 
18
19
  This is a sample interface
19
20
 
20
-
21
- ## SampleGroup
22
-
23
- ### [ns.SampleClass](./SampleGroup/ns.SampleClass.md)
24
-
25
- aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
26
- deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
27
-
28
-
29
21
  ## Sample Enums
30
22
 
31
23
  ### [ns.SampleEnum](./Sample-Enums/ns.SampleEnum.md)
32
24
 
33
- This is a sample enum. This references {@link ReferencedEnum}.
25
+ This is a sample enum. This references [ns.ReferencedEnum](./Miscellaneous/ns.ReferencedEnum.md) .
26
+
34
27
  This description has several lines
35
28
 
29
+ ## SampleGroup
30
+
31
+ ### [ns.SampleClass](./SampleGroup/ns.SampleClass.md)
32
+
33
+ aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
36
34
 
35
+ deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
@@ -0,0 +1 @@
1
+ public class MultiInheritanceClass extends SampleClass {}
@@ -1 +1,17 @@
1
+ /**
2
+ * @description This is a sample exception.
3
+ * @usage
4
+ *
5
+ * You can use the exception the following way.
6
+ * You can also take a look at {@link SampleClass} to see how it is used.
7
+ * This is a dangerous HTML tag: <script>alert('Hello');</script>
8
+ *
9
+ * ```
10
+ * try {
11
+ * throw new SampleException();
12
+ * } catch (SampleException e) {
13
+ * System.debug('Caught exception');
14
+ * }
15
+ * ```
16
+ */
1
17
  public class SampleException extends Exception {}
package/jest.config.js CHANGED
@@ -1,7 +1,7 @@
1
1
  module.exports = {
2
2
  preset: 'ts-jest',
3
3
  testEnvironment: 'node',
4
- modulePathIgnorePatterns: ['<rootDir>/lib/'],
4
+ modulePathIgnorePatterns: ['<rootDir>/dist/'],
5
5
  moduleNameMapper: {
6
6
  '^chalk$': '<rootDir>/__mocks__/chalk.js',
7
7
  '^log-update$': '<rootDir>/__mocks__/log-update.js',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cparra/apexdocs",
3
- "version": "2.25.0-alpha.1",
3
+ "version": "2.25.0-alpha.3",
4
4
  "description": "Library with CLI capabilities to generate documentation for Salesforce Apex classes.",
5
5
  "keywords": [
6
6
  "apex",
@@ -10,23 +10,20 @@
10
10
  "apex-docs",
11
11
  "docs"
12
12
  ],
13
- "main": "lib/index.js",
13
+ "exports": "./dist/index.js",
14
+ "types": "./dist/index.d.ts",
14
15
  "bin": {
15
- "apexdocs-generate": "lib/cli/generate.js"
16
+ "apexdocs-generate": "./dist/cli/generate.js"
16
17
  },
17
- "types": "lib/index.d.ts",
18
18
  "scripts": {
19
- "test": "jest",
20
- "build": "rimraf ./lib && npm run lint && tsc --declaration",
19
+ "test": "npm run build && jest",
20
+ "build": "rimraf ./lib && npm run lint && pkgroll --minify",
21
21
  "lint": "eslint \"./src/**/*.{js,ts}\" --quiet --fix",
22
22
  "prepare": "npm run build",
23
23
  "version": "npm run format && git add -A src",
24
24
  "postversion": "git push && git push --tags",
25
25
  "docs:init": "docsify init docs",
26
- "docs:serve": "docsify serve docs",
27
- "execute:example": "rimraf ./docs/types && node lib/cli/generate.js -s examples/force-app -t docs/types --scope global public private protected -g docsify --defaultGroupName \"Misc Group\" --namespace nspc --title \"Sample Documentation\" --documentationRootDir types",
28
- "execute:example:index:only": "node lib/cli/generate.js -s examples/force-app -t docs --scope global public private -g docsify --indexOnly",
29
- "execute:example:openapi": "node lib/cli/generate.js -s examples/force-app -t docs -g openapi --openApiTitle \"Sample REST Api\" --namespace nspc --openApiFileName restapi"
26
+ "docs:serve": "docsify serve docs"
30
27
  },
31
28
  "author": "Cesar Parra",
32
29
  "license": "MIT",
@@ -39,16 +36,15 @@
39
36
  "@types/eslint__js": "^8.42.3",
40
37
  "@types/html-entities": "^1.3.4",
41
38
  "@types/jest": "^29.5.12",
42
- "@types/js-yaml": "^4.0.9",
43
39
  "@types/node": "^20.14.10",
44
40
  "@types/shelljs": "^0.8.15",
45
- "@types/yargs": "^17.0.32",
46
41
  "docsify": "^4.13.1",
47
42
  "eslint": "^8.57.0",
48
43
  "eslint-config-prettier": "^9.1.0",
49
44
  "husky": "^9.0.11",
50
45
  "jest": "^29.7.0",
51
46
  "lint-staged": "^15.2.7",
47
+ "pkgroll": "^2.1.1",
52
48
  "prettier": "^3.3.2",
53
49
  "rimraf": "^6.0.0",
54
50
  "ts-jest": "^29.2.0",
@@ -66,14 +62,16 @@
66
62
  ]
67
63
  },
68
64
  "dependencies": {
69
- "@cparra/apex-reflection": "2.9.3",
70
- "chalk": "^5.3.0",
65
+ "@cparra/apex-reflection": "2.9.5",
66
+ "@types/js-yaml": "^4.0.9",
67
+ "@types/yargs": "^17.0.32",
68
+ "chalk": "^4.1.2",
71
69
  "cosmiconfig": "^9.0.0",
72
70
  "fast-xml-parser": "^4.4.0",
73
71
  "fp-ts": "^2.16.8",
74
72
  "handlebars": "^4.7.8",
75
73
  "js-yaml": "^4.1.0",
76
- "log-update": "6.0.0",
74
+ "log-update": "4.0.0",
77
75
  "yargs": "^17.7.2"
78
76
  }
79
77
  }