Path

ez.no / ezpublish / documentation / development / using doxygen to create api documentation

Using Doxygen to create API documentation

These documentation pages are no longer maintained. Please visit the new documentation site.

Introduction

All of the code in eZ publish is written with Doxygen comments in front of them, with this you can generate API documentation which will give overviews and details of all classes and functions in the system.
The homepage of Doxygen can be found at doxygen.org.

Installation

Binary and source can be download from doxygen.org.
Compilation and installation instructions are found on the homepage.

RPM

If you prefer RPMs you can try rpmfind.net.

Requirements

To generate the API doc you require at least version 1.2.17 of doxygen, it is the first version to support the PHP language.

Usage

Creating the documentation is done by using the makedoc.sh script. You invoke it with.

bin/shell/makedoc.sh

Alternatively you may run doxygen directly with

doxygen doc/doxygen/Doxyfile

The documentation will be placed in the doc/generated/html directory. Browsing the API doc is done by using the SDK, /sdk/ref.

Comments

Contents

Development

Extensions
eZ publish datamodel
eZ publish tuning and stability
Importing attribute data
Kernel
Libraries
Scripting
Standards
System overview
Test Suite
Using Doxygen to create API documenta...

Created

11/04/2003
3:26:09 pm
by Jan Borsodi

Last updated

04/07/2003
5:01:21 pm
by Bård Farstad

Authors

Jan Borsodi
Bård Farstad


This page is part of the eZ Publish documentation. The documentation is available under the GNU Free Documentation License. All contributions will be released under the terms of this license.