[petsc-dev] PETSc goes Doxygen!?

[Jed Brown]

On Sun, Jan 13, 2013 at 10:08 PM, Karl Rupp <rupp at mcs.anl.gov> wrote:

> Hi,
>
>
>
>  Doxygen doesn't apply the input filter for examples? That's lame, but
>> hopefully they can add an option to do that.
>>
>
> I have tried multiple filter scripts but none of them was applied to the
> examples. The 'examples' module does not seem to experience a lot of love
> anyway, see e.g.
>   https://bugzilla.gnome.org/**show_bug.cgi?id=149253<https://bugzilla.gnome.org/show_bug.cgi?id=149253>
> (yes, Barry, that ticket is from 2004...)
>
>
Heh, Concepts pops up again.


>
>  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.
>>
>
> Hmm, do you still see internal functions floating around in the doxygen
> output? I think they disappeared when I turned off EXTRACT_ALL.
>

Nope, that looks good. This list is full of private data structures:

http://krupp.iue.tuwien.ac.at/petsc-doxygen/classes.html


It looks like there are a lot of misplaced classes here. Is that a problem
with all those man pages?

http://krupp.iue.tuwien.ac.at/petsc-doxygen/group__misc-class-beginner.html


Can we get a single page with all API levels like this? It's less clicking
to browse.

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/index.html
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20130113/1ebdc70b/attachment.html>