https://github.com/d99kris/doxygenmd

Generate markdown API documentations for C++ libraries
https://github.com/d99kris/doxygenmd

c-plus-plus doxygen markdown

Last synced: 8 months ago
JSON representation

Generate markdown API documentations for C++ libraries

• Host: GitHub
• URL: https://github.com/d99kris/doxygenmd
• Owner: d99kris
• License: gpl-2.0
• Created: 2018-03-31T15:00:12.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-15T08:24:42.000Z (almost 3 years ago)
• Last Synced: 2024-07-07T00:37:46.718Z (over 1 year ago)
• Topics: c-plus-plus, doxygen, markdown
• Language: C++
• Homepage:
• Size: 4.45 MB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Doxygenmd

=========

| **Linux** | **Mac** |

|-----------|---------|

| [![Linux](https://github.com/d99kris/doxygenmd/workflows/Linux/badge.svg)](https://github.com/d99kris/doxygenmd/actions?query=workflow%3ALinux) | [![macOS](https://github.com/d99kris/doxygenmd/workflows/macOS/badge.svg)](https://github.com/d99kris/doxygenmd/actions?query=workflow%3AmacOS) |

Doxygenmd is a simple tool for generating markdown API documentation

from source code.

Supported languages: C++

Example Usage

=============

    $ doxygenmd src doc

Supported Platforms

===================

Doxygenmd is developed and tested on Linux and macOS. Current version has been

tested on:

- macOS Big Sur 11.0

- Ubuntu 20.04 LTS

Build / Install

===============

Linux / Ubuntu

--------------

**Dependencies**

    sudo apt install bison flex git

**Source**

    git clone https://github.com/d99kris/doxygenmd && cd doxygenmd

**Build**

    mkdir -p build && cd build && cmake .. && make -s

**Install**

    sudo make install

macOS

-----

**Dependencies**

    brew install bison flex

**Source**

    git clone https://github.com/d99kris/doxygenmd && cd doxygenmd

**Build**

    mkdir -p build && cd build && cmake .. && make -s

**Install**

    make install

Technical Details

=================

Doxygenmd is implemented in Python. It uses Doxygen to parse source code

and generate man-pages, which it subsequently processes and converts into

Markdown.

The source tree includes the source code of the following third-party

softwares:

- [Doxygen](https://github.com/doxygen/doxygen) - GPLv2 License - Copyright (C) by Dimitri van Heesch

License

=======

Doxygenmd is distributed under the GPLv2 license. See [LICENSE](/LICENSE) file.

Keywords

========

api documentation, doxygen, generate, markdown.