Feature #23916
Publish Doxygen tag files
Description
Doxygen allows to import the documentation from external projects.
It is as easy as adding TAGFILES = "doxytags-larsoft.xml=http://nusoft.fnal.gov/larsoft/doxsvn/html" to the project's Doxyfile.
These files are also easy for you to generate: GENERATE_TAGFILE = "doxytags-larsoft.xml" on LArSoft's Doxyfile is all it takes.
I would like LArSoft to provide this service.
- edit LArSoft's
DoxyfilelineGENERATE_TAGFILEto something likeGENERATE_TAGFILE = "doxytags-larsoft.xml" - change the publishing script to also copy that file, either in the
html/directory or in the parent one - announce where the file is
Then my task will be to copy that file where I generate my documentation, edit my Doxyfile's line TAGFILES and enjoy it takes one tenth of the time.
History
#1 Updated by Christopher Green 9 months ago
- Status changed from New to Accepted
#2 Updated by Kyle Knoepfel 9 months ago
- Estimated time set to 2.00 h
- Assignee set to Lynn Garren
- Status changed from Accepted to Assigned
#3 Updated by Lynn Garren 8 months ago
- % Done changed from 0 to 60
- Status changed from Assigned to Feedback
I've installed a doxytags-larsoft.xml file in the html directory. See if it works for you.
#4 Updated by Gianluca Petrillo 8 months ago
- % Done changed from 60 to 100
- Status changed from Feedback to Resolved
It works well for me.
There are some shortcomings in the Doxygen result, but that is a different matter.
I am marking this request as resolved, with my thanks.
#5 Updated by Lynn Garren 8 months ago
Thanks Gianluca. For reference, the master doxygen files are now in larreltools/doxygen.
#6 Updated by Kyle Knoepfel 8 months ago
- Status changed from Resolved to Closed