Tutorial ProgDOC

ProgDOC - a Program Documentation SystemVolker SimonisWilhelm Schickard Institut urf¨ InformatikUniversitat¨ Tubingen,¨ 72076 Tubingen,¨ GermanyE mail : simonis@informatik.uni tuebingen.deVersion 1.14 (ProgDOC Rel. 1.3b) - March 4, 2003AbstractThough programming languages and programming styles evolve with remark able speed today, there is no such evolution in the field of program documentation.And although there exist some popular approaches like Knuth’s literate program ming system WEB [Web] and nowadays JavaDoc [JDoc] or DOC++ [DOCpp],tools for managing software development and documentation are not as widespreadas desirable. This paper introduces a small tool box of utilities which can be usedto easily produce nicely formatted PostScript, PDF and HTML documentations forAsoftware projects with LT X. It is especially useful for mixed language projectsEand for documenting already finished programs and libraries. Due to it’s sophis ticated syntax highlighting capabilities (currently implemented for C/C++/Java,Scheme/Elisp and XML) it is also a good choice for writing articles or technicalwhite papers which contain source code examples.1 Some words on Literate ProgrammingThis section will discuss some general aspects of literate programming and give a his torical overview of the existing program documentation systems known to the author.Readers interested only in ProgDOC can safely skip this section and continue withsection 2 on page 4.With an ...