mainMkDoc, user manual generation tool for C/C++ projects - Summary

 
 
Membership Info
Project Admin:
1 active member

Group identification
Id: #10367
System Name: mkdoc
Name: MkDoc, user manual generation tool for C/C++ projects
Group Type: non-GNU software and documentation

Search in this Group

in
   

This project is not part of the GNU Project.

MkDoc is a documentation tool designed to write user manual and internal documentation for software projects. MkDoc has been designed to parse C and complex C++ declarations while still producing clear documentation for developers and library users.

Unlike most code generation tools MkDoc does not simply write generated code documentation with piece of user text inside. Instead it handles plain documentation files with sections and other constructs (like texinfo or latex) and insert piece of generated code documentation on request. This way it does not enforce the way you structure your document.

It has been designed to parse advanced C++ constructs to enable exposing a simple library API to the user while hidding complex internal code design patterns. It is able to parse class inheritance, template specialization and do template instantiation.

Supported output formats are Html, Latex, GNU Texinfo, DocBook, man page, plain text, RTF and reStructuredText.

See the manual for examples of projects documented using MkDoc.

Registration Date: Tue 13 Oct 2009 02:43:37 PM UTC
License: GNU General Public License v2 or later
Development Status: 4 - Beta

 


Back to the top


Powered by Savane 3.1-cleanup