@cparra/apexdocs 2.25.0 → 3.0.0-alpha.10
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.
- package/.github/workflows/ci.yaml +22 -0
- package/README.md +73 -12
- package/__mocks__/chalk.js +12 -0
- package/__mocks__/log-update.js +6 -0
- package/dist/cli/generate.js +3181 -0
- package/dist/defaults-DGKfeZq-.js +13 -0
- package/dist/index.d.ts +117 -0
- package/dist/index.js +36 -0
- package/eslint.config.mjs +10 -0
- package/examples/markdown/.forceignore +12 -0
- package/examples/markdown/config/project-scratch-def.json +5 -0
- package/examples/markdown/docs/index.md +109 -0
- package/examples/markdown/docs/miscellaneous/BaseClass.md +16 -0
- package/examples/markdown/docs/miscellaneous/MultiInheritanceClass.md +72 -0
- package/examples/markdown/docs/miscellaneous/ParentInterface.md +15 -0
- package/examples/markdown/docs/miscellaneous/ReferencedEnum.md +8 -0
- package/examples/markdown/docs/miscellaneous/SampleException.md +24 -0
- package/examples/markdown/docs/miscellaneous/SampleInterface.md +116 -0
- package/examples/markdown/docs/miscellaneous/Url.md +309 -0
- package/examples/markdown/docs/sample-enums/SampleEnum.md +36 -0
- package/examples/markdown/docs/samplegroup/SampleClass.md +170 -0
- package/examples/markdown/force-app/classes/BaseClass.cls +3 -0
- package/examples/markdown/force-app/classes/MultiInheritanceClass.cls +1 -0
- package/examples/markdown/force-app/classes/ParentInterface.cls +3 -0
- package/examples/markdown/force-app/classes/ReferencedEnum.cls +3 -0
- package/examples/markdown/force-app/classes/SampleClass.cls +72 -0
- package/examples/markdown/force-app/classes/SampleEnum.cls +30 -0
- package/examples/markdown/force-app/classes/SampleException.cls +17 -0
- package/examples/markdown/force-app/classes/SampleInterface.cls +50 -0
- package/examples/markdown/force-app/classes/Url.cls +194 -0
- package/examples/markdown/package-lock.json +665 -0
- package/examples/markdown/package.json +20 -0
- package/examples/markdown/sfdx-project.json +12 -0
- package/examples/vitepress/.forceignore +12 -0
- package/examples/vitepress/apexdocs.config.ts +106 -0
- package/examples/vitepress/config/project-scratch-def.json +13 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js +259 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json +40 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js +11474 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-574YRH25.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js +9172 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/chunk-E5DZZB2I.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/package.json +3 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js +4339 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js +567 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vue.js +323 -0
- package/examples/vitepress/docs/.vitepress/cache/deps/vue.js.map +7 -0
- package/examples/vitepress/docs/.vitepress/config.mts +21 -0
- package/examples/vitepress/docs/.vitepress/sidebar.json +119 -0
- package/examples/vitepress/docs/api-examples.md +49 -0
- package/examples/vitepress/docs/index-frontmatter.md +16 -0
- package/examples/vitepress/docs/index.md +56 -0
- package/examples/vitepress/docs/markdown-examples.md +85 -0
- package/examples/vitepress/docs/miscellaneous/BaseClass.md +20 -0
- package/examples/vitepress/docs/miscellaneous/MultiInheritanceClass.md +76 -0
- package/examples/vitepress/docs/miscellaneous/ParentInterface.md +19 -0
- package/examples/vitepress/docs/miscellaneous/ReferencedEnum.md +15 -0
- package/examples/vitepress/docs/miscellaneous/SampleException.md +28 -0
- package/examples/vitepress/docs/miscellaneous/SampleInterface.md +116 -0
- package/examples/vitepress/docs/miscellaneous/Url.md +317 -0
- package/examples/vitepress/docs/sample-enums/SampleEnum.md +40 -0
- package/examples/vitepress/docs/samplegroup/SampleClass.md +174 -0
- package/examples/vitepress/force-app/main/default/classes/BaseClass.cls +3 -0
- package/examples/vitepress/force-app/main/default/classes/MultiInheritanceClass.cls +1 -0
- package/examples/vitepress/force-app/main/default/classes/ParentInterface.cls +3 -0
- package/examples/vitepress/force-app/main/default/classes/ReferencedEnum.cls +5 -0
- package/examples/vitepress/force-app/main/default/classes/SampleClass.cls +72 -0
- package/examples/vitepress/force-app/main/default/classes/SampleEnum.cls +30 -0
- package/examples/vitepress/force-app/main/default/classes/SampleException.cls +17 -0
- package/examples/vitepress/force-app/main/default/classes/SampleInterface.cls +46 -0
- package/examples/vitepress/force-app/main/default/classes/Url.cls +198 -0
- package/examples/vitepress/package-lock.json +2574 -0
- package/examples/vitepress/package.json +18 -0
- package/examples/vitepress/sfdx-project.json +12 -0
- package/jest.config.js +6 -1
- package/jest.d.ts +7 -0
- package/package.json +34 -36
- package/src/application/Apexdocs.ts +58 -68
- package/src/application/__tests__/apex-file-reader.spec.ts +104 -0
- package/src/application/apex-file-reader.ts +55 -0
- package/src/application/file-system.ts +69 -0
- package/src/application/file-writer.ts +43 -0
- package/src/application/generators/markdown.ts +45 -0
- package/src/application/generators/openapi.ts +60 -0
- package/src/cli/args.ts +43 -0
- package/src/cli/commands/markdown.ts +53 -0
- package/src/cli/generate.ts +10 -131
- package/src/core/manifest.ts +90 -0
- package/src/core/markdown/__test__/expect-extensions.ts +32 -0
- package/src/core/markdown/__test__/generating-class-docs.spec.ts +733 -0
- package/src/core/markdown/__test__/generating-enum-docs.spec.ts +385 -0
- package/src/core/markdown/__test__/generating-interface-docs.spec.ts +461 -0
- package/src/core/markdown/__test__/generating-reference-guide.spec.ts +180 -0
- package/src/core/markdown/__test__/inheritance-chain.test.ts +54 -0
- package/src/core/markdown/__test__/test-helpers.ts +23 -0
- package/src/core/markdown/adapters/__tests__/documentables.spec.ts +109 -0
- package/src/core/markdown/adapters/__tests__/interface-adapter.spec.ts +148 -0
- package/src/core/markdown/adapters/__tests__/link-generator.spec.ts +130 -0
- package/src/core/markdown/adapters/__tests__/references.spec.ts +136 -0
- package/src/core/markdown/adapters/apex-types.ts +238 -0
- package/src/core/markdown/adapters/documentables.ts +115 -0
- package/src/core/markdown/adapters/fields-and-properties.ts +45 -0
- package/src/core/markdown/adapters/generate-link.ts +82 -0
- package/src/core/markdown/adapters/inline.ts +143 -0
- package/src/core/markdown/adapters/methods-and-constructors.ts +133 -0
- package/src/core/markdown/adapters/reference-guide.ts +37 -0
- package/src/core/markdown/adapters/renderable-bundle.ts +61 -0
- package/src/core/markdown/adapters/renderable-to-page-data.ts +89 -0
- package/src/core/markdown/adapters/type-utils.ts +13 -0
- package/src/core/markdown/adapters/types.d.ts +180 -0
- package/src/core/markdown/generate-docs.ts +212 -0
- package/src/core/markdown/reflection/filter-scope.ts +13 -0
- package/src/core/markdown/reflection/inheritance-chain-expanion.ts +22 -0
- package/src/core/markdown/reflection/inheritance-chain.ts +23 -0
- package/src/core/markdown/reflection/inherited-member-expansion.ts +105 -0
- package/src/core/markdown/reflection/reflect-source.ts +123 -0
- package/src/core/markdown/reflection/sort-members.ts +59 -0
- package/src/core/markdown/templates/class-template.ts +75 -0
- package/src/core/markdown/templates/constructors-partial-template.ts +32 -0
- package/src/core/markdown/templates/documentable-partial-template.ts +26 -0
- package/src/core/markdown/templates/enum-template.ts +12 -0
- package/src/core/markdown/templates/fieldsPartialTemplate.ts +23 -0
- package/src/core/markdown/templates/grouped-members-partial-template.ts +6 -0
- package/src/core/markdown/templates/hookable.ts +7 -0
- package/src/core/markdown/templates/interface-template.ts +16 -0
- package/src/core/markdown/templates/methods-partial-template.ts +43 -0
- package/src/core/markdown/templates/reference-guide.ts +14 -0
- package/src/core/markdown/templates/template.ts +114 -0
- package/src/core/markdown/templates/type-doc-partial.ts +27 -0
- package/src/core/markdown/utils.ts +3 -0
- package/src/{service → core/openapi}/__tests__/manifest-factory.spec.ts +1 -2
- package/src/{transpiler → core}/openapi/__tests__/open-api-docs-processor.spec.ts +1 -1
- package/src/{model → core/openapi}/apex-type-wrappers/__tests__/ClassMirrorWrapper.spec.ts +3 -3
- package/src/core/openapi/file-container.ts +13 -0
- package/src/{service → core/openapi}/manifest-factory.ts +3 -3
- package/src/{transpiler → core}/openapi/open-api-docs-processor.ts +10 -11
- package/src/{model → core}/openapi/open-api-types.ts +2 -2
- package/src/core/openapi/openapi-type-file.ts +12 -0
- package/src/{service → core/openapi}/parser.ts +7 -21
- package/src/{transpiler → core}/openapi/parsers/Builder.ts +3 -3
- package/src/{transpiler → core}/openapi/parsers/MethodParser.ts +6 -6
- package/src/{transpiler → core}/openapi/parsers/ParameterObjectBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/ReferenceBuilder.ts +7 -6
- package/src/{transpiler → core}/openapi/parsers/RequestBodyBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/ResponsesBuilder.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/MethodParser.spec.ts +1 -1
- package/src/{transpiler → core}/openapi/parsers/__tests__/ParameterObjectBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/ReferenceBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts +2 -2
- package/src/{transpiler → core}/openapi/parsers/__tests__/ResponsesBuilder.spec.ts +1 -1
- package/src/{transpiler → core/openapi}/transpiler.ts +2 -6
- package/src/{model → core/openapi}/types-repository.ts +0 -9
- package/src/core/parse-apex-metadata.ts +30 -0
- package/src/core/settings.ts +56 -0
- package/src/core/shared/types.d.ts +147 -0
- package/src/core/shared/utils.ts +5 -0
- package/src/defaults.ts +9 -0
- package/src/index.ts +36 -1
- package/src/test-helpers/ClassMirrorBuilder.ts +14 -1
- package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
- package/src/test-helpers/InterfaceMirrorBuilder.ts +39 -0
- package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
- package/src/test-helpers/SettingsBuilder.ts +1 -4
- package/src/util/error-logger.ts +4 -4
- package/src/util/fp.ts +3 -0
- package/src/util/logger.ts +12 -25
- package/src/util/string-utils.ts +0 -4
- package/tsconfig.json +8 -3
- package/.eslintrc.js +0 -12
- package/apexdocs.config.ts +0 -13
- package/docs/.nojekyll +0 -0
- package/docs/README.md +0 -1
- package/docs/index.html +0 -22
- package/docs/restapi.json +0 -589
- package/docs/types/Classes/nspc.AnotherInterface.md +0 -22
- package/docs/types/Classes/nspc.ChildClass.md +0 -97
- package/docs/types/Main/nspc.GroupedClass.md +0 -10
- package/docs/types/Main/nspc.SampleClass.md +0 -190
- package/docs/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
- package/docs/types/Misc-Group/nspc.GrandparentClass.md +0 -13
- package/docs/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
- package/docs/types/Misc-Group/nspc.MemberGrouping.md +0 -13
- package/docs/types/Misc-Group/nspc.ParentClass.md +0 -37
- package/docs/types/Misc-Group/nspc.Reference1.md +0 -18
- package/docs/types/Misc-Group/nspc.Reference2.md +0 -12
- package/docs/types/Misc-Group/nspc.Reference3.md +0 -7
- package/docs/types/Misc-Group/nspc.Reference4.md +0 -7
- package/docs/types/Misc-Group/nspc.Reference5.md +0 -7
- package/docs/types/Misc-Group/nspc.Reference6.md +0 -9
- package/docs/types/Misc-Group/nspc.Reference7.md +0 -7
- package/docs/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
- package/docs/types/Misc-Group/nspc.SampleRestResource.md +0 -211
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -34
- package/docs/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
- package/docs/types/README.md +0 -97
- package/docs/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
- package/examples/includes/header.md +0 -3
- package/lib/application/Apexdocs.d.ts +0 -13
- package/lib/application/Apexdocs.js +0 -77
- package/lib/application/Apexdocs.js.map +0 -1
- package/lib/cli/generate.d.ts +0 -2
- package/lib/cli/generate.js +0 -131
- package/lib/cli/generate.js.map +0 -1
- package/lib/index.d.ts +0 -1
- package/lib/index.js +0 -18
- package/lib/index.js.map +0 -1
- package/lib/model/apex-bundle.d.ts +0 -6
- package/lib/model/apex-bundle.js +0 -11
- package/lib/model/apex-bundle.js.map +0 -1
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
- package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
- package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
- package/lib/model/inheritance.d.ts +0 -8
- package/lib/model/inheritance.js +0 -3
- package/lib/model/inheritance.js.map +0 -1
- package/lib/model/manifest-diff.d.ts +0 -27
- package/lib/model/manifest-diff.js +0 -69
- package/lib/model/manifest-diff.js.map +0 -1
- package/lib/model/manifest.d.ts +0 -22
- package/lib/model/manifest.js +0 -47
- package/lib/model/manifest.js.map +0 -1
- package/lib/model/markdown-file.d.ts +0 -16
- package/lib/model/markdown-file.js +0 -107
- package/lib/model/markdown-file.js.map +0 -1
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +0 -44
- package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
- package/lib/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
- package/lib/model/markdown-generation-util/field-declaration-util.js +0 -55
- package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/index.d.ts +0 -3
- package/lib/model/markdown-generation-util/index.js +0 -20
- package/lib/model/markdown-generation-util/index.js.map +0 -1
- package/lib/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
- package/lib/model/markdown-generation-util/method-declaration-util.js +0 -115
- package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
- package/lib/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
- package/lib/model/markdown-generation-util/type-declaration-util.js +0 -82
- package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
- package/lib/model/markdown-home-file.d.ts +0 -11
- package/lib/model/markdown-home-file.js +0 -54
- package/lib/model/markdown-home-file.js.map +0 -1
- package/lib/model/markdown-type-file.d.ts +0 -26
- package/lib/model/markdown-type-file.js +0 -134
- package/lib/model/markdown-type-file.js.map +0 -1
- package/lib/model/openapi/apex-doc-types.d.ts +0 -19
- package/lib/model/openapi/apex-doc-types.js +0 -5
- package/lib/model/openapi/apex-doc-types.js.map +0 -1
- package/lib/model/openapi/open-api-types.d.ts +0 -93
- package/lib/model/openapi/open-api-types.js +0 -3
- package/lib/model/openapi/open-api-types.js.map +0 -1
- package/lib/model/openapi/open-api.d.ts +0 -16
- package/lib/model/openapi/open-api.js +0 -34
- package/lib/model/openapi/open-api.js.map +0 -1
- package/lib/model/openapi/openapi-type-file.d.ts +0 -7
- package/lib/model/openapi/openapi-type-file.js +0 -17
- package/lib/model/openapi/openapi-type-file.js.map +0 -1
- package/lib/model/outputFile.d.ts +0 -10
- package/lib/model/outputFile.js +0 -29
- package/lib/model/outputFile.js.map +0 -1
- package/lib/model/types-repository.d.ts +0 -16
- package/lib/model/types-repository.js +0 -54
- package/lib/model/types-repository.js.map +0 -1
- package/lib/service/apex-file-reader.d.ts +0 -14
- package/lib/service/apex-file-reader.js +0 -46
- package/lib/service/apex-file-reader.js.map +0 -1
- package/lib/service/file-system.d.ts +0 -14
- package/lib/service/file-system.js +0 -25
- package/lib/service/file-system.js.map +0 -1
- package/lib/service/file-writer.d.ts +0 -6
- package/lib/service/file-writer.js +0 -34
- package/lib/service/file-writer.js.map +0 -1
- package/lib/service/manifest-factory.d.ts +0 -10
- package/lib/service/manifest-factory.js +0 -14
- package/lib/service/manifest-factory.js.map +0 -1
- package/lib/service/metadata-processor.d.ts +0 -3
- package/lib/service/metadata-processor.js +0 -17
- package/lib/service/metadata-processor.js.map +0 -1
- package/lib/service/parser.d.ts +0 -21
- package/lib/service/parser.js +0 -135
- package/lib/service/parser.js.map +0 -1
- package/lib/service/state.d.ts +0 -9
- package/lib/service/state.js +0 -20
- package/lib/service/state.js.map +0 -1
- package/lib/service/walkers/class-walker.d.ts +0 -4
- package/lib/service/walkers/class-walker.js +0 -33
- package/lib/service/walkers/class-walker.js.map +0 -1
- package/lib/service/walkers/enum-walker.d.ts +0 -4
- package/lib/service/walkers/enum-walker.js +0 -11
- package/lib/service/walkers/enum-walker.js.map +0 -1
- package/lib/service/walkers/interface-walker.d.ts +0 -4
- package/lib/service/walkers/interface-walker.js +0 -15
- package/lib/service/walkers/interface-walker.js.map +0 -1
- package/lib/service/walkers/walker-factory.d.ts +0 -5
- package/lib/service/walkers/walker-factory.js +0 -21
- package/lib/service/walkers/walker-factory.js.map +0 -1
- package/lib/service/walkers/walker.d.ts +0 -19
- package/lib/service/walkers/walker.js +0 -17
- package/lib/service/walkers/walker.js.map +0 -1
- package/lib/settings.d.ts +0 -64
- package/lib/settings.js +0 -89
- package/lib/settings.js.map +0 -1
- package/lib/test-helpers/AnnotationBuilder.d.ts +0 -12
- package/lib/test-helpers/AnnotationBuilder.js +0 -31
- package/lib/test-helpers/AnnotationBuilder.js.map +0 -1
- package/lib/test-helpers/ClassMirrorBuilder.d.ts +0 -18
- package/lib/test-helpers/ClassMirrorBuilder.js +0 -54
- package/lib/test-helpers/ClassMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
- package/lib/test-helpers/DocCommentAnnotationBuilder.js +0 -26
- package/lib/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
- package/lib/test-helpers/DocCommentBuilder.d.ts +0 -12
- package/lib/test-helpers/DocCommentBuilder.js +0 -38
- package/lib/test-helpers/DocCommentBuilder.js.map +0 -1
- package/lib/test-helpers/FieldMirrorBuilder.d.ts +0 -18
- package/lib/test-helpers/FieldMirrorBuilder.js +0 -54
- package/lib/test-helpers/FieldMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/MethodMirrorBuilder.d.ts +0 -10
- package/lib/test-helpers/MethodMirrorBuilder.js +0 -37
- package/lib/test-helpers/MethodMirrorBuilder.js.map +0 -1
- package/lib/test-helpers/SettingsBuilder.d.ts +0 -8
- package/lib/test-helpers/SettingsBuilder.js +0 -27
- package/lib/test-helpers/SettingsBuilder.js.map +0 -1
- package/lib/transpiler/factory.d.ts +0 -6
- package/lib/transpiler/factory.js +0 -32
- package/lib/transpiler/factory.js.map +0 -1
- package/lib/transpiler/file-container.d.ts +0 -6
- package/lib/transpiler/file-container.js +0 -16
- package/lib/transpiler/file-container.js.map +0 -1
- package/lib/transpiler/generator-choices.d.ts +0 -1
- package/lib/transpiler/generator-choices.js +0 -3
- package/lib/transpiler/generator-choices.js.map +0 -1
- package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +0 -8
- package/lib/transpiler/markdown/class-file-generatorHelper.js +0 -56
- package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
- package/lib/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
- package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
- package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
- package/lib/transpiler/markdown/markdown-transpiler-base.js +0 -24
- package/lib/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -6
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -14
- package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
- package/lib/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
- package/lib/transpiler/openapi/open-api-docs-processor.js +0 -75
- package/lib/transpiler/openapi/open-api-docs-processor.js.map +0 -1
- package/lib/transpiler/openapi/parsers/Builder.d.ts +0 -16
- package/lib/transpiler/openapi/parsers/Builder.js +0 -30
- package/lib/transpiler/openapi/parsers/Builder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
- package/lib/transpiler/openapi/parsers/MethodParser.js +0 -167
- package/lib/transpiler/openapi/parsers/MethodParser.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
- package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +0 -226
- package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
- package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
- package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
- package/lib/transpiler/processor-type-transpiler.d.ts +0 -10
- package/lib/transpiler/processor-type-transpiler.js +0 -9
- package/lib/transpiler/processor-type-transpiler.js.map +0 -1
- package/lib/transpiler/transpiler.d.ts +0 -5
- package/lib/transpiler/transpiler.js +0 -27
- package/lib/transpiler/transpiler.js.map +0 -1
- package/lib/util/error-logger.d.ts +0 -8
- package/lib/util/error-logger.js +0 -90
- package/lib/util/error-logger.js.map +0 -1
- package/lib/util/logger.d.ts +0 -21
- package/lib/util/logger.js +0 -58
- package/lib/util/logger.js.map +0 -1
- package/lib/util/string-utils.d.ts +0 -2
- package/lib/util/string-utils.js +0 -15
- package/lib/util/string-utils.js.map +0 -1
- package/src/model/__tests__/manifest-diff.spec.ts +0 -147
- package/src/model/apex-bundle.ts +0 -3
- package/src/model/inheritance.ts +0 -7
- package/src/model/manifest-diff.ts +0 -94
- package/src/model/manifest.ts +0 -74
- package/src/model/markdown-file.ts +0 -121
- package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +0 -50
- package/src/model/markdown-generation-util/field-declaration-util.ts +0 -71
- package/src/model/markdown-generation-util/index.ts +0 -3
- package/src/model/markdown-generation-util/method-declaration-util.ts +0 -166
- package/src/model/markdown-generation-util/type-declaration-util.ts +0 -91
- package/src/model/markdown-home-file.ts +0 -58
- package/src/model/markdown-type-file.ts +0 -165
- package/src/model/openapi/openapi-type-file.ts +0 -14
- package/src/model/outputFile.ts +0 -29
- package/src/service/__tests__/apex-file-reader.spec.ts +0 -92
- package/src/service/apex-file-reader.ts +0 -51
- package/src/service/file-system.ts +0 -33
- package/src/service/file-writer.ts +0 -34
- package/src/service/metadata-processor.ts +0 -16
- package/src/service/state.ts +0 -24
- package/src/service/walkers/class-walker.ts +0 -30
- package/src/service/walkers/enum-walker.ts +0 -7
- package/src/service/walkers/interface-walker.ts +0 -12
- package/src/service/walkers/walker-factory.ts +0 -19
- package/src/service/walkers/walker.ts +0 -42
- package/src/settings.ts +0 -147
- package/src/transpiler/factory.ts +0 -33
- package/src/transpiler/file-container.ts +0 -13
- package/src/transpiler/generator-choices.ts +0 -1
- package/src/transpiler/markdown/class-file-generatorHelper.ts +0 -58
- package/src/transpiler/markdown/docsify/docsify-docs-processor.ts +0 -12
- package/src/transpiler/markdown/jekyll/jekyll-docsProcessor.ts +0 -50
- package/src/transpiler/markdown/markdown-transpiler-base.ts +0 -28
- package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -12
- package/src/transpiler/processor-type-transpiler.ts +0 -18
- /package/src/{model/__tests__ → core/__test__}/manifest.spec.ts +0 -0
- /package/src/{model → core}/openapi/__tests__/open-api.spec.ts +0 -0
- /package/src/{model → core}/openapi/apex-doc-types.ts +0 -0
- /package/src/{model → core/openapi}/apex-type-wrappers/ClassMirrorWrapper.ts +0 -0
- /package/src/{model → core/openapi}/apex-type-wrappers/MethodMirrorWrapper.ts +0 -0
- /package/src/{model → core}/openapi/open-api.ts +0 -0
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
import {
|
|
2
|
+
BaseTransition,
|
|
3
|
+
BaseTransitionPropsValidators,
|
|
4
|
+
Comment,
|
|
5
|
+
DeprecationTypes,
|
|
6
|
+
EffectScope,
|
|
7
|
+
ErrorCodes,
|
|
8
|
+
ErrorTypeStrings,
|
|
9
|
+
Fragment,
|
|
10
|
+
KeepAlive,
|
|
11
|
+
ReactiveEffect,
|
|
12
|
+
Static,
|
|
13
|
+
Suspense,
|
|
14
|
+
Teleport,
|
|
15
|
+
Text,
|
|
16
|
+
TrackOpTypes,
|
|
17
|
+
Transition,
|
|
18
|
+
TransitionGroup,
|
|
19
|
+
TriggerOpTypes,
|
|
20
|
+
VueElement,
|
|
21
|
+
assertNumber,
|
|
22
|
+
callWithAsyncErrorHandling,
|
|
23
|
+
callWithErrorHandling,
|
|
24
|
+
camelize,
|
|
25
|
+
capitalize,
|
|
26
|
+
cloneVNode,
|
|
27
|
+
compatUtils,
|
|
28
|
+
compile,
|
|
29
|
+
computed,
|
|
30
|
+
createApp,
|
|
31
|
+
createBaseVNode,
|
|
32
|
+
createBlock,
|
|
33
|
+
createCommentVNode,
|
|
34
|
+
createElementBlock,
|
|
35
|
+
createHydrationRenderer,
|
|
36
|
+
createPropsRestProxy,
|
|
37
|
+
createRenderer,
|
|
38
|
+
createSSRApp,
|
|
39
|
+
createSlots,
|
|
40
|
+
createStaticVNode,
|
|
41
|
+
createTextVNode,
|
|
42
|
+
createVNode,
|
|
43
|
+
customRef,
|
|
44
|
+
defineAsyncComponent,
|
|
45
|
+
defineComponent,
|
|
46
|
+
defineCustomElement,
|
|
47
|
+
defineEmits,
|
|
48
|
+
defineExpose,
|
|
49
|
+
defineModel,
|
|
50
|
+
defineOptions,
|
|
51
|
+
defineProps,
|
|
52
|
+
defineSSRCustomElement,
|
|
53
|
+
defineSlots,
|
|
54
|
+
devtools,
|
|
55
|
+
effect,
|
|
56
|
+
effectScope,
|
|
57
|
+
getCurrentInstance,
|
|
58
|
+
getCurrentScope,
|
|
59
|
+
getTransitionRawChildren,
|
|
60
|
+
guardReactiveProps,
|
|
61
|
+
h,
|
|
62
|
+
handleError,
|
|
63
|
+
hasInjectionContext,
|
|
64
|
+
hydrate,
|
|
65
|
+
initCustomFormatter,
|
|
66
|
+
initDirectivesForSSR,
|
|
67
|
+
inject,
|
|
68
|
+
isMemoSame,
|
|
69
|
+
isProxy,
|
|
70
|
+
isReactive,
|
|
71
|
+
isReadonly,
|
|
72
|
+
isRef,
|
|
73
|
+
isRuntimeOnly,
|
|
74
|
+
isShallow,
|
|
75
|
+
isVNode,
|
|
76
|
+
markRaw,
|
|
77
|
+
mergeDefaults,
|
|
78
|
+
mergeModels,
|
|
79
|
+
mergeProps,
|
|
80
|
+
nextTick,
|
|
81
|
+
normalizeClass,
|
|
82
|
+
normalizeProps,
|
|
83
|
+
normalizeStyle,
|
|
84
|
+
onActivated,
|
|
85
|
+
onBeforeMount,
|
|
86
|
+
onBeforeUnmount,
|
|
87
|
+
onBeforeUpdate,
|
|
88
|
+
onDeactivated,
|
|
89
|
+
onErrorCaptured,
|
|
90
|
+
onMounted,
|
|
91
|
+
onRenderTracked,
|
|
92
|
+
onRenderTriggered,
|
|
93
|
+
onScopeDispose,
|
|
94
|
+
onServerPrefetch,
|
|
95
|
+
onUnmounted,
|
|
96
|
+
onUpdated,
|
|
97
|
+
openBlock,
|
|
98
|
+
popScopeId,
|
|
99
|
+
provide,
|
|
100
|
+
proxyRefs,
|
|
101
|
+
pushScopeId,
|
|
102
|
+
queuePostFlushCb,
|
|
103
|
+
reactive,
|
|
104
|
+
readonly,
|
|
105
|
+
ref,
|
|
106
|
+
registerRuntimeCompiler,
|
|
107
|
+
render,
|
|
108
|
+
renderList,
|
|
109
|
+
renderSlot,
|
|
110
|
+
resolveComponent,
|
|
111
|
+
resolveDirective,
|
|
112
|
+
resolveDynamicComponent,
|
|
113
|
+
resolveFilter,
|
|
114
|
+
resolveTransitionHooks,
|
|
115
|
+
setBlockTracking,
|
|
116
|
+
setDevtoolsHook,
|
|
117
|
+
setTransitionHooks,
|
|
118
|
+
shallowReactive,
|
|
119
|
+
shallowReadonly,
|
|
120
|
+
shallowRef,
|
|
121
|
+
ssrContextKey,
|
|
122
|
+
ssrUtils,
|
|
123
|
+
stop,
|
|
124
|
+
toDisplayString,
|
|
125
|
+
toHandlerKey,
|
|
126
|
+
toHandlers,
|
|
127
|
+
toRaw,
|
|
128
|
+
toRef,
|
|
129
|
+
toRefs,
|
|
130
|
+
toValue,
|
|
131
|
+
transformVNodeArgs,
|
|
132
|
+
triggerRef,
|
|
133
|
+
unref,
|
|
134
|
+
useAttrs,
|
|
135
|
+
useCssModule,
|
|
136
|
+
useCssVars,
|
|
137
|
+
useModel,
|
|
138
|
+
useSSRContext,
|
|
139
|
+
useSlots,
|
|
140
|
+
useTransitionState,
|
|
141
|
+
vModelCheckbox,
|
|
142
|
+
vModelDynamic,
|
|
143
|
+
vModelRadio,
|
|
144
|
+
vModelSelect,
|
|
145
|
+
vModelText,
|
|
146
|
+
vShow,
|
|
147
|
+
version,
|
|
148
|
+
warn,
|
|
149
|
+
watch,
|
|
150
|
+
watchEffect,
|
|
151
|
+
watchPostEffect,
|
|
152
|
+
watchSyncEffect,
|
|
153
|
+
withAsyncContext,
|
|
154
|
+
withCtx,
|
|
155
|
+
withDefaults,
|
|
156
|
+
withDirectives,
|
|
157
|
+
withKeys,
|
|
158
|
+
withMemo,
|
|
159
|
+
withModifiers,
|
|
160
|
+
withScopeId
|
|
161
|
+
} from "./chunk-574YRH25.js";
|
|
162
|
+
export {
|
|
163
|
+
BaseTransition,
|
|
164
|
+
BaseTransitionPropsValidators,
|
|
165
|
+
Comment,
|
|
166
|
+
DeprecationTypes,
|
|
167
|
+
EffectScope,
|
|
168
|
+
ErrorCodes,
|
|
169
|
+
ErrorTypeStrings,
|
|
170
|
+
Fragment,
|
|
171
|
+
KeepAlive,
|
|
172
|
+
ReactiveEffect,
|
|
173
|
+
Static,
|
|
174
|
+
Suspense,
|
|
175
|
+
Teleport,
|
|
176
|
+
Text,
|
|
177
|
+
TrackOpTypes,
|
|
178
|
+
Transition,
|
|
179
|
+
TransitionGroup,
|
|
180
|
+
TriggerOpTypes,
|
|
181
|
+
VueElement,
|
|
182
|
+
assertNumber,
|
|
183
|
+
callWithAsyncErrorHandling,
|
|
184
|
+
callWithErrorHandling,
|
|
185
|
+
camelize,
|
|
186
|
+
capitalize,
|
|
187
|
+
cloneVNode,
|
|
188
|
+
compatUtils,
|
|
189
|
+
compile,
|
|
190
|
+
computed,
|
|
191
|
+
createApp,
|
|
192
|
+
createBlock,
|
|
193
|
+
createCommentVNode,
|
|
194
|
+
createElementBlock,
|
|
195
|
+
createBaseVNode as createElementVNode,
|
|
196
|
+
createHydrationRenderer,
|
|
197
|
+
createPropsRestProxy,
|
|
198
|
+
createRenderer,
|
|
199
|
+
createSSRApp,
|
|
200
|
+
createSlots,
|
|
201
|
+
createStaticVNode,
|
|
202
|
+
createTextVNode,
|
|
203
|
+
createVNode,
|
|
204
|
+
customRef,
|
|
205
|
+
defineAsyncComponent,
|
|
206
|
+
defineComponent,
|
|
207
|
+
defineCustomElement,
|
|
208
|
+
defineEmits,
|
|
209
|
+
defineExpose,
|
|
210
|
+
defineModel,
|
|
211
|
+
defineOptions,
|
|
212
|
+
defineProps,
|
|
213
|
+
defineSSRCustomElement,
|
|
214
|
+
defineSlots,
|
|
215
|
+
devtools,
|
|
216
|
+
effect,
|
|
217
|
+
effectScope,
|
|
218
|
+
getCurrentInstance,
|
|
219
|
+
getCurrentScope,
|
|
220
|
+
getTransitionRawChildren,
|
|
221
|
+
guardReactiveProps,
|
|
222
|
+
h,
|
|
223
|
+
handleError,
|
|
224
|
+
hasInjectionContext,
|
|
225
|
+
hydrate,
|
|
226
|
+
initCustomFormatter,
|
|
227
|
+
initDirectivesForSSR,
|
|
228
|
+
inject,
|
|
229
|
+
isMemoSame,
|
|
230
|
+
isProxy,
|
|
231
|
+
isReactive,
|
|
232
|
+
isReadonly,
|
|
233
|
+
isRef,
|
|
234
|
+
isRuntimeOnly,
|
|
235
|
+
isShallow,
|
|
236
|
+
isVNode,
|
|
237
|
+
markRaw,
|
|
238
|
+
mergeDefaults,
|
|
239
|
+
mergeModels,
|
|
240
|
+
mergeProps,
|
|
241
|
+
nextTick,
|
|
242
|
+
normalizeClass,
|
|
243
|
+
normalizeProps,
|
|
244
|
+
normalizeStyle,
|
|
245
|
+
onActivated,
|
|
246
|
+
onBeforeMount,
|
|
247
|
+
onBeforeUnmount,
|
|
248
|
+
onBeforeUpdate,
|
|
249
|
+
onDeactivated,
|
|
250
|
+
onErrorCaptured,
|
|
251
|
+
onMounted,
|
|
252
|
+
onRenderTracked,
|
|
253
|
+
onRenderTriggered,
|
|
254
|
+
onScopeDispose,
|
|
255
|
+
onServerPrefetch,
|
|
256
|
+
onUnmounted,
|
|
257
|
+
onUpdated,
|
|
258
|
+
openBlock,
|
|
259
|
+
popScopeId,
|
|
260
|
+
provide,
|
|
261
|
+
proxyRefs,
|
|
262
|
+
pushScopeId,
|
|
263
|
+
queuePostFlushCb,
|
|
264
|
+
reactive,
|
|
265
|
+
readonly,
|
|
266
|
+
ref,
|
|
267
|
+
registerRuntimeCompiler,
|
|
268
|
+
render,
|
|
269
|
+
renderList,
|
|
270
|
+
renderSlot,
|
|
271
|
+
resolveComponent,
|
|
272
|
+
resolveDirective,
|
|
273
|
+
resolveDynamicComponent,
|
|
274
|
+
resolveFilter,
|
|
275
|
+
resolveTransitionHooks,
|
|
276
|
+
setBlockTracking,
|
|
277
|
+
setDevtoolsHook,
|
|
278
|
+
setTransitionHooks,
|
|
279
|
+
shallowReactive,
|
|
280
|
+
shallowReadonly,
|
|
281
|
+
shallowRef,
|
|
282
|
+
ssrContextKey,
|
|
283
|
+
ssrUtils,
|
|
284
|
+
stop,
|
|
285
|
+
toDisplayString,
|
|
286
|
+
toHandlerKey,
|
|
287
|
+
toHandlers,
|
|
288
|
+
toRaw,
|
|
289
|
+
toRef,
|
|
290
|
+
toRefs,
|
|
291
|
+
toValue,
|
|
292
|
+
transformVNodeArgs,
|
|
293
|
+
triggerRef,
|
|
294
|
+
unref,
|
|
295
|
+
useAttrs,
|
|
296
|
+
useCssModule,
|
|
297
|
+
useCssVars,
|
|
298
|
+
useModel,
|
|
299
|
+
useSSRContext,
|
|
300
|
+
useSlots,
|
|
301
|
+
useTransitionState,
|
|
302
|
+
vModelCheckbox,
|
|
303
|
+
vModelDynamic,
|
|
304
|
+
vModelRadio,
|
|
305
|
+
vModelSelect,
|
|
306
|
+
vModelText,
|
|
307
|
+
vShow,
|
|
308
|
+
version,
|
|
309
|
+
warn,
|
|
310
|
+
watch,
|
|
311
|
+
watchEffect,
|
|
312
|
+
watchPostEffect,
|
|
313
|
+
watchSyncEffect,
|
|
314
|
+
withAsyncContext,
|
|
315
|
+
withCtx,
|
|
316
|
+
withDefaults,
|
|
317
|
+
withDirectives,
|
|
318
|
+
withKeys,
|
|
319
|
+
withMemo,
|
|
320
|
+
withModifiers,
|
|
321
|
+
withScopeId
|
|
322
|
+
};
|
|
323
|
+
//# sourceMappingURL=vue.js.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { defineConfig } from 'vitepress'
|
|
2
|
+
import * as sidebar from './sidebar.json';
|
|
3
|
+
|
|
4
|
+
// https://vitepress.dev/reference/site-config
|
|
5
|
+
export default defineConfig({
|
|
6
|
+
title: "Apexdocs Vitepress Example",
|
|
7
|
+
description: "Apexdocs Vitepress Example",
|
|
8
|
+
themeConfig: {
|
|
9
|
+
// https://vitepress.dev/reference/default-theme-config
|
|
10
|
+
nav: [
|
|
11
|
+
{ text: 'Home', link: '/' },
|
|
12
|
+
{ text: 'Examples', link: '/markdown-examples' }
|
|
13
|
+
],
|
|
14
|
+
|
|
15
|
+
sidebar: sidebar.default,
|
|
16
|
+
|
|
17
|
+
socialLinks: [
|
|
18
|
+
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
|
|
19
|
+
]
|
|
20
|
+
}
|
|
21
|
+
})
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"text": "API Reference",
|
|
4
|
+
"items": [
|
|
5
|
+
{
|
|
6
|
+
"text": "Grouped By Type",
|
|
7
|
+
"items": [
|
|
8
|
+
{
|
|
9
|
+
"text": "Classes",
|
|
10
|
+
"items": [
|
|
11
|
+
{
|
|
12
|
+
"text": "BaseClass",
|
|
13
|
+
"link": "miscellaneous/BaseClass.md"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"text": "MultiInheritanceClass",
|
|
17
|
+
"link": "miscellaneous/MultiInheritanceClass.md"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"text": "SampleClass",
|
|
21
|
+
"link": "samplegroup/SampleClass.md"
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"text": "SampleException",
|
|
25
|
+
"link": "miscellaneous/SampleException.md"
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"text": "Url",
|
|
29
|
+
"link": "miscellaneous/Url.md"
|
|
30
|
+
}
|
|
31
|
+
]
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"text": "Interfaces",
|
|
35
|
+
"items": [
|
|
36
|
+
{
|
|
37
|
+
"text": "ParentInterface",
|
|
38
|
+
"link": "miscellaneous/ParentInterface.md"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"text": "SampleInterface",
|
|
42
|
+
"link": "miscellaneous/SampleInterface.md"
|
|
43
|
+
}
|
|
44
|
+
]
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"text": "Enums",
|
|
48
|
+
"items": [
|
|
49
|
+
{
|
|
50
|
+
"text": "ReferencedEnum",
|
|
51
|
+
"link": "miscellaneous/ReferencedEnum.md"
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"text": "SampleEnum",
|
|
55
|
+
"link": "sample-enums/SampleEnum.md"
|
|
56
|
+
}
|
|
57
|
+
]
|
|
58
|
+
}
|
|
59
|
+
]
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"text": "Grouped by Group",
|
|
63
|
+
"items": [
|
|
64
|
+
{
|
|
65
|
+
"text": "Miscellaneous",
|
|
66
|
+
"items": [
|
|
67
|
+
{
|
|
68
|
+
"text": "BaseClass",
|
|
69
|
+
"link": "miscellaneous/BaseClass.md"
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"text": "MultiInheritanceClass",
|
|
73
|
+
"link": "miscellaneous/MultiInheritanceClass.md"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"text": "ParentInterface",
|
|
77
|
+
"link": "miscellaneous/ParentInterface.md"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"text": "ReferencedEnum",
|
|
81
|
+
"link": "miscellaneous/ReferencedEnum.md"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"text": "SampleException",
|
|
85
|
+
"link": "miscellaneous/SampleException.md"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"text": "SampleInterface",
|
|
89
|
+
"link": "miscellaneous/SampleInterface.md"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"text": "Url",
|
|
93
|
+
"link": "miscellaneous/Url.md"
|
|
94
|
+
}
|
|
95
|
+
]
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"text": "SampleGroup",
|
|
99
|
+
"items": [
|
|
100
|
+
{
|
|
101
|
+
"text": "SampleClass",
|
|
102
|
+
"link": "samplegroup/SampleClass.md"
|
|
103
|
+
}
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"text": "Sample Enums",
|
|
108
|
+
"items": [
|
|
109
|
+
{
|
|
110
|
+
"text": "SampleEnum",
|
|
111
|
+
"link": "sample-enums/SampleEnum.md"
|
|
112
|
+
}
|
|
113
|
+
]
|
|
114
|
+
}
|
|
115
|
+
]
|
|
116
|
+
}
|
|
117
|
+
]
|
|
118
|
+
}
|
|
119
|
+
]
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
outline: deep
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Runtime API Examples
|
|
6
|
+
|
|
7
|
+
This page demonstrates usage of some of the runtime APIs provided by VitePress.
|
|
8
|
+
|
|
9
|
+
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
|
|
10
|
+
|
|
11
|
+
```md
|
|
12
|
+
<script setup>
|
|
13
|
+
import { useData } from 'vitepress'
|
|
14
|
+
|
|
15
|
+
const { theme, page, frontmatter } = useData()
|
|
16
|
+
</script>
|
|
17
|
+
|
|
18
|
+
## Results
|
|
19
|
+
|
|
20
|
+
### Theme Data
|
|
21
|
+
<pre>{{ theme }}</pre>
|
|
22
|
+
|
|
23
|
+
### Page Data
|
|
24
|
+
<pre>{{ page }}</pre>
|
|
25
|
+
|
|
26
|
+
### Page Frontmatter
|
|
27
|
+
<pre>{{ frontmatter }}</pre>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
<script setup>
|
|
31
|
+
import { useData } from 'vitepress'
|
|
32
|
+
|
|
33
|
+
const { site, theme, page, frontmatter } = useData()
|
|
34
|
+
</script>
|
|
35
|
+
|
|
36
|
+
## Results
|
|
37
|
+
|
|
38
|
+
### Theme Data
|
|
39
|
+
<pre>{{ theme }}</pre>
|
|
40
|
+
|
|
41
|
+
### Page Data
|
|
42
|
+
<pre>{{ page }}</pre>
|
|
43
|
+
|
|
44
|
+
### Page Frontmatter
|
|
45
|
+
<pre>{{ frontmatter }}</pre>
|
|
46
|
+
|
|
47
|
+
## More
|
|
48
|
+
|
|
49
|
+
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
# https://vitepress.dev/reference/default-theme-home-page
|
|
3
|
+
layout: home
|
|
4
|
+
|
|
5
|
+
hero:
|
|
6
|
+
name: "Apexdocs Vitepress Example"
|
|
7
|
+
text: "API Documentation"
|
|
8
|
+
tagline: My great project tagline
|
|
9
|
+
actions:
|
|
10
|
+
- theme: brand
|
|
11
|
+
text: Markdown Examples
|
|
12
|
+
link: /markdown-examples
|
|
13
|
+
- theme: alt
|
|
14
|
+
text: API Examples
|
|
15
|
+
link: /api-examples
|
|
16
|
+
---
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
# https://vitepress.dev/reference/default-theme-home-page
|
|
3
|
+
layout: home
|
|
4
|
+
|
|
5
|
+
hero:
|
|
6
|
+
name: "Apexdocs Vitepress Example"
|
|
7
|
+
text: "API Documentation"
|
|
8
|
+
tagline: My great project tagline
|
|
9
|
+
actions:
|
|
10
|
+
- theme: brand
|
|
11
|
+
text: Markdown Examples
|
|
12
|
+
link: /markdown-examples
|
|
13
|
+
- theme: alt
|
|
14
|
+
text: API Examples
|
|
15
|
+
link: /api-examples
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
# Apex Reference Guide
|
|
19
|
+
|
|
20
|
+
## Miscellaneous
|
|
21
|
+
|
|
22
|
+
### [BaseClass](miscellaneous/BaseClass.md)
|
|
23
|
+
|
|
24
|
+
### [MultiInheritanceClass](miscellaneous/MultiInheritanceClass.md)
|
|
25
|
+
|
|
26
|
+
### [ParentInterface](miscellaneous/ParentInterface.md)
|
|
27
|
+
|
|
28
|
+
### [ReferencedEnum](miscellaneous/ReferencedEnum.md)
|
|
29
|
+
|
|
30
|
+
### [SampleException](miscellaneous/SampleException.md)
|
|
31
|
+
|
|
32
|
+
This is a sample exception.
|
|
33
|
+
|
|
34
|
+
### [SampleInterface](miscellaneous/SampleInterface.md)
|
|
35
|
+
|
|
36
|
+
This is a sample interface
|
|
37
|
+
|
|
38
|
+
### [Url](miscellaneous/Url.md)
|
|
39
|
+
|
|
40
|
+
Represents a uniform resource locator (URL) and provides access to parts of the URL.
|
|
41
|
+
Enables access to the base URL used to access your Salesforce org.
|
|
42
|
+
|
|
43
|
+
## Sample Enums
|
|
44
|
+
|
|
45
|
+
### [SampleEnum](sample-enums/SampleEnum.md)
|
|
46
|
+
|
|
47
|
+
This is a sample enum. This references [ReferencedEnum](miscellaneous/ReferencedEnum.md) .
|
|
48
|
+
|
|
49
|
+
This description has several lines
|
|
50
|
+
|
|
51
|
+
## SampleGroup
|
|
52
|
+
|
|
53
|
+
### [SampleClass](samplegroup/SampleClass.md)
|
|
54
|
+
|
|
55
|
+
aliquip ex sunt officia ullamco anim deserunt magna aliquip nisi eiusmod in sit officia veniam ex
|
|
56
|
+
deserunt ea officia exercitation laboris enim in duis quis enim eiusmod eu amet cupidatat.
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Markdown Extension Examples
|
|
2
|
+
|
|
3
|
+
This page demonstrates some of the built-in markdown extensions provided by VitePress.
|
|
4
|
+
|
|
5
|
+
## Syntax Highlighting
|
|
6
|
+
|
|
7
|
+
VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
|
|
8
|
+
|
|
9
|
+
**Input**
|
|
10
|
+
|
|
11
|
+
````md
|
|
12
|
+
```js{4}
|
|
13
|
+
export default {
|
|
14
|
+
data () {
|
|
15
|
+
return {
|
|
16
|
+
msg: 'Highlighted!'
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
````
|
|
22
|
+
|
|
23
|
+
**Output**
|
|
24
|
+
|
|
25
|
+
```js{4}
|
|
26
|
+
export default {
|
|
27
|
+
data () {
|
|
28
|
+
return {
|
|
29
|
+
msg: 'Highlighted!'
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Custom Containers
|
|
36
|
+
|
|
37
|
+
**Input**
|
|
38
|
+
|
|
39
|
+
```md
|
|
40
|
+
::: info
|
|
41
|
+
This is an info box.
|
|
42
|
+
:::
|
|
43
|
+
|
|
44
|
+
::: tip
|
|
45
|
+
This is a tip.
|
|
46
|
+
:::
|
|
47
|
+
|
|
48
|
+
::: warning
|
|
49
|
+
This is a warning.
|
|
50
|
+
:::
|
|
51
|
+
|
|
52
|
+
::: danger
|
|
53
|
+
This is a dangerous warning.
|
|
54
|
+
:::
|
|
55
|
+
|
|
56
|
+
::: details
|
|
57
|
+
This is a details block.
|
|
58
|
+
:::
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
**Output**
|
|
62
|
+
|
|
63
|
+
::: info
|
|
64
|
+
This is an info box.
|
|
65
|
+
:::
|
|
66
|
+
|
|
67
|
+
::: tip
|
|
68
|
+
This is a tip.
|
|
69
|
+
:::
|
|
70
|
+
|
|
71
|
+
::: warning
|
|
72
|
+
This is a warning.
|
|
73
|
+
:::
|
|
74
|
+
|
|
75
|
+
::: danger
|
|
76
|
+
This is a dangerous warning.
|
|
77
|
+
:::
|
|
78
|
+
|
|
79
|
+
::: details
|
|
80
|
+
This is a details block.
|
|
81
|
+
:::
|
|
82
|
+
|
|
83
|
+
## More
|
|
84
|
+
|
|
85
|
+
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: BaseClass
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# BaseClass Class
|
|
6
|
+
`abstract`
|
|
7
|
+
|
|
8
|
+
## Namespace
|
|
9
|
+
apexdocs
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
### `sampleEnumFromBase`
|
|
13
|
+
|
|
14
|
+
#### Signature
|
|
15
|
+
```apex
|
|
16
|
+
public sampleEnumFromBase
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
#### Type
|
|
20
|
+
[SampleEnum](../sample-enums/SampleEnum.md)
|