Data processing: software development – installation – and managem – Software program development tool – Code generation
Reexamination Certificate
2000-02-02
2004-01-06
Das, Chameli C. (Department: 2122)
Data processing: software development, installation, and managem
Software program development tool
Code generation
C717S100000, C717S114000, C717S116000, C717S142000, C717S143000, C715S252000, C715S252000, C715S252000
Reexamination Certificate
active
06675370
ABSTRACT:
BACKGROUND OF THE INVENTION
1. Field of Invention
The present invention generally relates to Literate Programming. The method and apparatus of the present invention have particular application to automatic generation of software documentation.
2. Discussion of Prior Art
The support and maintenance of large, complex software applications are made much simpler by embedding documentation and explanatory comments in the application's source code. The concept of “Literate Programming” is a big effort in this area. Its proponents advocate a system where a program's source code and comments read almost like a technical journal article.
In Literate Programming, software tools are used to automatically generate documentation from a program's source code file, a process known as weaving. With the recent pervasiveness of the Internet, much effort has been applied to create methods to automatically generate browsable documentation which takes advantage of hyperlinking and other HTML properties.
The prior art, discussed below, describes different methods of parsing source code to generate documentation or additional code automatically.
The patent to Brisson (U.S. Pat. No. 5,678,052) provides an automated translation method between high level programming languages. This reference focuses on maintaining valid pre-processor constructs between the different translations.
The patent to De Bonet (U.S. Pat. No. 5,905,894) teaches extending programming language precompiler directive functionality to support the passing of code segments as arguments to other functions at compile time. The goal is to improve run-time performance and does not involve documentation generation.
The patent to Takeuchi (U.S. Pat. No. 5,526,522) teaches automatic programming generation which converts a specification document into a syntactic tree and then recursively creates source code.
The patent to Andres et al. (U.S. Pat. No. 5,768,564) provides for a grammar converter which parses a text-based BNF grammar and produces a compressed “rail-road” diagram.
Two Literate Programming tools presently available are NuWeb(TM) and FunnelWeb(TM). They are language independent pre-processors and can produce documentation in HTML according to macro definitions in user programs.
Javadoc is a standard tool of a Java compiler that parses the declarations and comments in a set of Java source files and produces a set of HTML pages describing the files' classes, interfaces, methods and fields. Typically, for each class, a single HTML document is generated.
Whatever the precise merits and features of the prior art in this field, the earlier art does not achieve or fulfill the purposes of the present invention. The prior art does not provide for automatically generating documentation for an object-oriented application which enables cross-linking between the different classes.
SUMMARY OF THE INVENTION
In the present invention, documentation of a software application is automatically generated for the classes, written in an object oriented-language, which comprise the application. The classes within the application are typically arranged in a hierarchy and contain productions of a specification grammar in Extended Backus Naur form. The automatically generated documentation corresponding to these productions is closely wired to the underlying class hierarchy by creating hypertext links between the productions in different classes. Thus, these generated hyperlinks allow browsing of the automatically generated documentation according to the hierarchical structure of the classes in the object-oriented class hierarchy being documented.
REFERENCES:
patent: 5333317 (1994-07-01), Dann
patent: 5526522 (1996-06-01), Takeuchi
patent: 5530852 (1996-06-01), Meske et al.
patent: 5678052 (1997-10-01), Brisson
patent: 5768564 (1998-06-01), Andrews et al.
patent: 5905894 (1999-05-01), De Bonet
patent: 6073143 (2000-06-01), Nishikawa et al.
patent: 6083276 (2000-07-01), Davidson et al.
patent: 6272673 (2001-08-01), Dale et al.
patent: 6275862 (2001-08-01), Sharma et al.
patent: 6336211 (2002-01-01), Soe
patent: 6336214 (2002-01-01), Sundaresan
patent: 6405365 (2002-06-01), Lee
patent: 6480865 (2002-11-01), Lee et al.
patent: 6487566 (2002-11-01), Sundaresan
patent: 6516322 (2003-02-01), Meredith
patent: 6594823 (2003-07-01), Corbin et al.
patent: 6596031 (2003-07-01), Parks
Title: Implementing Catalog clearinghouses with XML and XSL, author: Royappa, ACM, 1998.*
Title: Analysis and Conversion of Documents, author: Tayen-Bey, IEEE, 1998.*
Title: Declarative specification of data-intensive Web sites, author: Fernández, ACM, 1999.*
Title: Enabling hypermedia messaging: BPRM—a body part relationship module, author: K. Lenssen, ACM, 1994.*
“Nuweb Version 0.87b a Simple Literate Programming Tool” http://www.tu-chemnitz.de/~ukn/UNIX
uwebdoc
uwebdoc.html.
“FunnelWeb” http://www.ross.net/funnelweb/.
“Javadoc 1.2” http://java.sun.com/products/jdk/1.2/docs/tooldocs/javadoc/index.html.
“IBM, Oracle, Unisys Back XMI Standard” http://www.computerworld.com/home
ews.nsf/aa/9811124xmi2.
Das Chameli C.
Lacasse Randy W.
Lacasse & Associates LLC
MacCabe, Esq. Mark M.
LandOfFree
System and method for imbedding hyperlinked language grammar... does not yet have a rating. At this time, there are no reviews or comments for this patent.
If you have personal experience with System and method for imbedding hyperlinked language grammar..., we encourage you to share that experience with our LandOfFree.com community. Your opinion is very important and System and method for imbedding hyperlinked language grammar... will most certainly appreciate the feedback.
Profile ID: LFUS-PAI-O-3249615