Open Source Developers' Conference 2005 OSDC Logo
 

 

 

Using documentation for automatic code generation

To add a paper, Login.

Having started work on a project that had an undocumented API and no documentation or help, I quickly found myself using the existing code to manually create documentation. Once that process was complete, quickly used that same documentation to generate large parts of the API for the project (almost 50%).

By writing just the glue logic and having API code generated from the documentation, adding and changing the interface required only a recompilation of the source to recreate the API.


Keywords: documentation, python, c
Stream: Python, C/C++
Presentation Type: 30 minute Paper Presentation in English
Paper: Using Documentation for Automatic Code Generation


Cameron Blackwood

Researcher, Department of Computer Science and Software Engineering,
Faculty of Engineering, The University of Melbourne

AUSTRALIA

I work on the aditi project, a deductive database for use with the Mercury constraint/logic language. Im working on the client interface and network API. Aditi is written in c++, Mercury in c, so the api is also written in c. Python has been used all through the project as glue code and to automatically generate files and code.

Ref: OS5P0023

 
 
Melbourne Perl Mongers DList
Digital Dimensions
Copyright © 2005
OSDC 2005 hosted by Melbourne Perl Mongers
For futher information contact Scott Penrose
Hosting provided by Digital Dimensions and DList
Web site and logo design by Amanda Penrose