tcl - Custom/Distributed documentation of changes with Doxygen -
i attempting following feature working doxygen.
is possible, , how best this?
we working existing tcl codebase came eda tool, lot of code gets 'sourced' , not organized in procedures. there numerous improvements/modifications have applied code base. example customization of form "allow feature x controlled new configuration variable y", , involves modifications made filea, fileb, , filec.
i have doxygen parsing entire code base. besides standard language documentation looking extract list of customizations have made, including files modified (and approx line number), changes made in each file, capture of modified code each files, , pointer file listing , line number modification made.
i expect require custom doxygen comments/tags in filea, fileb, , filec, , closest managed placing following @ each location modified in filea fileb , filec:
## # \page custom_mypage1 customization enabling control of x variable y # # test comment 1 #
this allows collecting comments 3 locations, can't figure out how to:
- include portion of source code follows, and
- how have generated documentation include references file/line number of comment came from
using xrefitem
instead of page
provide link between summary page , source.
to include code snippet in page, snippet
may help.
example:
/** \xrefitem customization1 "change 1" "changes customization1" description of change. \snippet currentsourcefile.cpp change1 */ //! [change1] modified code here... //! [change1]
Comments
Post a Comment