![]() ![]() You can also use the validation mode to verify that the documentation structure is in sync with theĬ++ API - a good feature for use with continuous integration systems. As theĪPI changes, Hyde is run again, and updates the existing files, and adds new ones for new classesįor example. Hyde creates a set of files upon first run, to which developers need to add documentation. Unlike other tools, Hyde does not extract inline documentation from your C++ code. A site generator like Jekyll consumes these files and prepares them for serving as static HTML. Markdown files, each with a section of YAML meta-data at the top. The input to the tool is your C++ API, for example a header file. Hyde is written in C++ itself, and is typically built from source, using CMake, and runs on macOSĪnd Linux. Is a screenshot of the API reference for the stlab libraries, poweredīy Hyde: Screenshot of the stlab API documentation generated by Hyde Instructions, or examples - into one cohesive package that can be served on the web.
0 Comments
Leave a Reply. |