[petsc-dev] PETSc goes Doxygen!?

[Karl Rupp]

Hey,

>     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.

One of the first of their kind...


> Nope, that looks good. This list is full of private data structures:
>
> http://krupp.iue.tuwien.ac.at/petsc-doxygen/classes.html

Oh, right. Seems like the EXTRACT_ALL is implicit for data structures...

> 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

The reason for this is that anything that is not recognized as part of 
any other module is currently collected in this group. Fine-tuning the 
filters (and/or source comments) should fix this.


> 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

The 'Detailed Description' on the module page:
   http://krupp.iue.tuwien.ac.at/petsc-doxygen/group__mat-class.html
can be used for this. The automatic extraction is a bit tricky unless 
one updates the source comments slightly.

Best regards,
Karli