Doxygen API Report - Introduction

Last Published: 2014-12-08 | Version: 1.0

Overview

Introduction
Goals
Usage
Examples
FAQ

Project Documentation

Built by Maven

Doxygen API Report

Runs Doxygen to generate API documentation report.

Goals Overview

doxygen-report:create-config Creates default Doxygen config file.
doxygen-report:report Runs Doxygen to generate API documentation.

Usage

Install Doxygen and add it to PATH.
Run mvn doxygen-report:create-config.
Make customizations to src/doxygen/doxygen.config.
When you run mvn site it will contain the "Doxygen API documentation" report.
Full instructions on the Usage page.

Example confgurations on the Examples page.