diff options
| author | ArielG-NV <159081215+ArielG-NV@users.noreply.github.com> | 2024-09-05 10:41:35 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-05 10:41:35 -0400 |
| commit | d4aeb18cb348104fa6b036393488df780902a353 (patch) | |
| tree | 33b27291c90b46664086c303b30e080dcd2508a9 /docs/user-guide/a3-reference.md | |
| parent | 65dd3b7a5170898f05fb7c368272717a3ec9980e (diff) | |
Document All Capability Atoms and Profiles (#5008)
* Document All Capability Atoms and Profiles
Fixes: #4125
Unimplemented Considerations:
1. This PR does not add support to query all capability-atom's from a command-line option. It is understood that this might be desired, due to this, the logic to generate `docs\user-guide\a3-02-reference-capability-atoms.md` was made to be "command-line friendly" so minimal changes are needed to pipe our documentation into a command-line option if this change is to be added.
Changes:
1. Added a way to document atoms inside `.capdef`. Method to document is described under `source\slang\slang-capabilities.capdef`. The goal is to error if a public atom does not have any form of documentation to ensure we always have up-to-date documentation to guide user on what an atom is/does.
* The following `.capdef` file syntax was added
* /// [HEADER_GROUP]
* /// regular comment
2. When capability generator runs it auto-generates `docs\user-guide\a3-02-reference-capability-atoms.md`
3. Added to the user-guide 3 sections: `Reference`, `Reference -> Capability Profiles`, `Reference -> Capability atoms` section
Diffstat (limited to 'docs/user-guide/a3-reference.md')
| -rw-r--r-- | docs/user-guide/a3-reference.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/user-guide/a3-reference.md b/docs/user-guide/a3-reference.md new file mode 100644 index 000000000..da9d443c9 --- /dev/null +++ b/docs/user-guide/a3-reference.md @@ -0,0 +1,11 @@ +--- +layout: user-guide +permalink: /user-guide/reference +--- + +Reference +============================ + +In this chapter: +1. [Reference for all Capability Profiles](a3-01-Reference-Capability-Profiles) +2. [Reference for all Capability Atoms](a3-02-Reference-Capability-Atoms)
\ No newline at end of file |