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

Geoffrey should print warning when source code comment is not used #1

Open
elfenpiff opened this issue Dec 17, 2021 · 1 comment
Open

Comments

@elfenpiff
Copy link

It can be helpful that geoffrey warns the user about unused geoffrey comments in the code. Something like this

int main() {
 //! [unused]
 //...
 //! [unused]
}

could lead to a warning like: the tag unused is not used in the documentation. This cleans up the code when we do not need the code snippet anymore or makes us aware that there is something missing in our documentation.

@elBoberido
Copy link
Collaborator

Good idea. I think I can add a command line option for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants