Provide doxygen infrastructure to turn comments into developer documentation

UKFELs / Puffin

3D unaveraged FEL simulation code

Other

23 stars 17 forks source link

Provide doxygen infrastructure to turn comments into developer documentation #20

Open jdasmith opened 8 years ago

jdasmith commented 8 years ago

Refer to https://www.stack.nl/~dimitri/doxygen/manual/starting.html https://www.stack.nl/~dimitri/doxygen/manual/doxygen_usage.html https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html#fortranblocks

So - probably use doxywizard to create a conf file, then test it out! But need a bit more content in the .f90 files first!

mightylorenzo commented 7 years ago

I can gen the documentation when working with the 'source' Puffin, but after make and make install, it no longer works. We'll need to point the generated fortran.dxg file to the .f90 files somehow!