2 Tutorial

Using MkDoc is simple and doesn't need specific installation, see the Install section.

To start using MkDoc on your code, cd into your C or C++ project directory and create an initial documentation directory by using the --bootstrap option. Several profiles are available to create the initial documentation:

You can then invoke mkdoc with header files or directories as arguments:

It will parse your header files and generate the documentation.

You may now edit the doc/mkdoc.conf file to change or add configuration options and edit the doc/*.mkdoc files to change the default document layout and write your plain documentation. Then just execute MkDoc again.