<div dir="ltr">On Sun, Jan 13, 2013 at 5:30 PM, Karl Rupp <span dir="ltr"><<a href="mailto:rupp@mcs.anl.gov" target="_blank">rupp@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">
Hi,<div class="im"><br>
<br>
>    Any way to strip the ierr = and CHKERRQ(ierr); from all the html versions of the source code. I find it cluttering and ugly.<br>
<br></div>
It doesn't work 'directly' as Doxygen currently does not apply filters to examples. The remedy is an additional copy&conversion step, i.e. something comparable to<br>
$> cp -R src/ tmp/<br>
$> find tmp/*/examples/tutorials/*.c | xargs sed -i 's/ierr = //g'<br>
$> find tmp/*/examples/tutorials/*.c | xargs sed -i 's/CHKERRQ(ierr);//g'<br>
<br>
This seems to do the job:<br>
<a href="http://krupp.iue.tuwien.ac.at/petsc-doxygen/dm_2examples_2tutorials_2ex1_8c-example.html" target="_blank">http://krupp.iue.tuwien.ac.at/<u></u>petsc-doxygen/dm_2examples_<u></u>2tutorials_2ex1_8c-example.<u></u>html</a></blockquote>
<div><br></div><div style>Doxygen doesn't apply the input filter for examples? That's lame, but hopefully they can add an option to do that.</div><div>  </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

@Jed: I've disabled the EXTRACT_ALL switch, now only documentation for commented entities is generated. Static functions should not be shown anyway (EXTRACT_PRIVATE = NO). I could also set EXCLUDE_PATTERN to something like  *_Private and/or *_Internal. Do you know a better systematic way of identifying internal stuff without touching sources?<br>
</blockquote><div><br></div><div style>PETSc doesn't have any public functions containing underscores (only enums and feature macros). Can you exclude functions that way? From the docs, it looks like EXCLUDE_PATTERNS excludes entire files while EXCLUDE_SYMBOLS has all symbols lumped together. Sadly, that seems to only take a glob rather than a regex, and it lumps all symbol types together.</div>
<div style><br></div><div style>Would strict symbol visibility help limit which symbols doxygen considers to be public? There is a --with-visibility flag that will avoid exporting the internal symbols.</div></div></div></div>