search

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

Allow specifying substitution characters #39

Open sean-parent opened 5 years ago

sean-parent commented 5 years ago

Currently the docs for a file like <lib/file.hpp> turns into a URL like lib2Ffile.hpp - it would be great to either allow lib-file.hpp or lib/file.hpp - similarly other special characters should be substituable to something more readable.

fosterbrereton commented 5 years ago

Finding the right substitution characters can be tricky, and many options result in documentation collisions. For example, I tried - at one point, but then documentation for, say, operator- and operator* will end up resolving to the same thing. I only arrived at the current solution after many collision failures. I agree what's there now is not ideal, and am open to better solutions.