<div dir="ltr"><div class="gmail_extra">I suppose this all-doxygen example is fairly good.<br><br><a href="http://openmesh.org/Documentation/OpenMesh-Doc-Latest/index.html">http://openmesh.org/Documentation/OpenMesh-Doc-Latest/index.html</a><br>
<br>Deal.II's examples are also great, and I guess they could have easily added more manual/concept pages.<br><br>Can a doxygen user think of nice ways to do<br><br>1. two-way "related" links?</div><div class="gmail_extra" style>
2. structured annotation like Level (implies its own topical index) and Collective?</div><div class="gmail_extra" style>3. indicate Fortran auto/custom/none without clutter?</div><div class="gmail_extra"><br><div class="gmail_quote">
On Sat, Dec 22, 2012 at 9:32 AM, Jed Brown <span dir="ltr"><<a href="mailto:jedbrown@mcs.anl.gov" target="_blank">jedbrown@mcs.anl.gov</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div>Doxygen has full semantic understanding of the body of functions, including ability to trace through function calls within a compilation unit to determine whether the argument usage matches its declaration? I never thought it was that sophisticated.</div>
<div><br></div><div>Is there a way to make Doxygen provide "used from" (especially examples) and two-way cross-references (.seealso is one-way)? What about organizing functions by "level" or some other tag? I'm not a fan of sowing, but I have a yet to see doxygen-generated man pages that were really more useful.</div>
<div><br></div><div>Also, do you know a way to render an HTML version of a user's manual (written in LaTeX, reStructuredText, or some other markup) that can be robustly cross-referenced with the man pages? PETSc's LaTeX preprocessing gets us one direction (click on function name in PDF to get man page), but lack of the other direction is a serious problem in my opinion. A I'd really like to have the man page -> user's manual links created automatically (anywhere the function is mentioned in the user's manual, just like the index), but also support explicit links from the body of the man page.</div>
<div><br></div><div>The closest thing I've seen is breathe (<a href="http://michaeljones.github.com/breathe/" target="_blank">http://michaeljones.github.com/breathe/</a>) which tries to combine doxygen and sphinx, but development has slowed and it's still kinda rough.</div>
</blockquote></div><br></div></div>