Browse Prior Art Database

c++doc - Program Which Extracts Documentation From Source Code.

IP.com Disclosure Number: IPCOM000013189D
Original Publication Date: 2001-Feb-01
Included in the Prior Art Database: 2003-Jun-17
Document File: 6 page(s) / 100K

Publishing Venue

IBM

Abstract

c++doc Program Which Extracts Documentation From Source Code. Disclosed is a program "c++doc" which extracts documentation from C/C++ source code. Disclosed program builds an HTML document from comments inserted into the source code. "c++doc" saves programmers time by eliminating the need to maintain separate documentation files and ensuring that documentation is up to date. "c++doc" relies on special comments inserted into the source code. Figure 1:

This text was extracted from a PDF file.
At least one non-text object (such as an image or picture) has been suppressed.
This is the abbreviated version, containing approximately 58% of the total text.

Page 1 of 6

c++doc - Program Which Extracts Documentation From Source Code.

Disclosed is a program "c++doc" which extracts documentation from C/C++ source code. Disclosed program builds an HTML document from comments inserted into the source code. "c++doc" saves programmers time by eliminating the need to maintain separate documentation files and ensuring that documentation is up to date.

"c++doc" relies on special comments inserted into the source code.

Figure 1:

/**

* Prints string at current cursor location.
*

 * @param aString String to be printed
* @param mode Text mode: <BOLD>NORMAL</BOLD> or
<BOLD>INVERTED</BOLD>.


)

Parameters:

aString

String to be printed

mode

1

Page 2 of 6

        Text mode: NORMAL or INVERTED Return Values:

If success, the method will return non-zero value. If method fails, the return value is going to be 0.

Exceptions;

This method produces OutOfBound exception.

"c++doc" takes advantage of C++ syntax to derive class dependencies. Resulting documentation clearly displays derived and encapsulated classes.

2

Page 3 of 6

Sample screenshots of documentation being viewed in HTML browser:

Figure 3:

3

[This page contains 1 picture or other non-text object]

Page 4 of 6

Figure 4:

4

[This page contains 1 picture or other non-text object]

Page 5 of 6

Screen is divided into two frames. Initially left frame lists all available classes and the right frame displays general information about the project. Once any of the objects is clicked, the right frame will change to show d...