<div dir="ltr">On Tue, Jan 15, 2013 at 2:37 PM, Jed Brown <span dir="ltr"><<a href="mailto:jedbrown@mcs.anl.gov" target="_blank">jedbrown@mcs.anl.gov</a>></span> wrote:<br><div class="gmail_extra"><div class="gmail_quote">
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div class="gmail_extra"><div class="im">On Tue, Jan 15, 2013 at 2:15 PM, Karl Rupp <span dir="ltr"><<a href="mailto:rupp@mcs.anl.gov" target="_blank">rupp@mcs.anl.gov</a>></span> wrote:<br>
</div><div class="gmail_quote"><div class="im"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div>The listing of<br>
<a href="http://krupp.iue.tuwien.ac.at/petsc-doxygen/ksp_2ksp_2examples_2tutorials_2ex4_8c-example.html" target="_blank">http://krupp.iue.tuwien.ac.at/<u></u>petsc-doxygen/ksp_2ksp_<u></u>2examples_2tutorials_2ex4_8c-<u></u>example.html</a><br>
is now identical with the one Barry mentioned - except for a violation of coding style on lines 49/50 that already affects the sources. I'll send a separate email on that.<br></div></blockquote><div><br></div></div><div>
Why aren't PetscScalar and PetscReal linkified? And all the PetscLogEventRegister/Begin/End/...</div><div><br></div><div>Are these hash URLs stable? What information goes into the hash?</div><div class="im"><div><br>
</div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div>
<br>
- Examples now carry correct line numbers even with things stripped out. This required a small Doxygen patch, which I've sent to the developers for inclusion in the next release.<br>
<br>
- Private functions no longer show up in the various modules (this was caused by /*MC incorrectly being interpreted as part of a function documentation)<br>
<br>
There are still a bunch of private data structures shown. There is no consistent way of determining whether a data structure is private or not. The underscore could be a criterion, but then it misses some rather important things such as DM_Plex:<br>
<a href="http://krupp.iue.tuwien.ac.at/petsc-doxygen/structDM__Plex.html" target="_blank">http://krupp.iue.tuwien.ac.at/<u></u>petsc-doxygen/structDM__Plex.<u></u>html</a><br>
(Note that I could further improve the data field documentation if I were allowed to touch sources and replace /* ... */ by /** ... */)</div></blockquote></div></div><br>As with all implementation structures, DM_Plex is not user-visible. The user-visible type is DM and they use DM* and DMPlex* interfaces. The type documentation is with the type name: DMPLEX ("plex").</div>
</div>
</blockquote></div><br>I agree that it is not "user visible", but that does not mean I don't want documentation on it.</div><div class="gmail_extra"><br></div><div class="gmail_extra"> Matt</div><div class="gmail_extra">
<div><br></div>-- <br>What most experimenters take for granted before they begin their experiments is infinitely more interesting than any results to which their experiments lead.<br>-- Norbert Wiener
</div></div>