adobe / hyde

A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation
http://opensource.adobe.com/hyde/
MIT License
323 stars 41 forks source link

Be smarter about example files #7

Open fosterbrereton opened 5 years ago

fosterbrereton commented 5 years ago

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.