EDoc++ Manual

Table of Contents

Preface

1. Introduction

What is EDoc++

Motivation

Limitations

2. About Alpha Version

3. Commonly Used Terms/Acronyms

4. Licensing

Overview

The LGPL Like license

Licensing Programs That Use EDoc++

5. Installing

Obtaining

Requirements

Runtime Requirements

Build Requirements

Maintainence Requirements/Tools

Compiling + Installing

Additional configuration options

6. Basic Usage

Quick Start

Setting Up The Environment

Compiling Stage

Merging Stage

Output Stage

Output formats

Simple Format

Simple Doxygen Format

Detailed Doxygen Format

Output Notifications (Errors/Warnings)

Running Doxygen

The Doxygen Configuration File

7. Advanced Usage

Preparing example project

File locations

Building + Installing

Goals for Example Project

Verbosity

The Log File

Determining which EDoc++ data files need to be used

Resource types

Static Libraries

Dynamic Libraries

Plugins

Suppressions

Default suppressions

General Usage

Quick Start Guides

Helpers available

Interactive Suppressions

Suppression Functions

Generating suppressions

Accessing other suppression modules

Completing the example project

Generating doxygen documentation

Checking exception safety of library_user app

8. Running the Tests

9. Command Line Arguments

10. Using libEDoc

11. File Formats

12. Maintaining EDoc++

13. FAQ

14. Troubleshooting

15. History

Motivation

Origins

A. GNU Free Documentation License

PREAMBLE

APPLICABILITY AND DEFINITIONS

VERBATIM COPYING

COPYING IN QUANTITY

MODIFICATIONS

COMBINING DOCUMENTS

COLLECTIONS OF DOCUMENTS

AGGREGATION WITH INDEPENDENT WORKS

TRANSLATION

TERMINATION

FUTURE REVISIONS OF THIS LICENSE

ADDENDUM: How to use this License for your documents

B. GNU Lesser General Public License

Preamble

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

Section 0

Section 1

Section 2

Section 3

Section 4

Section 5

Section 6

Section 7

Section 8

Section 9

Section 10

Section 11

Section 12

Section 13

Section 14

NO WARRANTY Section 15

Section 16

How to Apply These Terms to Your New Libraries

C. Example Project