WO2005029324A3 - Automated source code software programmer's manual generator - Google Patents

Automated source code software programmer's manual generator Download PDF

Info

Publication number
WO2005029324A3
WO2005029324A3 PCT/US2004/030425 US2004030425W WO2005029324A3 WO 2005029324 A3 WO2005029324 A3 WO 2005029324A3 US 2004030425 W US2004030425 W US 2004030425W WO 2005029324 A3 WO2005029324 A3 WO 2005029324A3
Authority
WO
WIPO (PCT)
Prior art keywords
source code
software
documentation
file
tool
Prior art date
Application number
PCT/US2004/030425
Other languages
French (fr)
Other versions
WO2005029324A2 (en
Inventor
Chandra Kamalakantha
Original Assignee
Electronic Data Syst Corp
Chandra Kamalakantha
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by Electronic Data Syst Corp, Chandra Kamalakantha filed Critical Electronic Data Syst Corp
Priority to EP04784316A priority Critical patent/EP1665035A2/en
Priority to CA002537312A priority patent/CA2537312A1/en
Priority to AU2004273930A priority patent/AU2004273930A1/en
Publication of WO2005029324A2 publication Critical patent/WO2005029324A2/en
Publication of WO2005029324A3 publication Critical patent/WO2005029324A3/en

Links

Classifications

    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F8/00—Arrangements for software engineering
    • G06F8/70—Software maintenance or management
    • G06F8/73—Program documentation

Abstract

A method, system, and computer program product for generating a software documentation file from a software source code file is provided. In one embodiment, the source code file for the software is read by the automatic program documentation generation tool. The tool extracts software documentation from the source code file, by for example, locating documentation begin and end indicia within the source code and extracting the data contained within the indicia. The documentation has been previously written into the source code by a software developer, programmer, or engineer. The tool then creates a software documentation file, such as, for example, a UNIX Man Page or an HTML page, from the extracted software documentation extracted from the source code. The software documentation file is typically stored in a central repository.
PCT/US2004/030425 2003-09-17 2004-09-17 Automated source code software programmer's manual generator WO2005029324A2 (en)

Priority Applications (3)

Application Number Priority Date Filing Date Title
EP04784316A EP1665035A2 (en) 2003-09-17 2004-09-17 Automated source code software programmer's manual generator
CA002537312A CA2537312A1 (en) 2003-09-17 2004-09-17 Automated source code software programmer's manual generator
AU2004273930A AU2004273930A1 (en) 2003-09-17 2004-09-17 Automated source code software programmer's manual generator

Applications Claiming Priority (4)

Application Number Priority Date Filing Date Title
US50355703P 2003-09-17 2003-09-17
US60/503,557 2003-09-17
US10/854,118 2004-05-26
US10/854,118 US20050060688A1 (en) 2003-09-17 2004-05-26 Automated source code software programmer's manual generator

Publications (2)

Publication Number Publication Date
WO2005029324A2 WO2005029324A2 (en) 2005-03-31
WO2005029324A3 true WO2005029324A3 (en) 2005-06-30

Family

ID=34278991

Family Applications (1)

Application Number Title Priority Date Filing Date
PCT/US2004/030425 WO2005029324A2 (en) 2003-09-17 2004-09-17 Automated source code software programmer's manual generator

Country Status (5)

Country Link
US (1) US20050060688A1 (en)
EP (1) EP1665035A2 (en)
AU (1) AU2004273930A1 (en)
CA (1) CA2537312A1 (en)
WO (1) WO2005029324A2 (en)

Families Citing this family (23)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US7568184B1 (en) * 2004-04-14 2009-07-28 Sun Microsystems, Inc. Software documentation generator
US7788640B2 (en) * 2004-12-28 2010-08-31 Microsoft Corporation Using code analysis to generate documentation
US7910500B2 (en) * 2005-03-28 2011-03-22 Idemitsu Technofine Co., Ltd. Fiber treatment agent, fiber treated with such fiber treatment agent, fiber fabric, laminate and method for treating fiber
CN1869973A (en) * 2005-05-27 2006-11-29 国际商业机器公司 Method and system for generating file
US20070162259A1 (en) * 2006-01-10 2007-07-12 Garrett Tricia Y Method for converting a log of user manipulations of a computer program into task documentation
EP1883011A1 (en) * 2006-07-21 2008-01-30 Software Ag System and methods for generating runtime messages
US8316351B2 (en) * 2007-05-07 2012-11-20 Microsoft Corporation Utilizing a schema for documenting managed code
US20100211574A1 (en) * 2007-06-04 2010-08-19 Purdue Research Foundation Method and Apparatus for Obtaining Forensic Evidence from Personal Digital Technologies
US10452768B2 (en) * 2007-11-03 2019-10-22 International Business Machines Corporation Managing source annotation metadata
US9996368B2 (en) * 2007-12-28 2018-06-12 International Business Machines Corporation Method to enable semi-automatic regeneration of manuals by saving manual creation operations as scripts
US20090210861A1 (en) * 2008-02-20 2009-08-20 Mariana Alupului Dita doclet tool and method for extracting and analyzing api documentation
US20090288072A1 (en) * 2008-05-15 2009-11-19 International Business Machines Corporation Automatic Tests of Product Documentation
US20120110030A1 (en) 2009-04-10 2012-05-03 Mark Pomponio Software database system and process of building and operating the same
WO2011042249A1 (en) 2009-10-08 2011-04-14 International Business Machines Corporation A method and system for synchronizing changes between product development code and related documentation
CN102129365A (en) * 2010-01-20 2011-07-20 阿里巴巴集团控股有限公司 Method and device for generating code documentations
US8819629B2 (en) * 2010-02-17 2014-08-26 Red Hat, Inc. Automatically generating documentation on application programming interfaces
EP2749588B1 (en) * 2011-09-09 2015-12-16 Asahi Kasei Fibers Corporation Polyketone porous film
US9069646B2 (en) * 2012-12-17 2015-06-30 Sap Se Automatic documentation generator
US8887179B2 (en) * 2013-01-17 2014-11-11 Ca, Inc. Command presentation and generation systems, methods and computer program products using logical trees
FR3004556A1 (en) * 2013-04-10 2014-10-17 Bull
CN104156198A (en) * 2013-05-14 2014-11-19 广东电网公司信息中心 Method and device for automatically generating software integration version updating description
US9575751B2 (en) 2015-06-23 2017-02-21 Microsoft Technology Licensing, Llc Data extraction and generation tool
US11100076B2 (en) 2016-03-08 2021-08-24 Hartford Fire Insurance Company Processing system for automated electronic record creation and transmission

Citations (2)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
DE19926370A1 (en) * 1999-06-10 2000-12-14 Abb Research Ltd System for documentation, archiving and locating re-useable software components has version management system, central documentation generation system, search engine, web server
US20020059348A1 (en) * 2000-11-14 2002-05-16 Cypress Semiconductor Corp. Automatic documentation generation tool and associated method

Patent Citations (2)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
DE19926370A1 (en) * 1999-06-10 2000-12-14 Abb Research Ltd System for documentation, archiving and locating re-useable software components has version management system, central documentation generation system, search engine, web server
US20020059348A1 (en) * 2000-11-14 2002-05-16 Cypress Semiconductor Corp. Automatic documentation generation tool and associated method

Non-Patent Citations (1)

* Cited by examiner, † Cited by third party
Title
FREE SOFTWARE FOUNDATION: "Help2man", 3 December 2001 (2001-12-03), BOSTON USA, pages 1 - 5, XP002324042, Retrieved from the Internet <URL:http://www.gnu.org/software/help2man/> [retrieved on 20050411] *

Also Published As

Publication number Publication date
AU2004273930A1 (en) 2005-03-31
US20050060688A1 (en) 2005-03-17
CA2537312A1 (en) 2005-03-31
EP1665035A2 (en) 2006-06-07
WO2005029324A2 (en) 2005-03-31

Similar Documents

Publication Publication Date Title
WO2005029324A3 (en) Automated source code software programmer&#39;s manual generator
US7853924B2 (en) Systems and methods for processing non-functional commentary of computer source code
EP0926592A3 (en) Software emulation system
WO2006041554A3 (en) Document processing and management approach to editing a document in a mark up language environment using undoable commands
ATE252747T1 (en) METHOD AND SYSTEM FOR DEVELOPING, USING, DISTRIBUTION, AND EXECUTION DATABASE-DRIVEN WEBSITES
EP2256623A3 (en) System and method for generating and maintaining software code
EP1170661A3 (en) Method and system for improving performance of applications that employ a cross-language interface
WO2005052760A3 (en) System for optimizing application start-up
EP0933707A3 (en) Relocatable instrumentation tags for testing and debugging a computer program
EP1280069A3 (en) Statistically driven sentence realizing method and apparatus
DE69921474D1 (en) METHOD REFERENCING IN OBJECT-BASED PROGRAMMING
US20060150150A1 (en) Editor support for modifying generated source code
EP1484695A3 (en) Automatic task generator method and system
WO2005036391A3 (en) Visual programming system and method
WO2004029808A3 (en) System and method for remote servicing of embedded devices
EP1349063A3 (en) Program simulation with just-in-time compilation
WO2001033409A3 (en) Computer generated poetry system
EP1118933A3 (en) Method, system, program, and data structures for transforming an instruction in a first bit architecture to an instruction in a second bit architecture
EP1146436A3 (en) Template animation and debugging tool
Hamilton et al. An evaluation of current java bytecode decompilers
WO2002037268A3 (en) Dialogue flow interpreter development tool
WO2005026962A3 (en) Improvements in or relating to test systems or programs
Blinman et al. Program comprehension: investigating the effects of naming style and documentation
WO2003057428A1 (en) A robot system and a method and a software product for the robot system
CN102629213A (en) Analysis method and monitoring method for C language simulation model

Legal Events

Date Code Title Description
AK Designated states

Kind code of ref document: A2

Designated state(s): AE AG AL AM AT AU AZ BA BB BG BW BY BZ CA CH CN CO CR CU CZ DK DM DZ EC EE EG ES FI GB GD GE GM HR HU ID IL IN IS JP KE KG KP KZ LC LK LR LS LT LU LV MA MD MK MN MW MX MZ NA NI NO NZ PG PH PL PT RO RU SC SD SE SG SK SY TJ TM TN TR TT TZ UA UG US UZ VN YU ZA ZM

AL Designated countries for regional patents

Kind code of ref document: A2

Designated state(s): GM KE LS MW MZ NA SD SZ TZ UG ZM ZW AM AZ BY KG MD RU TJ TM AT BE BG CH CY DE DK EE ES FI FR GB GR HU IE IT MC NL PL PT RO SE SI SK TR BF CF CG CI CM GA GN GQ GW ML MR SN TD TG

121 Ep: the epo has been informed by wipo that ep was designated in this application
WWE Wipo information: entry into national phase

Ref document number: 2004273930

Country of ref document: AU

WWE Wipo information: entry into national phase

Ref document number: 2004784316

Country of ref document: EP

WWE Wipo information: entry into national phase

Ref document number: 2537312

Country of ref document: CA

ENP Entry into the national phase

Ref document number: 2004273930

Country of ref document: AU

Date of ref document: 20040917

Kind code of ref document: A

WWP Wipo information: published in national office

Ref document number: 2004273930

Country of ref document: AU

WWE Wipo information: entry into national phase

Ref document number: 333/MUMNP/2006

Country of ref document: IN

WWP Wipo information: published in national office

Ref document number: 2004784316

Country of ref document: EP