Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove \fn in Doxygen comments where possible #263

Open
alwinm opened this issue Mar 10, 2023 · 1 comment
Open

Remove \fn in Doxygen comments where possible #263

alwinm opened this issue Mar 10, 2023 · 1 comment
Labels
documentation when documentation is incorrect, incomplete, insufficient etc...

Comments

@alwinm
Copy link
Collaborator

alwinm commented Mar 10, 2023

According to the Doxygen manual, quoted below:

https://doxygen.nl/manual/commands.html#cmdfn

This command is only needed if a comment block is not placed in front (or behind) the function declaration or definition.

If your comment block is in front of the function declaration or definition this command can (and to avoid redundancy should) be omitted.
Warning: Do not use this command if it is not absolutely needed, since it will lead to duplication of information and thus to errors.

I think it would improve our existing comments to adopt the standard of omitting redundant \fn commands, which also means removing it wherever possible. I hope to receive feedback on this proposal before any action is taken.

@bcaddy
Copy link
Collaborator

bcaddy commented Mar 10, 2023

I don't have any strong opinions on this, it's fine with me and is an easily automated fix.

Maybe a hack session/workshop on Doxygen would benefit the group. I'd really like to see documentation become standard on all new (and old) code but Doxygen can be a bit confusing when you first start.

@bcaddy bcaddy added the documentation when documentation is incorrect, incomplete, insufficient etc... label Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation when documentation is incorrect, incomplete, insufficient etc...
Projects
None yet
Development

No branches or pull requests

2 participants