derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
81 lines
2.3 KiB
Plaintext
81 lines
2.3 KiB
Plaintext
********************************************************************************
|
|
|
|
Check the version of doxygen you're using, there is a bug
|
|
with older versions ( < 1.7.4 )
|
|
|
|
********************************************************************************
|
|
|
|
USAGE
|
|
=======================
|
|
To invoke doxygen,
|
|
cd $(papi_dir)/doc
|
|
make (alternativly doxygen Doxyfile-{html,man1,man3}
|
|
|
|
This command produces documentation for the PAPI user-exposed api and data-structures.
|
|
|
|
There are several different configuration files are present:
|
|
Doxyfile-html - generates documentation for everything under src. This will
|
|
take a long time to run, and generates north of 600 megs of files. Requires
|
|
the program dot, for dependency graphs.
|
|
Doxyfile-man1 - generates man-pages for the utilities.
|
|
Doxyfile-man3 - generates man-pages for the API, see papi.h
|
|
|
|
|
|
Commenting the Code
|
|
=======================
|
|
To get doxygen's attention, in general, use a special comment block
|
|
|
|
/** */
|
|
thing_to_be_commented
|
|
|
|
Doxygen responds to several special commands, denoted by @command
|
|
(if you're feeling texy, \command)
|
|
|
|
As an artifact of how doxygen started life, we call our api functions 'classes'
|
|
to get doxygen to generate man-pages for the function.
|
|
|
|
/** @class MY_FUNCTION
|
|
@brief gives a brief overview of what the function does,
|
|
limited to 1 line or 1 sentence if you need the space.
|
|
@param arg1 describes a parameter to the function
|
|
|
|
@return describes the functions return value
|
|
|
|
@retval allows you to enumerate return values
|
|
|
|
Down here we have more detailed information about the function
|
|
Which can span many lines
|
|
|
|
And paragraphs (feeling texy now?)
|
|
|
|
@par Examples:
|
|
@code
|
|
This is the way to get examples to format nicely
|
|
code goes here....
|
|
@endcode
|
|
|
|
@bug
|
|
Here you get a section of freeform text to describe bugs you encounter.
|
|
*/
|
|
|
|
@internal keeps comment blocks marked as such out of the documentation
|
|
(unless the INTERNAL_DOCS flag is set in the config file)
|
|
|
|
|
|
In several places /**< */ appears, this means that the comment
|
|
pertains to the previous element.
|
|
|
|
int foo; /**< This comment is about foo */
|
|
|
|
|
|
TODO
|
|
=======================
|
|
Doxygen provides options for [ab]using the preprocessor,
|
|
Do we need to look into this? Probably not more than we already do -J
|
|
|
|
Document the ctests?
|
|
|
|
See
|
|
http://www.stack.nl/~dimitri/doxygen/docblocks.html
|
|
for more detail on doxygen.
|