# doxygen2md

**Repository Path**: bin/doxygen2md

## Basic Information

- **Project Name**: doxygen2md
- **Description**: A doxygen to markdown converter.
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-08-28
- **Last Updated**: 2023-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# doxygen2md

> A doxygen to markdown converter.

An example of the result can be seen [here](https://pshampanier.gitbooks.io/libpqmxx/content/) 
in the API section.

## Usage

1. Run `doxygen` to generate the XML documentation.
2. Run `doxygen2md` providing the folder location of the XML documentation.  

  ```
  Usage: doxygen2md [options] <doxygen xml directory>

  Options:

  -h, --help     output usage information
  -V, --version  output the version number
  -v, --verbose  verbose mode
  ```

All documentation converted to Markdown is generated on stdout.