/doxy-haml

Ruby script to parse Doxygen XML and render it using HAML

Primary LanguageRubyApache License 2.0Apache-2.0

GitHub version Build Status Coverage Status

doxy-haml

Ruby script to parse Doxygen XML and render it using HAML

Prerequisites

Ruby

Ruby must be available on the command line.

Currently doxy-haml has only been tested on OSX using Ruby 2.1.0 installed via rbenv: See rbenv readme for details.

Doxygen

The doxygen command must be available on the command line.

Currently doxy-haml has only been tested on OSX using Doxygen 1.8.9.1 installed via brew:

brew update
brew install doxygen

Quickstart

ruby doxy-haml --in /path/to/some/cpp/source --out /path/where/you/want/the/docs

Just show me what it does!

To run doxy-haml against the included spec cpp source:

  1. Checkout the project
  2. Change to the project directory
  3. Install the dependancies bundle install (only need to do this once)
  4. Run ruby doxy-haml.rb --in spec/src

The generated HTML will be in the doc/api folder