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

Added documentation, rearranged exclusion logic in caliper.cc #50

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

apthorpe
Copy link

While working through the example code, I added Doxygen comments to caliper.cc and made several minor changes (rearranged exclusion logic, etc.). I don't believe there's any change in behavior regarding how the target file is modified but the diagnostic messages from std::cerr may differ slightly.

Copy link
Collaborator

@pjh40 pjh40 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! The demos are pretty rough, but, as they are meant to help people get an idea of how to use the FLPR library, it is great to get them in better shape!

apps/caliper.cc Outdated
Comment on lines 12 to 14
/file caliper.cc

/brief Add fictitious function calls at entry and exit point of each external
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll have to see about adding the apps directory to the Doxygen generation: right now, it doesn't show up when the doxygen target is built. Does Doxygen recognize forward slashes as commands? I'm only familiar with backslashes.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're right about Doxygen and the backslashes. Let me fix that and add the mark_executable demo and resubmit

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be fixed in 9620f28

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

Successfully merging this pull request may close these issues.

2 participants