[petsc-dev] PETSc goes Doxygen!?

Jed Brown jedbrown at mcs.anl.gov
Tue Jan 15 18:50:05 CST 2013


On Tue, Jan 15, 2013 at 6:48 PM, Karl Rupp <rupp at mcs.anl.gov> wrote:

> This is used in many places. For example, all the implementations
>> (KSPGMRES, MATMPIAIJ, etc) are documented next to the associated create
>> function (KSPCreate_GMRES, MatCreate_MPIAIJ), but the macros are in the
>> header. I don't see sed being sufficient for this editing, but a Python
>> (for example) input filter should be able to convert the sowing comment
>> blocks to Doxygen format.
>>
>
> Yes, you're right, this is where things get a bit complicated, but are
> still manageable as long as it's just typedefs, enums, or members of
> structs.


And function-like macros (some of which could be made inline functions).
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20130115/112ffca6/attachment.html>


More information about the petsc-dev mailing list