Nicholas Chin has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/87231?usp=email )
Change subject: [POC] Docs/lib/timestamp.md: Use Breathe to generate API documentation ......................................................................
[POC] Docs/lib/timestamp.md: Use Breathe to generate API documentation
API documentation written on doc.coreboot.org is likely to go out of date when the code is changed, whereas docstrings directly in the code are more likely to be updated. As a proof of concept, use Breathe to pull the Doxygen function documentation for `include/timestamp.h` into our markdown documentation.
To view and build this, do one of the following:
1. Install the following python3 modules: - sphinx - myst-parser - sphinx_rtd_theme - breathe 2. Install Doxygen 3. Run `make` from the `Documentation` folder. The output will be in `Documentation/_build/html`
[1] https://doc.coreboot.org/getting_started/writing_documentation.html
Change-Id: Iae85a33f11fe9dbe11943e63a4f1dfc95ccc0bf9 Signed-off-by: Nicholas Chin nic.c3.14@gmail.com --- M Documentation/lib/timestamp.md 1 file changed, 6 insertions(+), 16 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/31/87231/1
diff --git a/Documentation/lib/timestamp.md b/Documentation/lib/timestamp.md index a769f99..bb0f51b 100644 --- a/Documentation/lib/timestamp.md +++ b/Documentation/lib/timestamp.md @@ -122,24 +122,14 @@
## Function APIs
-### timestamp_init +```{doxygenfunction} timestamp_init +```
-This function initializes the timestamp cache and should be run as early -as possible. On platforms with SRAM, this might mean in bootblock, on -x86 with its CAR backed memory in romstage, this means romstage before -memory init. +```{doxygenfunction} timestamp_add +```
-### timestamp_add - -This function accepts from user a timestamp id and time to record in the -timestamp table. It stores the entry in the appropriate table in cbmem -or `_timestamp` region or local stash. - - -### timestamp_add_now - -This function calls `timestamp_add` with user-provided id and current time. - +```{doxygenfunction} timestamp_add_now +```
## Use / Test Cases