https://github.com/michaelrsweet/codedoc

Documentation generator for C/C++ code
https://github.com/michaelrsweet/codedoc

code documentation epub html man

Last synced: about 2 months ago
JSON representation

Documentation generator for C/C++ code

• Host: GitHub
• URL: https://github.com/michaelrsweet/codedoc
• Owner: michaelrsweet
• License: apache-2.0
• Created: 2019-01-03T01:22:03.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-23T02:04:03.000Z (9 months ago)
• Last Synced: 2024-10-13T08:44:12.504Z (2 months ago)
• Topics: code, documentation, epub, html, man
• Language: C
• Homepage: https://www.msweet.org/codedoc
• Size: 1.06 MB
• Stars: 48
• Watchers: 6
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Codedoc v3.7

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

![Version](https://img.shields.io/github/v/release/michaelrsweet/codedoc?include_prereleases)

![Apache 2.0](https://img.shields.io/github/license/michaelrsweet/codedoc)

Codedoc is a general-purpose utility which scans HTML, markdown, C, and C++

source files to produce EPUB, HTML, and man page documentation that can be read

by humans.  Unlike popular C/C++ documentation generators like Doxygen or

Javadoc, Codedoc uses in-line comments rather than comment headers, allowing for

more "natural" code documentation.  Additional markdown documentation content

can be included to make the generated documentation even more useful and

complete.

Codedoc was originally bundled with the Mini-XML library as the `mxmldoc`

utility.

Building Codedoc

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

Codedoc comes with the usual configure script and makefile that will work on

most Linux/UNIX systems and macOS.  Prerequisites include ZLIB 1.1 or later and

Mini-XML 4.x.

Run the following commands to build the software:

    ./configure

    make

The default install prefix is `/usr/local`, which can be overridden using the

`--prefix` option:

    ./configure --prefix=/some/other/directory

    make

Installing Codedoc

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

To install the software, run:

    sudo make install

Documentation

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

The codedoc man page provides documentation on how to use it.  Further

documentation can be found in the file "DOCUMENTATION.md" and the generated

"codedoc.html" file.

Getting Help And Reporting Problems

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

The codedoc project page provides access to the Github issue tracking page:

    https://www.msweet.org/codedoc

Legal Stuff

-----------

Copyright © 2003-2024 by Michael R Sweet

Codedoc is licensed under the Apache License Version 2.0.  See the files

"LICENSE" and "NOTICE" for more information.