Home

Introduction

mooxygen is a tool that scans a directory tree where each directory contains a MOOS-based module.

Then, mooxygen generates documentation about the variables that each module publishes or subscribes to, including fancy graphviz-based dependency graphs among the modules and variables.

Installing

Mooxygen is provided in source form only, so you must compile it before use.

You'll need to have CMake installed in your system. Use cmake-gui to create a Makefile (for GCC) or a Visual Studio solution or whatever project for your favorite IDE, then compile the project as usual.

Mooxygen requires the graphviz package at run-time. It can be installed from standard Linux repositories. See here for Windows and Mac.

Invoking

Mooxygen can be executed with one command line argument:

mooxygen [Mooxyfile]
mooxygen --create

With --create, a template Mooxyfile will be dumped to the current directory. You can use that file to configure Mooxygen. Otherwise, the unique command line argument is the name of the Mooxyfile configuration file, which is "Mooxyfile" by default if there are no arguments.

Format of the Mooxyfile file

This is an example configuration file for Mooxygen:

DOT_PATH             = dot
INPUT_PATH           = ./modules
OUT_HTML             = YES
OUT_HTML_PATH        = ./doc/html
PROJECT              = Your project title here.

Documenting your code

This topic is covered here.