Browse Prior Art Database

Object-Oriented Documentation Tool

IP.com Disclosure Number: IPCOM000120740D
Original Publication Date: 1991-Jun-01
Included in the Prior Art Database: 2005-Apr-02
Document File: 2 page(s) / 75K

Publishing Venue

IBM

Related People

Cavendish, C: AUTHOR [+2]

Abstract

Object-oriented programming technology allows for code to be developed for classes which are then reusable for future software development projects. This reusability extends not only to the production of application software but also to tools development as well. Since the classes must all be part of an overall framework or library, it is necessary to standardize the methods for documenting the actual application software classes and the framework classes in the class library.

This text was extracted from an ASCII text file.
This is the abbreviated version, containing approximately 52% of the total text.

Object-Oriented Documentation Tool

      Object-oriented programming technology allows for code to
be developed for classes which are then reusable for future software
development projects. This reusability extends not only to the
production of application software but also to tools development as
well. Since the classes must all be part of an overall framework or
library, it is necessary to standardize the methods for documenting
the actual application software classes and the framework classes in
the class library.

      The invention described here includes three generic methods for
the documentation of the code, tracking changes in the code and for
the production of the class library documentation which would be
delivered along with the application classes. These methods are
provided as extensions to a class hierarchy browser which is a
standard tool for an object-oriented development environment.

      The first method builds the documentation for the class itself
and returns the text when called by the document producer. In other
words it has a return value which is the document itself. So when the
hard copy (or system copy) of the documentation is produced, each
class is capable of writing its own documentation.

      All of the text is formatted automatically. This allows the
documentation object to process the commented source code and produce
script-formatted design documentations of entire projects.

      When a developer creates a new class, he can select the README
method from the class hierarchy browser and the predefined
documentation for the class is generated automatically, includin...