search

ExtremeFLOW / neko

/ᐠ. ｡.ᐟ\ᵐᵉᵒʷˎˊ˗
https://neko.cfd/
Other
158 stars 26 forks source link

Doxygen suported copyright declaration. #1323

Open timfelle opened 4 days ago

timfelle commented 4 days ago 
          > Looks good, some minor questions, and unsure if we want to have the copyright statement with doxygen tags (strongly leaning towards a no there)

Well it's more a suggestion. It will format it directly in our documentation in a more useful way rather than it only being in the source code. Try to run make html and look at the simcomp_executor.f90 file reference: /neko/doc/html/d8/d65/simcomp__executor_8f90.html. image

Originally posted by @timfelle in https://github.com/ExtremeFLOW/neko/issues/1185#issuecomment-2186399258

timfelle commented 4 days ago

As mentioned in the comment copied in above, it is possible to declare our copyright notice to doxygen. This allows doxygen to format and organize a section with the copyright statement in the documentation for each file. An example is shown in the image above.

Is this something we wish to support?

timofeymukha commented 4 days ago

It looks nice :-). I guess not horribly important, but could be cool to have.