@cparra/apexdocs 2.13.0 → 2.14.0

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 (29) hide show
  1. package/README.md +2 -0
  2. package/docs/Main/nspc.SampleClass.md +0 -4
  3. package/docs/restapi.json +589 -589
  4. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  5. package/lib/cli/generate.js +12 -0
  6. package/lib/cli/generate.js.map +1 -1
  7. package/lib/model/markdown-home-file.js +1 -1
  8. package/lib/model/markdown-home-file.js.map +1 -1
  9. package/lib/service/apex-file-reader.js +4 -1
  10. package/lib/service/apex-file-reader.js.map +1 -1
  11. package/lib/service/parser.d.ts +1 -1
  12. package/lib/service/parser.js +9 -11
  13. package/lib/service/parser.js.map +1 -1
  14. package/lib/settings.d.ts +4 -0
  15. package/lib/settings.js +8 -1
  16. package/lib/settings.js.map +1 -1
  17. package/lib/test-helpers/SettingsBuilder.js +2 -0
  18. package/lib/test-helpers/SettingsBuilder.js.map +1 -1
  19. package/lib/transpiler/transpiler.js +1 -1
  20. package/lib/transpiler/transpiler.js.map +1 -1
  21. package/package.json +3 -3
  22. package/src/cli/generate.ts +12 -0
  23. package/src/model/markdown-home-file.ts +1 -1
  24. package/src/service/__tests__/apex-file-reader.spec.ts +2 -0
  25. package/src/service/apex-file-reader.ts +5 -1
  26. package/src/service/parser.ts +36 -41
  27. package/src/settings.ts +11 -1
  28. package/src/test-helpers/SettingsBuilder.ts +2 -0
  29. package/src/transpiler/transpiler.ts +1 -1
package/README.md CHANGED
@@ -129,8 +129,10 @@ The CLI supports the following parameters:
129
129
  | --defaultGroupName | N/A | Defines the `@group` name to be used when a file does not specify it. | `Miscellaneous` | No |
130
130
  | --sanitizeHtml | N/A | When on, any special character within your ApexDocs is converted into its HTML code representation. This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" because otherwise the content within < and > would be treated as HTML tags and not shown in the output. Content in @example blocks are never sanitized. | `Apex REST Api` | No |
131
131
  | --openApiTitle | N/A | If using "openapi" as the target generator, this allows you to specify the OpenApi title value. | true | No |
132
+ | --title | N/A | Allows you to specify the home page main title. If using "openapi" this acts as an alias to the openApiTitle parameter | `Classes` | No |
132
133
  | --namespace | N/A | The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. If generating an OpenApi definition, it will be added to the file's Server Url. | N/A | No |
133
134
  | --openApiFileName | N/A | If using "openapi" as the target generator, this allows you to specify the name of the output file. | `openapi` | No |
135
+ | --includeMetadata | N/A | Whether to include the file's meta.xml information: Whether it is active and and the API version | false | No |
134
136
 
135
137
  ### Importing to your project
136
138
 
package/docs/Main/nspc.SampleClass.md CHANGED
@@ -2,10 +2,6 @@
2
2
 
3
3
  `NAMESPACEACCESSIBLE`
4
4
 
5
- `APIVERSION: 54`
6
-
7
- `STATUS: ACTIVE`
8
-
9
5
  This is a class description. This class relates to [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)
10
6
  But this [ClassThatDoesNotExist](ClassThatDoesNotExist) does not exist.
11
7
  You can also link using this syntax [nspc.SampleInterface](/Sample-Interfaces/nspc.SampleInterface.md)