A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation. hyde is a utility that facilitates documenting C++. The tool is unique from existing documentation utilities. Many tools rely on documentation placed inline within the 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 with 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. 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.

Features

  • Clang based
  • Out-of-line
  • Jekyll compatible
  • Schema enforcement
  • Adaptable
  • It produces well structured Markdown files that contain YAML front-matter

Project Samples

Project Activity

See All Activity >

Categories

Design

License

MIT License

Follow hyde Jekyll

hyde Jekyll Web Site

Other Useful Business Software
Forever Free Full-Stack Observability | Grafana Cloud Icon
Forever Free Full-Stack Observability | Grafana Cloud

Our generous forever free tier includes the full platform, including the AI Assistant, for 3 users with 10k metrics, 50GB logs, and 50GB traces.

Built on open standards like Prometheus and OpenTelemetry, Grafana Cloud includes Kubernetes Monitoring, Application Observability, Incident Response, plus the AI-powered Grafana Assistant. Get started with our generous free tier today.
Create free account
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of hyde Jekyll!

Additional Project Details

Programming Language

C++

Related Categories

C++ Design Software

Registered

2023-09-01