This project is not an actual, working, Apex project! This is a mock codebase, intended only to demonstrate the ApexDox VSCode project. Throughout its .cls files, you will find "doc block" comments (see example), which self-document each file. When the ApexDox VSCode extension is run on this project, these comments will be parsed and converted into static documentation. The generated documentation can be viewed here.
To test this out, clone this repository and open it in VSCode. Then install the ApexDox VSCode extension and use its built-in commands.
You can launch the following commands via the command pallette (Ctrl/Cmd + Shift + P):
- ApexDox: Run: Run ApexDox. Many aspects of how this command behaves can be configured using the settings below.
- ApexDox: Open Docs: Launch a server on localhost and open the generated documentation.
- ApexDox: Stub Comment Block: On the line above a method, class/interface, property, or enum, invoke this command to stub an ApexDox comment based on the current context. This command can also be invoked by completion item: type
/**and press Tab when prompted. The appearance / style of comment stubs can be configured using the settings below.
The output documentation can be configured using the settings in .vscode/settings.json, or, if enabled, the settings in .apexdoxrc or apexdox.yml (both of which will take precedence over settings.json, if present). See the ApexDox VS Code extension's README for more information.
The majority of the code in this sample app is taken from Salesforce's Dreamhouse app. To see or install the actual Dreamhouse application, visit: https://github.com/dreamhouseapp/dreamhouse-sfdx.