Jul 20, 2023

Extracting comments from C++ source and generating HTML

Ccdoc is a tool for extracting comments from C++ source code and presenting it in HTML format, very similar to Java’s JavaDoc tool. The tagging used in ccdoc is very similar to that of Javadoc, with adaptations for the C++ specifics, of course. Ccdoc supports extracting comments from both header and implementation files.

In contrast to most other C++ doc’ing applications, ccdoc analyses the code before it has been run through the pre-processor, so things such as macros can actually be included in the documentation.

It’s usage is not quite as straight forward as JavaDoc’s, but considering the quality of the output, it is well worth the effort.

Checkout these related ports:
  • Zziplib - Library to provide transparent read access to zipped files
  • Zydis - Fast and lightweight x86/x86-64 disassembler library
  • Zycore-c - Support library with platform independent types, macros, etc for Zydis
  • Zthread - Platform-independent object-oriented C++ threading library
  • Zookeeper - Coordination Service for Distributed Applications
  • Zls - Zig LSP implementation + Zig Language Server
  • Zfp - High throughput library for compressed floating-point arrays
  • Zeal - Offline documentation browser
  • Zapcc - C++ caching compiler based on clang
  • Zanata-platform - Web-based translation platform
  • Zanata-cli - Zanata Java command line client
  • Z88dk - Complete Z80/Z180 development kit
  • Z80ex - ZiLOG Z80 CPU emulator library
  • Z80asm - Assembler for the Z80 microprocessor
  • Z80-asm - Z80 assembly code assembler and disassembler