{"repo":"adobe/hyde","free":true,"listed":false,"github":"https://github.com/adobe/hyde","clone":"git clone https://github.com/adobe/hyde.git","description":"A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation","language":"C++","stars":340,"topics":["cplusplus","documentation-tool","jekyll","libtooling"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"What is hyde hyde is a utility that facilitates documenting C++. The tool is unique from existing documentation utilities in the following ways: - Clang based : In order to properly document your C++, hyde compiles it using Clang's excellent libTooling library. Therefore, as the C++ language evolves, so too will hyde . - Out-of-line : Many tools rely on documentation placed inline within source as long-form comments. While these seem appealing at first blush, they suffer from two big drawbacks. First, there is nothing keeping the comments from falling out of sync from the elements they document. Secondly (and ironically), experienced users of these libraries eventually find inline documentation to be more of a distraction than a help, cluttering code with comments they no longer read. - Jekyll compatible : hyde does not produce pretty-printed output. Rather, it produces well structured Markdown files that contain YAML front-matter. These files can then be consumed by other tools (like Jekyll) to customize the structure and layout of the final documentation. - Schema enforcement : Because of the highly structured nature of the output, hyde is able to compare pre-existing documentation files against the current state of your C++ sources. Library developers can use hyde 's update mode to facilitate updating documentation against the state of sources. Build engineers can use hyde 's validate mode to make sure changes to a code base are accurately reflected in the latest documenta","default_branch":null,"files":null,"tree":[],"storefront":"/r/adobe","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/adobe/hyde/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}