[petsc-dev] PETSc goes Doxygen!?

[Karl Rupp]

Hi,

 >     At least for PetscScalar and PetscReal this is unfortunately not the
>     case:
>
>     include/petscmath.h"
>
>     #if defined(PETSC_USE_COMPLEX)
>     typedef PetscComplex PetscScalar;
>       ....
>     #else /* PETSC_USE_COMPLEX */
>     typedef PetscReal PetscScalar;
>     #define MPIU_SCALAR MPIU_REAL
>
>
> They really are documented:
>
> http://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/Sys/PetscScalar.html


Oh, we use different definitions of 'documented'. I'm referring to 
documentation right at the place of declaration/definition. 
PetscScalar.html is generated from some comment block at some other spot 
in the sources, hence Doxygen fails to associated it with the correct 
typedef (this could be resolved by an injection of suitable Doxygen 
commands).

Best regards,
Karli