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

Outdated inline documentation #10

Open
ftynse opened this issue May 1, 2015 · 0 comments
Open

Outdated inline documentation #10

ftynse opened this issue May 1, 2015 · 0 comments

Comments

@ftynse
Copy link
Collaborator

ftynse commented May 1, 2015

In multiple places the doxygen documentation dates back to the date when the dependence analysis was moved from CLooG, including references to CloogViolation and company.

One can use clang's -Wdocumentation option to see the list of most notable problems. I propose to update this documentation, grepping by cloog should suffice + clang should suffice and update the documentation style a little bit. The heading candl_function_name function: in each comment takes space and risks heavily to become outdated if the function is renamed. But the old name remains in the file, which is confusing for both Doxygen and someone who processes the file.

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

1 participant