Closed zachcran closed 1 year ago
I'll see if I can figure out the module doccomments, at least locally, as well as see if I can fix that warning. Thanks again!
@AutonomicPerfectionist @ryanmrichard Are module doccomments expected to be at the top of each file, or just the files including all of the files in a subdirectory (for example, cmake/cmakepp_lang/cmakepp_lang.cmake
and cmake/cmakepp_lang/algorithm/algorithm.cmake
)?
Top of the file you want to document, before any commands like include_guard()
So you can do both: put a module doccomment on the "main" files that include the others, saying what that subdirectory is for, and then have more specific doccomments for each of the individual modules
Is this pull request associated with an issue(s)? No.
Description Now that API documentation is online, it needs to be cleaned up and made consistent.
TODOs
#[[[
) for special specifiers like@module
... code-block::
so they render properly.:var VARIABLE:
and:vartype VARIABLE:
commands properly.