ReflectionsProjections / mm20

MechMania 20
1 stars 1 forks source link

Move code to doxygen-specific syntax #1

Closed ace-n closed 10 years ago

ace-n commented 10 years ago

Read this first: https://stackoverflow.com/questions/58622/can-i-document-python-code-with-doxygen-and-does-it-make-sense

Should we continue using Python's documentation syntax or switch to a Doxygen-specific variant (so we can get more fine-grained control over the documentation generation)?

Mortech commented 10 years ago

We already should be using Doxygen-style comments and not Python-style comments, since this was discussed at a previous meeting. Apparently not all the code is using this style, but it should be changed so that we can use Doxygen commands. We can discuss this again if people have a problem with it, but for now this is what we're going with.

Thanks for bringing it to my attention that much of the code still uses python's documentation style. I'll leave this issue open until we are using a unified documentation style.