Details
-
Type:
RFC
-
Status: Implemented
-
Resolution: Done
-
Component/s: DM
-
Labels:
Description
Doxyfile is Doxygen (C++ documentation tool endorsed by LSST Developer Guide) configuration file. Adding a link from C++ Documentation section on developer.lsst.io to base Doxyfile, which shall be used for C++ documentation, will help developers to add correct Doxyfile. Base Doxyfile is stored in lsstbase GitHub repo: https://github.com/lsst/base/blob/master/doc/base.inc
Attachments
Issue Links
- is triggering
-
- Done
- mentioned in
-
Page Loading...
-
-
-
-
-
-
-
-
-
-
-
Activity
Petr Kubanek Do you disagree, or should we withdraw this?
I wasn't able to find the referenced DoxyFile without asking on group. My believe is it should be mentioned, or at least mentioned where it can be found (C++ developer guide?). Newcomer familiar with Doxygen reading the guide will naturally look on reference Doxyfile, and having this information mentioned right on documentation page will help.
Petr Kubanek
added a comment - I wasn't able to find the referenced DoxyFile without asking on group. My believe is it should be mentioned, or at least mentioned where it can be found (C++ developer guide?). Newcomer familiar with Doxygen reading the guide will naturally look on reference Doxyfile, and having this information mentioned right on documentation page will help. Petr Kubanek Are you going to adopt this? For Dev Guide changes, we normally ask that the proposer provide the language that will be included, add a linked implementation ticket, and actually do the work. In this case, I will propose the following text to be added to cpp/api-docs.rst:
Our Doxygen configuration file is located in the `base package <https://github.com/lsst/base/blob/master/doc/base.inc>`. For Science Pipelines packages, it is automatically included in all documentation builds.
and you can assign the implementation ticket to me.
Petr Kubanek Please push "Adopt RFC" on this.
Created DM-27778.
Petr Kubanek
added a comment - Created DM-27778 . 
This shouldn't be necessary because all DM C++ packages should be built starting from the appropriate package template which automatically pulls in this configuration.