How to Install CppDoc

CppDoc is an open source program which is distributed for Windows and Linux Systems so it is readily available for software developers to use to create reliable documentation. The website dedicated to working with this software is listed below.This website houses all of the important documentation and files needed to run CppDoc on Windows and Linux.

Windows

The process involves downloading the executable file to install CppDoc on the PC.

Download Page

Windows automatically reconizes the file as an executable. Navigate to where you downloaded the file to and run the executable by double-clicking the icon. Follow the on-screen instructions.Once the executable is finished running the program will be accessible in the location specified.

Linux

In a Linux environment, it is a little more complex since everything is mostly done through a command line prompt with a server or Linux Desktop. If using a KDE or GNOME desktop the program can be download through the link provided on the web page using the Archive Manager.

Download Page

It can also be accessed through a terminal prompt using the following instructions.

RedHat/Fedora

% wget http://www.cppdoc.com/cppdoc2.tar.gz

FreeBSD

% fetch http://www.cppdoc.com/cppdoc2.tar.gz

The file comes in tar.gz format so it will have to be g-unzipped and un-tarred. Navigate to the location in the file system in which the cppdoc contents was downloaded and execute the following statements.

% gunzip cppdoc2.tar.gz

% tar -xvf cppdoc2.tar

If your feeling lazy you can do both in one step as follows:

% tar -xzvf cppdoc2.tar.gz

These commands will create itself a directory called cppdoc2/ and the program is just an executable script that will create the needed documentation once you give the proper source path and destination names and any optional flags.

The CppDoc webpage also has an add-on features that may prove useful to software developers. CppDoc Comment Maker is a Visual Studio plug-in that allows for generation of comment fields and supplies comment templates for any class, sub method function, or variables. It can prove useful for generalizing sections of code and the relations to others.

Back to CppDoc