![]() ![]() Struct/union members without a documentation comment will not beĭocumented. Missing features or outright bugs in Hawkmoth (likely to be addressed in the future, but noĮnum documentation does not include the enumeration constant values.Įnumeration constants without a documentation comment will not be documented. The full documentation build is slightly faster, and incremental build is much faster. The documentation build is much less noisy and has no warnings. Macro documentation seems to work much better. Preference, but I think Hawkmoth results in better clarity. The generated documentation style is slightly different. (There's limited javadoc support, but IMO it's better to go with pure rst to avoid conversion steps.) Things that are different with Hawkmoth (better or worse is subjective):ĭocumentation comments need to be pure reStructuredText. Here's a list of things I encountered with the conversion: There are quite a few differences in Hawkmoth compared to Doxygen+Breathe, some of them good, some bad, and some ugly. This is a draft, because it depends on some unreleased Hawkmoth features. I took the liberty of changing authorship for three commits because I basically rewrote them. This merge request picks up work in !23145 (closed). It uses Clang for parsing, and generates Sphinx directives for documentation.Īrguably Hawkmoth is simpler to set up and use than Doxygen+Breathe, though it also has its limitations. This format is analogous to the one adopted for the Python documentation.Hawkmoth is a Sphinx extension to incorporate documentation comments directly from source into Sphinx based documentation. We organize Doxygen comment blocks into sections that appear in a common order. * * This file is part of Common Structure of Documentation Blocks ¶ Treat the guidelines on this page as an extension of the DM C++ Style Guide. This page focuses on public code documentation using Doxygen, while internal comments are discussed in our DM C++ Style Guide. These comments are meant to be read only by developers reading and editing the source code. Our Doxygen configuration file is located in the base package.įor Science Pipelines packages, it is automatically included in all documentation builds.īy commenting our code internally with C++ comments ( // or /*. This documentation is exposed to users in a variety of contexts, from developers reading the code to readers of the Stack Doxygen Documentation.ĭoxygen comment blocks are the public specification of our C++ API. The LSST Stack uses Doxygen to build C++ API reference documentation from comment blocks. Data Access: Storage Locations and Butlerīy writing documentation blocks for all public or protected C++ components (namespaces, types, methods, functions, and constants).S3DF: SLAC Shared Science Data Facility Hosts USDF.LSST Information Technology Services Committee (ITSC).Copyrights for LSST DM work and the COPYRIGHT file.Licensing LSST DM source code and content.Visual Studio Code Configuration for LSST Development.SublimeText Configuration for LSST Development. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |