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

Be smarter about example files #7

Open
fosterbrereton opened this issue Oct 20, 2018 · 0 comments
Open

Be smarter about example files #7

fosterbrereton opened this issue Oct 20, 2018 · 0 comments

Comments

@fosterbrereton
Copy link
Contributor

Right now we permit example files to be included as siblings to the docs. (e.g., connect.md references connect_example.cpp.) These files are considered extraneous by the tool. We should permit all .cpp files in the output directories as long as they are start with the same name as a documentation file. Example:

m_connect.md // the doc file
m_connect_example.cpp // example file for connect. OK - do not flag.
m_foobar_example.cpp // example for a dead API, perhaps? Bad - should be flagged.
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