[Hallcsw] Implenting doxygen for HCANA
Mark Jones
jones at jlab.org
Thu Apr 21 14:28:40 EDT 2016
I have put a doxygen setup file in the hcana repo.
The doxygen version should be a beyond 1.8 .
This is not the default version of doxygen on Jlab ifarm.
Need to do "use doxygen/1.8.5" to set the right version.
To run just type " doxygen" in the hcana directory and it uses the input file
Doxyfile by default. The html output is put in the directory
../doxugen_output . The input file is set to look at the hcana/src
podd/src and podd/hcana_decode subdirectories.
Of course you do not have to run doxygen yourself.
You can look at the initial pass of doxygen at
https://userweb.jlab.org/~jones/hcana_doc/index.html
Presently, most of the code is not marked for doxygen documentation.
Steve Wood is going to look at how ROOT is using doxygen to get
ideas for implmentation. At the next meeting , we will discuss the
best way to proceed with documentation. Of course this is only documenting
the classes and other parts of the code. We need additional documentation
on the algorithms and the "why" of the code.
ANyone with experience with doxygen and has comments/suggestion
please let Steve and I know. If you are interested in getting involved
in documentation let me know.
Cheers,
Mark
More information about the Hallcsw
mailing list