Hi Andy,
Has anyone come across the the issue of unwanted interdependency of
documentation and source code releases when embedding documentation in source
code?
By this I mean that my documentation is extracted from my RTL source code and
the following sequence occurs:
1. My RTL is verified, released and frozen. Prayers have been prayed,
sacrifices offered up, and it is done. No more changes.
2. I generate my documentation for the last time, using the frozen RTL as a
source, and realise that there is a documentation error in that source.
The difficulty is to find a robust process that respects the integrity of the
frozen RTL but allows me to make the necessary documentation update.
I can imagine some hacks, but does anyone have experience of a good process
please?
Thanks for any suggestions,
Andy Betts
------------------
+33 6 12 19 49 03
skype: betts.crolles
www.icondasolutions.com<http://www.icondasolutions.com/>
I have not experienced full force of the frozen code, but I had something
similar.
1) Can you have documentation in separate files such as .dox?
(That probably beats the intention of having comments/documentation with source
code)
2) Can you apply a patch to the source code copy before processing
documentation?
This way you typos could be fixed without a need to modify source, but any
significant additions/deletions would mess the line numbering.
The fixes then can get to next release.
Jan
------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60134071&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
