@cparra/apexdocs 2.25.0-alpha.3 → 2.25.0-alpha.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 (288) hide show
  1. package/dist/cli/generate.js +26 -26
  2. package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +320 -0
  3. package/examples/plain-markdown/docs/index.md +82 -0
  4. package/examples/plain-markdown/force-app/classes/Url.cls +194 -0
  5. package/examples/plain-markdown/package.json +2 -1
  6. package/package.json +1 -1
  7. package/src/application/Apexdocs.ts +0 -2
  8. package/src/cli/args.ts +3 -1
  9. package/src/cli/generate.ts +1 -3
  10. package/src/core/adapters/__tests__/documentables.spec.ts +109 -0
  11. package/src/core/adapters/__tests__/references.spec.ts +12 -1
  12. package/src/core/adapters/apex-types.ts +1 -1
  13. package/src/core/adapters/documentables.ts +2 -62
  14. package/src/core/adapters/fields-and-properties.ts +7 -2
  15. package/src/core/adapters/{references.ts → inline.ts} +43 -10
  16. package/src/core/adapters/methods-and-constructors.ts +7 -2
  17. package/src/core/adapters/type-utils.ts +5 -1
  18. package/src/core/adapters/types.d.ts +8 -1
  19. package/src/core/template.ts +4 -1
  20. package/src/service/apex-file-reader.ts +1 -5
  21. package/src/settings.ts +0 -10
  22. package/src/test-helpers/SettingsBuilder.ts +0 -2
  23. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +1 -1
  24. package/src/util/fp.ts +3 -0
  25. package/dist/__spec__/core/expect-extensions.d.ts +0 -3
  26. package/dist/__spec__/core/expect-extensions.js +0 -55
  27. package/dist/__spec__/core/expect-extensions.js.map +0 -1
  28. package/dist/__spec__/core/generating-class-docs.spec.d.ts +0 -1
  29. package/dist/__spec__/core/generating-class-docs.spec.js +0 -444
  30. package/dist/__spec__/core/generating-class-docs.spec.js.map +0 -1
  31. package/dist/__spec__/core/generating-enum-docs.spec.d.ts +0 -1
  32. package/dist/__spec__/core/generating-enum-docs.spec.js +0 -306
  33. package/dist/__spec__/core/generating-enum-docs.spec.js.map +0 -1
  34. package/dist/__spec__/core/generating-interface-docs.spec.d.ts +0 -1
  35. package/dist/__spec__/core/generating-interface-docs.spec.js +0 -364
  36. package/dist/__spec__/core/generating-interface-docs.spec.js.map +0 -1
  37. package/dist/__spec__/core/generating-reference-guide.spec.d.ts +0 -1
  38. package/dist/__spec__/core/generating-reference-guide.spec.js +0 -162
  39. package/dist/__spec__/core/generating-reference-guide.spec.js.map +0 -1
  40. package/dist/__spec__/core/test-helpers.d.ts +0 -2
  41. package/dist/__spec__/core/test-helpers.js +0 -12
  42. package/dist/__spec__/core/test-helpers.js.map +0 -1
  43. package/dist/application/Apexdocs.d.ts +0 -15
  44. package/dist/application/Apexdocs.js +0 -113
  45. package/dist/application/Apexdocs.js.map +0 -1
  46. package/dist/application/generators/generate-markdown-files.d.ts +0 -3
  47. package/dist/application/generators/generate-markdown-files.js +0 -64
  48. package/dist/application/generators/generate-markdown-files.js.map +0 -1
  49. package/dist/cli/args.d.ts +0 -39
  50. package/dist/cli/args.js +0 -154
  51. package/dist/cli/args.js.map +0 -1
  52. package/dist/cli/generate.d.ts +0 -2
  53. package/dist/cli/generate.js.map +0 -1
  54. package/dist/core/__test__/inheritance-chain.test.d.ts +0 -1
  55. package/dist/core/__test__/inheritance-chain.test.js +0 -42
  56. package/dist/core/__test__/inheritance-chain.test.js.map +0 -1
  57. package/dist/core/adapters/apex-types.d.ts +0 -6
  58. package/dist/core/adapters/apex-types.js +0 -109
  59. package/dist/core/adapters/apex-types.js.map +0 -1
  60. package/dist/core/adapters/documentables.d.ts +0 -7
  61. package/dist/core/adapters/documentables.js +0 -154
  62. package/dist/core/adapters/documentables.js.map +0 -1
  63. package/dist/core/adapters/fields-and-properties.d.ts +0 -3
  64. package/dist/core/adapters/fields-and-properties.js +0 -37
  65. package/dist/core/adapters/fields-and-properties.js.map +0 -1
  66. package/dist/core/adapters/methods-and-constructors.d.ts +0 -5
  67. package/dist/core/adapters/methods-and-constructors.js +0 -100
  68. package/dist/core/adapters/methods-and-constructors.js.map +0 -1
  69. package/dist/core/adapters/references.d.ts +0 -4
  70. package/dist/core/adapters/references.js +0 -78
  71. package/dist/core/adapters/references.js.map +0 -1
  72. package/dist/core/adapters/type-utils.d.ts +0 -3
  73. package/dist/core/adapters/type-utils.js +0 -12
  74. package/dist/core/adapters/type-utils.js.map +0 -1
  75. package/dist/core/apex-bundle.d.ts +0 -6
  76. package/dist/core/apex-bundle.js +0 -11
  77. package/dist/core/apex-bundle.js.map +0 -1
  78. package/dist/core/generate-docs.d.ts +0 -28
  79. package/dist/core/generate-docs.js +0 -296
  80. package/dist/core/generate-docs.js.map +0 -1
  81. package/dist/core/inheritance-chain.d.ts +0 -2
  82. package/dist/core/inheritance-chain.js +0 -36
  83. package/dist/core/inheritance-chain.js.map +0 -1
  84. package/dist/core/manifest.d.ts +0 -22
  85. package/dist/core/manifest.js +0 -53
  86. package/dist/core/manifest.js.map +0 -1
  87. package/dist/core/template.d.ts +0 -10
  88. package/dist/core/template.js +0 -97
  89. package/dist/core/template.js.map +0 -1
  90. package/dist/core/templates/reference-guide.d.ts +0 -1
  91. package/dist/core/templates/reference-guide.js +0 -18
  92. package/dist/core/templates/reference-guide.js.map +0 -1
  93. package/dist/index.js.map +0 -1
  94. package/dist/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
  95. package/dist/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
  96. package/dist/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
  97. package/dist/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
  98. package/dist/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
  99. package/dist/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
  100. package/dist/model/markdown-file.d.ts +0 -16
  101. package/dist/model/markdown-file.js +0 -111
  102. package/dist/model/markdown-file.js.map +0 -1
  103. package/dist/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
  104. package/dist/model/markdown-generation-util/doc-comment-annotation-util.js +0 -47
  105. package/dist/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
  106. package/dist/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
  107. package/dist/model/markdown-generation-util/field-declaration-util.js +0 -55
  108. package/dist/model/markdown-generation-util/field-declaration-util.js.map +0 -1
  109. package/dist/model/markdown-generation-util/index.d.ts +0 -3
  110. package/dist/model/markdown-generation-util/index.js +0 -20
  111. package/dist/model/markdown-generation-util/index.js.map +0 -1
  112. package/dist/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
  113. package/dist/model/markdown-generation-util/method-declaration-util.js +0 -115
  114. package/dist/model/markdown-generation-util/method-declaration-util.js.map +0 -1
  115. package/dist/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
  116. package/dist/model/markdown-generation-util/type-declaration-util.js +0 -82
  117. package/dist/model/markdown-generation-util/type-declaration-util.js.map +0 -1
  118. package/dist/model/markdown-home-file.d.ts +0 -11
  119. package/dist/model/markdown-home-file.js +0 -57
  120. package/dist/model/markdown-home-file.js.map +0 -1
  121. package/dist/model/markdown-type-file.d.ts +0 -26
  122. package/dist/model/markdown-type-file.js +0 -137
  123. package/dist/model/markdown-type-file.js.map +0 -1
  124. package/dist/model/openapi/apex-doc-types.d.ts +0 -19
  125. package/dist/model/openapi/apex-doc-types.js +0 -5
  126. package/dist/model/openapi/apex-doc-types.js.map +0 -1
  127. package/dist/model/openapi/open-api-types.d.ts +0 -93
  128. package/dist/model/openapi/open-api-types.js +0 -3
  129. package/dist/model/openapi/open-api-types.js.map +0 -1
  130. package/dist/model/openapi/open-api.d.ts +0 -16
  131. package/dist/model/openapi/open-api.js +0 -34
  132. package/dist/model/openapi/open-api.js.map +0 -1
  133. package/dist/model/openapi/openapi-type-file.d.ts +0 -7
  134. package/dist/model/openapi/openapi-type-file.js +0 -17
  135. package/dist/model/openapi/openapi-type-file.js.map +0 -1
  136. package/dist/model/outputFile.d.ts +0 -10
  137. package/dist/model/outputFile.js +0 -22
  138. package/dist/model/outputFile.js.map +0 -1
  139. package/dist/model/types-repository.d.ts +0 -16
  140. package/dist/model/types-repository.js +0 -54
  141. package/dist/model/types-repository.js.map +0 -1
  142. package/dist/service/apex-file-reader.d.ts +0 -14
  143. package/dist/service/apex-file-reader.js +0 -49
  144. package/dist/service/apex-file-reader.js.map +0 -1
  145. package/dist/service/file-system.d.ts +0 -14
  146. package/dist/service/file-system.js +0 -48
  147. package/dist/service/file-system.js.map +0 -1
  148. package/dist/service/file-writer.d.ts +0 -6
  149. package/dist/service/file-writer.js +0 -57
  150. package/dist/service/file-writer.js.map +0 -1
  151. package/dist/service/manifest-factory.d.ts +0 -10
  152. package/dist/service/manifest-factory.js +0 -17
  153. package/dist/service/manifest-factory.js.map +0 -1
  154. package/dist/service/metadata-processor.d.ts +0 -3
  155. package/dist/service/metadata-processor.js +0 -17
  156. package/dist/service/metadata-processor.js.map +0 -1
  157. package/dist/service/parser.d.ts +0 -21
  158. package/dist/service/parser.js +0 -138
  159. package/dist/service/parser.js.map +0 -1
  160. package/dist/service/state.d.ts +0 -9
  161. package/dist/service/state.js +0 -20
  162. package/dist/service/state.js.map +0 -1
  163. package/dist/service/walkers/class-walker.d.ts +0 -4
  164. package/dist/service/walkers/class-walker.js +0 -33
  165. package/dist/service/walkers/class-walker.js.map +0 -1
  166. package/dist/service/walkers/enum-walker.d.ts +0 -4
  167. package/dist/service/walkers/enum-walker.js +0 -11
  168. package/dist/service/walkers/enum-walker.js.map +0 -1
  169. package/dist/service/walkers/interface-walker.d.ts +0 -4
  170. package/dist/service/walkers/interface-walker.js +0 -15
  171. package/dist/service/walkers/interface-walker.js.map +0 -1
  172. package/dist/service/walkers/walker-factory.d.ts +0 -5
  173. package/dist/service/walkers/walker-factory.js +0 -21
  174. package/dist/service/walkers/walker-factory.js.map +0 -1
  175. package/dist/service/walkers/walker.d.ts +0 -19
  176. package/dist/service/walkers/walker.js +0 -17
  177. package/dist/service/walkers/walker.js.map +0 -1
  178. package/dist/settings.d.ts +0 -67
  179. package/dist/settings.js +0 -92
  180. package/dist/settings.js.map +0 -1
  181. package/dist/test-helpers/AnnotationBuilder.d.ts +0 -12
  182. package/dist/test-helpers/AnnotationBuilder.js +0 -31
  183. package/dist/test-helpers/AnnotationBuilder.js.map +0 -1
  184. package/dist/test-helpers/ClassMirrorBuilder.d.ts +0 -22
  185. package/dist/test-helpers/ClassMirrorBuilder.js +0 -64
  186. package/dist/test-helpers/ClassMirrorBuilder.js.map +0 -1
  187. package/dist/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
  188. package/dist/test-helpers/DocCommentAnnotationBuilder.js +0 -26
  189. package/dist/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
  190. package/dist/test-helpers/DocCommentBuilder.d.ts +0 -12
  191. package/dist/test-helpers/DocCommentBuilder.js +0 -38
  192. package/dist/test-helpers/DocCommentBuilder.js.map +0 -1
  193. package/dist/test-helpers/FieldMirrorBuilder.d.ts +0 -18
  194. package/dist/test-helpers/FieldMirrorBuilder.js +0 -54
  195. package/dist/test-helpers/FieldMirrorBuilder.js.map +0 -1
  196. package/dist/test-helpers/InterfaceMirrorBuilder.d.ts +0 -16
  197. package/dist/test-helpers/InterfaceMirrorBuilder.js +0 -43
  198. package/dist/test-helpers/InterfaceMirrorBuilder.js.map +0 -1
  199. package/dist/test-helpers/MethodMirrorBuilder.d.ts +0 -29
  200. package/dist/test-helpers/MethodMirrorBuilder.js +0 -72
  201. package/dist/test-helpers/MethodMirrorBuilder.js.map +0 -1
  202. package/dist/test-helpers/SettingsBuilder.d.ts +0 -8
  203. package/dist/test-helpers/SettingsBuilder.js +0 -28
  204. package/dist/test-helpers/SettingsBuilder.js.map +0 -1
  205. package/dist/transpiler/factory.d.ts +0 -6
  206. package/dist/transpiler/factory.js +0 -33
  207. package/dist/transpiler/factory.js.map +0 -1
  208. package/dist/transpiler/file-container.d.ts +0 -6
  209. package/dist/transpiler/file-container.js +0 -16
  210. package/dist/transpiler/file-container.js.map +0 -1
  211. package/dist/transpiler/generator-choices.d.ts +0 -1
  212. package/dist/transpiler/generator-choices.js +0 -3
  213. package/dist/transpiler/generator-choices.js.map +0 -1
  214. package/dist/transpiler/markdown/class-file-generatorHelper.d.ts +0 -9
  215. package/dist/transpiler/markdown/class-file-generatorHelper.js +0 -61
  216. package/dist/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
  217. package/dist/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
  218. package/dist/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
  219. package/dist/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
  220. package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
  221. package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
  222. package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
  223. package/dist/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
  224. package/dist/transpiler/markdown/markdown-transpiler-base.js +0 -27
  225. package/dist/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
  226. package/dist/transpiler/markdown/plain-markdown/class-template.d.ts +0 -1
  227. package/dist/transpiler/markdown/plain-markdown/class-template.js +0 -77
  228. package/dist/transpiler/markdown/plain-markdown/class-template.js.map +0 -1
  229. package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -1
  230. package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.js +0 -36
  231. package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -1
  232. package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -1
  233. package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.js +0 -30
  234. package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +0 -1
  235. package/dist/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -1
  236. package/dist/transpiler/markdown/plain-markdown/enum-template.js +0 -16
  237. package/dist/transpiler/markdown/plain-markdown/enum-template.js.map +0 -1
  238. package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -1
  239. package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +0 -27
  240. package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -1
  241. package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -1
  242. package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -10
  243. package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -1
  244. package/dist/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -1
  245. package/dist/transpiler/markdown/plain-markdown/interface-template.js +0 -20
  246. package/dist/transpiler/markdown/plain-markdown/interface-template.js.map +0 -1
  247. package/dist/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -1
  248. package/dist/transpiler/markdown/plain-markdown/methods-partial-template.js +0 -47
  249. package/dist/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
  250. package/dist/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -1
  251. package/dist/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -31
  252. package/dist/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -1
  253. package/dist/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
  254. package/dist/transpiler/openapi/open-api-docs-processor.js +0 -78
  255. package/dist/transpiler/openapi/open-api-docs-processor.js.map +0 -1
  256. package/dist/transpiler/openapi/parsers/Builder.d.ts +0 -16
  257. package/dist/transpiler/openapi/parsers/Builder.js +0 -30
  258. package/dist/transpiler/openapi/parsers/Builder.js.map +0 -1
  259. package/dist/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
  260. package/dist/transpiler/openapi/parsers/MethodParser.js +0 -190
  261. package/dist/transpiler/openapi/parsers/MethodParser.js.map +0 -1
  262. package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
  263. package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
  264. package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
  265. package/dist/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
  266. package/dist/transpiler/openapi/parsers/ReferenceBuilder.js +0 -250
  267. package/dist/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
  268. package/dist/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
  269. package/dist/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
  270. package/dist/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
  271. package/dist/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
  272. package/dist/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
  273. package/dist/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
  274. package/dist/transpiler/processor-type-transpiler.d.ts +0 -10
  275. package/dist/transpiler/processor-type-transpiler.js +0 -9
  276. package/dist/transpiler/processor-type-transpiler.js.map +0 -1
  277. package/dist/transpiler/transpiler.d.ts +0 -5
  278. package/dist/transpiler/transpiler.js +0 -30
  279. package/dist/transpiler/transpiler.js.map +0 -1
  280. package/dist/util/error-logger.d.ts +0 -8
  281. package/dist/util/error-logger.js +0 -90
  282. package/dist/util/error-logger.js.map +0 -1
  283. package/dist/util/logger.d.ts +0 -21
  284. package/dist/util/logger.js +0 -61
  285. package/dist/util/logger.js.map +0 -1
  286. package/dist/util/string-utils.d.ts +0 -2
  287. package/dist/util/string-utils.js +0 -15
  288. package/dist/util/string-utils.js.map +0 -1
@@ -1,33 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.TypeTranspilerFactory = void 0;
7
- const jekyll_docsProcessor_1 = require("./markdown/jekyll/jekyll-docsProcessor");
8
- const docsify_docs_processor_1 = __importDefault(require("./markdown/docsify/docsify-docs-processor"));
9
- const open_api_docs_processor_1 = require("./openapi/open-api-docs-processor");
10
- class TypeTranspilerFactory {
11
- static get(generator) {
12
- if (this.typeTranspilerCache) {
13
- return this.typeTranspilerCache;
14
- }
15
- switch (generator) {
16
- case 'jekyll':
17
- this.typeTranspilerCache = new jekyll_docsProcessor_1.JekyllDocsProcessor();
18
- return this.typeTranspilerCache;
19
- case 'docsify':
20
- this.typeTranspilerCache = new docsify_docs_processor_1.default();
21
- return this.typeTranspilerCache;
22
- case 'openapi':
23
- this.typeTranspilerCache = new open_api_docs_processor_1.OpenApiDocsProcessor();
24
- return this.typeTranspilerCache;
25
- case 'plain-markdown':
26
- throw Error('Plain Markdown processor is not supported through this factory anymore.');
27
- default:
28
- throw Error('Invalid target generator');
29
- }
30
- }
31
- }
32
- exports.TypeTranspilerFactory = TypeTranspilerFactory;
33
- //# sourceMappingURL=factory.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/transpiler/factory.ts"],"names":[],"mappings":";;;;;;AAEA,iFAA6E;AAC7E,uGAA6E;AAC7E,+EAAyE;AAEzE,MAAa,qBAAqB;IAGzB,MAAM,CAAC,GAAG,CAAC,SAA2B;QAC3C,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,QAAQ;gBACX,IAAI,CAAC,mBAAmB,GAAG,IAAI,0CAAmB,EAAE,CAAC;gBACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,gCAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,SAAS;gBACZ,IAAI,CAAC,mBAAmB,GAAG,IAAI,8CAAoB,EAAE,CAAC;gBACtD,OAAO,IAAI,CAAC,mBAAmB,CAAC;YAClC,KAAK,gBAAgB;gBACnB,MAAM,KAAK,CAAC,yEAAyE,CAAC,CAAC;YACzF;gBACE,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;CACF;AAxBD,sDAwBC"}
@@ -1,6 +0,0 @@
1
- import { OutputFile } from '../model/outputFile';
2
- export declare class FileContainer {
3
- _files: OutputFile[];
4
- files(): OutputFile[];
5
- pushFile(file: OutputFile): void;
6
- }
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FileContainer = void 0;
4
- class FileContainer {
5
- constructor() {
6
- this._files = [];
7
- }
8
- files() {
9
- return this._files;
10
- }
11
- pushFile(file) {
12
- this._files.push(file);
13
- }
14
- }
15
- exports.FileContainer = FileContainer;
16
- //# sourceMappingURL=file-container.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"file-container.js","sourceRoot":"","sources":["../../src/transpiler/file-container.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACE,WAAM,GAAiB,EAAE,CAAC;IAS5B,CAAC;IAPC,KAAK;QACH,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,QAAQ,CAAC,IAAgB;QACvB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;CACF;AAVD,sCAUC"}
@@ -1 +0,0 @@
1
- export type GeneratorChoices = 'jekyll' | 'docsify' | 'plain-markdown' | 'openapi';
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=generator-choices.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"generator-choices.js","sourceRoot":"","sources":["../../src/transpiler/generator-choices.ts"],"names":[],"mappings":""}
@@ -1,9 +0,0 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- export default class ClassFileGeneratorHelper {
3
- static getSanitizedGroup(classModel: Type): string;
4
- static getFileLink(classModel: Type): string;
5
- private static getFileLinkTuple;
6
- static getFileLinkByTypeName(typeName: string): string;
7
- private static getDirectoryRoot;
8
- private static getClassGroup;
9
- }
@@ -1,61 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- const types_repository_1 = require("../../model/types-repository");
7
- const settings_1 = require("../../settings");
8
- const state_1 = __importDefault(require("../../service/state"));
9
- class ClassFileGeneratorHelper {
10
- static getSanitizedGroup(classModel) {
11
- return this.getClassGroup(classModel).replace(/ /g, '-').replace('.', '');
12
- }
13
- static getFileLink(classModel) {
14
- const [fullClassName, fileLink] = ClassFileGeneratorHelper.getFileLinkTuple(classModel);
15
- return `[${fullClassName}](${fileLink})`;
16
- }
17
- static getFileLinkTuple(classModel) {
18
- var _a;
19
- const documentationRoot = (_a = settings_1.Settings.getInstance().getRootDir()) !== null && _a !== void 0 ? _a : '';
20
- const directoryRoot = `${documentationRoot}${this.getDirectoryRoot(classModel)}`;
21
- const fullClassName = `${settings_1.Settings.getInstance().getNamespacePrefix()}${classModel.name}`;
22
- return [fullClassName, `${directoryRoot}${fullClassName}.md`];
23
- }
24
- static getFileLinkByTypeName(typeName) {
25
- const type = types_repository_1.TypesRepository.getInstance().getFromScopedByName(typeName);
26
- if (!type) {
27
- // If the type is not found, we return a Markdown hyperlink with whatever we received.
28
- return `[${typeName}](${typeName})`;
29
- }
30
- return this.getFileLink(type);
31
- }
32
- static getDirectoryRoot(classModel) {
33
- // root-relative links start from the root by using a leading '/'
34
- if (settings_1.Settings.getInstance().getLinkingStrategy() === 'root-relative') {
35
- return `/${this.getSanitizedGroup(classModel)}/`;
36
- }
37
- // path-relative links traverse the directory structure
38
- const typeBeingProcessed = state_1.default.getInstance().getTypeBeingProcessed();
39
- if (typeBeingProcessed) {
40
- if (this.getClassGroup(typeBeingProcessed) === this.getClassGroup(classModel)) {
41
- // If the types the same groups then we simply link directly to that file
42
- return './';
43
- }
44
- else {
45
- // If the types have different groups, then we have to go up a directory
46
- return `../${this.getSanitizedGroup(classModel)}/`;
47
- }
48
- }
49
- else {
50
- // If nothing is being processed, then we assume we are at the root and links should include the groups
51
- return `./${this.getSanitizedGroup(classModel)}/`;
52
- }
53
- }
54
- static getClassGroup(classModel) {
55
- var _a, _b;
56
- const groupAnnotation = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === 'group');
57
- return (_b = groupAnnotation === null || groupAnnotation === void 0 ? void 0 : groupAnnotation.body) !== null && _b !== void 0 ? _b : settings_1.Settings.getInstance().getDefaultGroupName();
58
- }
59
- }
60
- exports.default = ClassFileGeneratorHelper;
61
- //# sourceMappingURL=class-file-generatorHelper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"class-file-generatorHelper.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/class-file-generatorHelper.ts"],"names":[],"mappings":";;;;;AACA,mEAA+D;AAC/D,6CAA0C;AAC1C,gEAAwC;AAExC,MAAqB,wBAAwB;IACpC,MAAM,CAAC,iBAAiB,CAAC,UAAgB;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,UAAgB;QACxC,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACxF,OAAO,IAAI,aAAa,KAAK,QAAQ,GAAG,CAAC;IAC3C,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;;QAC9C,MAAM,iBAAiB,GAAG,MAAA,mBAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,mCAAI,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;QACjF,MAAM,aAAa,GAAG,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QACzF,OAAO,CAAC,aAAa,EAAE,GAAG,aAAa,GAAG,aAAa,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,qBAAqB,CAAC,QAAgB;QAClD,MAAM,IAAI,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,sFAAsF;YACtF,OAAO,IAAI,QAAQ,KAAK,QAAQ,GAAG,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,UAAgB;QAC9C,iEAAiE;QACjE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,KAAK,eAAe,EAAE,CAAC;YACpE,OAAO,IAAI,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QACnD,CAAC;QAED,uDAAuD;QACvD,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,EAAE,CAAC,qBAAqB,EAAE,CAAC;QACvE,IAAI,kBAAkB,EAAE,CAAC;YACvB,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC9E,yEAAyE;gBACzE,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,wEAAwE;gBACxE,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;YACrD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,uGAAuG;YACvG,OAAO,KAAK,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,GAAG,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,UAAgB;;QAC3C,MAAM,eAAe,GAAG,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAC7D,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAC1D,CAAC;QACF,OAAO,MAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,mCAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAAC;IAC/E,CAAC;CACF;AAvDD,2CAuDC"}
@@ -1,6 +0,0 @@
1
- import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
- import { LinkingStrategy } from '../../processor-type-transpiler';
3
- export default class DocsifyDocsProcessor extends MarkdownTranspilerBase {
4
- homeFileName(): string;
5
- getLinkingStrategy(): LinkingStrategy;
6
- }
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
4
- class DocsifyDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
5
- homeFileName() {
6
- return 'README';
7
- }
8
- getLinkingStrategy() {
9
- return 'root-relative';
10
- }
11
- }
12
- exports.default = DocsifyDocsProcessor;
13
- //# sourceMappingURL=docsify-docs-processor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"docsify-docs-processor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/docsify/docsify-docs-processor.ts"],"names":[],"mappings":";;AAAA,0EAAqE;AAGrE,MAAqB,oBAAqB,SAAQ,iDAAsB;IACtE,YAAY;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AARD,uCAQC"}
@@ -1,11 +0,0 @@
1
- import { MarkdownTranspilerBase } from '../markdown-transpiler-base';
2
- import { Type } from '@cparra/apex-reflection';
3
- import { LinkingStrategy } from '../../processor-type-transpiler';
4
- export declare class JekyllDocsProcessor extends MarkdownTranspilerBase {
5
- homeFileName(): string;
6
- onBeforeProcess: (types: Type[]) => void;
7
- onProcess(type: Type): void;
8
- get frontMatterForHomeFile(): string;
9
- getFrontMatterHeader(type: Type): string;
10
- getLinkingStrategy(): LinkingStrategy;
11
- }
@@ -1,51 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.JekyllDocsProcessor = void 0;
4
- const markdown_transpiler_base_1 = require("../markdown-transpiler-base");
5
- const markdown_home_file_1 = require("../../../model/markdown-home-file");
6
- const markdown_type_file_1 = require("../../../model/markdown-type-file");
7
- const settings_1 = require("../../../settings");
8
- class JekyllDocsProcessor extends markdown_transpiler_base_1.MarkdownTranspilerBase {
9
- constructor() {
10
- super(...arguments);
11
- this.onBeforeProcess = (types) => {
12
- this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types, this.frontMatterForHomeFile));
13
- };
14
- }
15
- homeFileName() {
16
- return 'index';
17
- }
18
- onProcess(type) {
19
- this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type, 1, this.getFrontMatterHeader(type)));
20
- }
21
- get frontMatterForHomeFile() {
22
- return '---\nlayout: default\n---';
23
- }
24
- getFrontMatterHeader(type) {
25
- var _a;
26
- const headerLines = ['---'];
27
- // "layout: default" is a required front matter header for Jekyll
28
- headerLines.push('layout: default');
29
- // Add any additional front matter headers that might have been configured in the settings
30
- const targetType = {
31
- name: type.name,
32
- typeName: type.type_name,
33
- accessModifier: type.access_modifier,
34
- group: type.group,
35
- description: (_a = type.docComment) === null || _a === void 0 ? void 0 : _a.description,
36
- };
37
- const configuredHeaders = settings_1.Settings.getInstance().frontMatterHeader(targetType);
38
- if (configuredHeaders) {
39
- configuredHeaders.forEach((header) => {
40
- headerLines.push(header);
41
- });
42
- }
43
- headerLines.push('---');
44
- return headerLines.join('\n');
45
- }
46
- getLinkingStrategy() {
47
- return 'path-relative';
48
- }
49
- }
50
- exports.JekyllDocsProcessor = JekyllDocsProcessor;
51
- //# sourceMappingURL=jekyll-docsProcessor.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"jekyll-docsProcessor.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts"],"names":[],"mappings":";;;AAAA,0EAAqE;AAErE,0EAAqE;AACrE,0EAAqE;AAErE,gDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,iDAAsB;IAA/D;;QAKE,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAC;IAmCJ,CAAC;IAzCC,YAAY;QACV,OAAO,OAAO,CAAC;IACjB,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,2BAA2B,CAAC;IACrC,CAAC;IAED,oBAAoB,CAAC,IAAU;;QAC7B,MAAM,WAAW,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,iEAAiE;QACjE,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,0FAA0F;QAC1F,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,cAAc,EAAE,IAAI,CAAC,eAAe;YACpC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,WAAW,EAAE,MAAA,IAAI,CAAC,UAAU,0CAAE,WAAW;SAC1C,CAAC;QACF,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAC/E,IAAI,iBAAiB,EAAE,CAAC;YACtB,iBAAiB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACnC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,kBAAkB;QAChB,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AA1CD,kDA0CC"}
@@ -1,11 +0,0 @@
1
- import ProcessorTypeTranspiler from '../processor-type-transpiler';
2
- import { Type } from '@cparra/apex-reflection';
3
- import { FileContainer } from '../file-container';
4
- export declare abstract class MarkdownTranspilerBase extends ProcessorTypeTranspiler {
5
- protected readonly _fileContainer: FileContainer;
6
- constructor();
7
- abstract homeFileName(): string;
8
- fileBuilder(): FileContainer;
9
- onBeforeProcess: (types: Type[]) => void;
10
- onProcess(type: Type): void;
11
- }
@@ -1,27 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.MarkdownTranspilerBase = void 0;
7
- const processor_type_transpiler_1 = __importDefault(require("../processor-type-transpiler"));
8
- const file_container_1 = require("../file-container");
9
- const markdown_home_file_1 = require("../../model/markdown-home-file");
10
- const markdown_type_file_1 = require("../../model/markdown-type-file");
11
- class MarkdownTranspilerBase extends processor_type_transpiler_1.default {
12
- constructor() {
13
- super();
14
- this.onBeforeProcess = (types) => {
15
- this._fileContainer.pushFile(new markdown_home_file_1.MarkdownHomeFile(this.homeFileName(), types));
16
- };
17
- this._fileContainer = new file_container_1.FileContainer();
18
- }
19
- fileBuilder() {
20
- return this._fileContainer;
21
- }
22
- onProcess(type) {
23
- this._fileContainer.pushFile(new markdown_type_file_1.MarkdownTypeFile(type));
24
- }
25
- }
26
- exports.MarkdownTranspilerBase = MarkdownTranspilerBase;
27
- //# sourceMappingURL=markdown-transpiler-base.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"markdown-transpiler-base.js","sourceRoot":"","sources":["../../../src/transpiler/markdown/markdown-transpiler-base.ts"],"names":[],"mappings":";;;;;;AAAA,6FAAmE;AAEnE,sDAAkD;AAClD,uEAAkE;AAClE,uEAAkE;AAElE,MAAsB,sBAAuB,SAAQ,mCAAuB;IAG1E;QACE,KAAK,EAAE,CAAC;QAUV,oBAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YAClC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAXA,IAAI,CAAC,cAAc,GAAG,IAAI,8BAAa,EAAE,CAAC;IAC5C,CAAC;IAID,WAAW;QACT,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAMD,SAAS,CAAC,IAAU;QAClB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,qCAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;CACF;AArBD,wDAqBC"}
@@ -1 +0,0 @@
1
- export declare const classMarkdownTemplate: string;
@@ -1,77 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.classMarkdownTemplate = void 0;
4
- exports.classMarkdownTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#if classModifier}}
7
- \`{{classModifier}}\`
8
- {{/if}}
9
-
10
- {{> typeDocumentation}}
11
-
12
- {{#if extends.length}}
13
- **Inheritance**
14
- {{#each extends}}{{link this}}{{#unless @last}} < {{/unless}}{{/each}}
15
- {{/if}}
16
-
17
- {{#if implements}}
18
- **Implements**
19
- {{#each implements}}
20
- {{link this}}{{#unless @last}}, {{/unless}}
21
- {{/each}}
22
- {{/if}}
23
-
24
- {{#if fields.value}}
25
- {{#if fields.isGrouped}}
26
- {{> groupedMembersPartialTemplate fields subTemplate="fieldsPartialTemplate"}}
27
- {{else}}
28
- {{> fieldsPartialTemplate fields}}
29
- {{/if}}
30
- {{/if}}
31
-
32
- {{#if properties.value}}
33
- {{#if properties.isGrouped}}
34
- {{> groupedMembersPartialTemplate properties subTemplate="fieldsPartialTemplate"}}
35
- {{else}}
36
- {{> fieldsPartialTemplate properties}}
37
- {{/if}}
38
- {{/if}}
39
-
40
- {{#if constructors.value}}
41
- {{#if constructors.isGrouped}}
42
- {{> groupedMembersPartialTemplate constructors subTemplate="constructorsPartialTemplate"}}
43
- {{else}}
44
- {{> constructorsPartialTemplate constructors}}
45
- {{/if}}
46
- {{/if}}
47
-
48
- {{#if methods.value}}
49
- {{#if methods.isGrouped}}
50
- {{> groupedMembersPartialTemplate methods subTemplate="methodsPartialTemplate"}}
51
- {{else}}
52
- {{> methodsPartialTemplate methods}}
53
- {{/if}}
54
- {{/if}}
55
-
56
- {{#if innerClasses.value}}
57
- {{ heading innerClasses.headingLevel innerClasses.heading }}
58
- {{#each innerClasses.value}}
59
- {{> classTemplate this}}
60
- {{/each}}
61
- {{/if}}
62
-
63
- {{#if innerEnums.value}}
64
- {{ heading innerEnums.headingLevel innerEnums.heading }}
65
- {{#each innerEnums.value}}
66
- {{> enumTemplate this}}
67
- {{/each}}
68
- {{/if}}
69
-
70
- {{#if innerInterfaces.value}}
71
- {{ heading innerInterfaces.headingLevel innerInterfaces.heading }}
72
- {{#each innerInterfaces.value}}
73
- {{> interfaceTemplate this}}
74
- {{/each}}
75
- {{/if}}
76
- `.trim();
77
- //# sourceMappingURL=class-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"class-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/class-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwEpC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const constructorsPartialTemplate: string;
@@ -1,36 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.constructorsPartialTemplate = void 0;
4
- exports.constructorsPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{{ heading headingLevel (inlineCode heading) }}}
8
-
9
- {{#> documentablePartialTemplate}}
10
-
11
- {{ heading signature.headingLevel signature.heading }}
12
- {{ code signature.value }}
13
-
14
- {{#if parameters.value}}
15
- {{ heading parameters.headingLevel parameters.heading }}
16
- | Name | Type | Description |
17
- |------|------|-------------|
18
- {{#each parameters.value}}
19
- | {{name}} | {{type}} | {{description}} |
20
- {{/each}}
21
- {{/if}}
22
-
23
- {{#if throws.value}}
24
- {{ heading throws.headingLevel throws.heading }}
25
- {{#each throws.value}}
26
- {{link this.type}}: {{this.description}}
27
-
28
- {{/each}}
29
- {{/if}}
30
- {{/documentablePartialTemplate}}
31
-
32
- {{#unless @last}}---{{/unless}}
33
-
34
- {{/each}}
35
- `.trim();
36
- //# sourceMappingURL=constructors-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"constructors-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/constructors-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,2BAA2B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+B1C,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const documentablePartialTemplate: string;
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.documentablePartialTemplate = void 0;
4
- exports.documentablePartialTemplate = `
5
- {{#each doc.annotations}}
6
- \`{{this}}\`
7
- {{/each}}
8
-
9
- {{{renderContent doc.description}}}
10
-
11
- {{#each doc.customTags}}
12
- **{{splitAndCapitalize name}}**
13
-
14
- {{{renderContent description}}}
15
-
16
- {{/each}}
17
-
18
- {{> @partial-block}}
19
-
20
- {{#if doc.mermaid.value}}
21
- {{ heading doc.mermaid.headingLevel doc.mermaid.heading }}
22
- {{code doc.mermaid.value}}
23
- {{/if}}
24
-
25
- {{#if doc.example.value}}
26
- {{ heading doc.example.headingLevel doc.example.heading }}
27
- {{code doc.example.value}}
28
- {{/if}}
29
- `.trim();
30
- //# sourceMappingURL=documentable-partial-template.js.map
@@ -1 +0,0 @@
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"}
@@ -1 +0,0 @@
1
- export declare const enumMarkdownTemplate: string;
@@ -1,16 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.enumMarkdownTemplate = void 0;
4
- exports.enumMarkdownTemplate = `
5
- {{ heading headingLevel heading }}
6
-
7
- {{> typeDocumentation }}
8
-
9
- {{ heading values.headingLevel values.heading }}
10
- | Value | Description |
11
- |-------|-------------|
12
- {{#each values.value}}
13
- | {{value}} | {{description}} |
14
- {{/each}}
15
- `.trim();
16
- //# sourceMappingURL=enum-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"enum-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/enum-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,oBAAoB,GAAG;;;;;;;;;;;CAWnC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const fieldsPartialTemplate: string;
@@ -1,27 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.fieldsPartialTemplate = void 0;
4
- exports.fieldsPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{{ heading headingLevel (inlineCode heading) }}}
8
-
9
- {{#if inherited}}
10
- *Inherited*
11
- {{/if}}
12
-
13
- {{#> documentablePartialTemplate }}
14
-
15
- {{ heading signature.headingLevel signature.heading }}
16
- {{ code signature.value }}
17
-
18
- {{ heading type.headingLevel type.heading }}
19
- {{link type.value}}
20
-
21
- {{/documentablePartialTemplate}}
22
-
23
- {{#unless @last}}---{{/unless}}
24
-
25
- {{/each}}
26
- `.trim();
27
- //# sourceMappingURL=fieldsPartialTemplate.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fieldsPartialTemplate.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts"],"names":[],"mappings":";;;AAAa,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;CAsBpC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const groupedMembersPartialTemplate: string;
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.groupedMembersPartialTemplate = void 0;
4
- exports.groupedMembersPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{> (lookup .. "subTemplate") this}}
8
- {{/each}}
9
- `.trim();
10
- //# sourceMappingURL=grouped-members-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"grouped-members-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,6BAA6B,GAAG;;;;;CAK5C,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const interfaceMarkdownTemplate: string;
@@ -1,20 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.interfaceMarkdownTemplate = void 0;
4
- exports.interfaceMarkdownTemplate = `
5
- {{ heading headingLevel heading }}
6
-
7
- {{> typeDocumentation }}
8
-
9
- {{#if extends}}
10
- **Extends**
11
- {{#each extends}}
12
- {{link this}}{{#unless @last}}, {{/unless}}
13
- {{/each}}
14
- {{/if}}
15
-
16
- {{#if methods}}
17
- {{> methodsPartialTemplate methods}}
18
- {{/if}}
19
- `.trim();
20
- //# sourceMappingURL=interface-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"interface-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/interface-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,yBAAyB,GAAG;;;;;;;;;;;;;;;CAexC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const methodsPartialTemplate: string;
@@ -1,47 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.methodsPartialTemplate = void 0;
4
- exports.methodsPartialTemplate = `
5
- {{ heading headingLevel heading }}
6
- {{#each value}}
7
- {{{ heading headingLevel (inlineCode heading) }}}
8
-
9
- {{#if inherited}}
10
- *Inherited*
11
- {{/if}}
12
-
13
- {{#> documentablePartialTemplate}}
14
-
15
- {{ heading signature.headingLevel signature.heading }}
16
- {{ code signature.value }}
17
-
18
- {{#if parameters.value}}
19
- {{ heading parameters.headingLevel parameters.heading }}
20
- | Name | Type | Description |
21
- |------|------|-------------|
22
- {{#each parameters.value}}
23
- | {{name}} | {{link type}} | {{{renderContent description}}} |
24
- {{/each}}
25
- {{/if}}
26
-
27
- {{ heading returnType.headingLevel returnType.heading }}
28
- **{{link returnType.value.type}}**
29
-
30
- {{#if returnType.value.description}}
31
- {{returnType.value.description}}
32
- {{/if}}
33
-
34
- {{#if throws.value}}
35
- {{ heading throws.headingLevel throws.heading }}
36
- {{#each throws.value}}
37
- {{link this.type}}: {{this.description}}
38
-
39
- {{/each}}
40
- {{/if}}
41
- {{/documentablePartialTemplate}}
42
-
43
- {{#unless @last}}---{{/unless}}
44
-
45
- {{/each}}
46
- `.trim();
47
- //# sourceMappingURL=methods-partial-template.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"methods-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/methods-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CrC,CAAC,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export declare const typeDocPartial: string;