A system for automatically generating documentation for (C)LP programs

Hermenegildo, Manuel V. (2000). A system for automatically generating documentation for (C)LP programs. En: "WLPE'99, Tenth Workshop on Logic Programming Environments (in connection with ICLP'99, International Conference on Logic Programming)", 29 November 1999, Las Cruces, New Mexico, USA.

Descripción

Título: A system for automatically generating documentation for (C)LP programs
Autor/es:
  • Hermenegildo, Manuel V.
Tipo de Documento: Ponencia en Congreso o Jornada (Artículo)
Título del Evento: WLPE'99, Tenth Workshop on Logic Programming Environments (in connection with ICLP'99, International Conference on Logic Programming)
Fechas del Evento: 29 November 1999
Lugar del Evento: Las Cruces, New Mexico, USA
Título del Libro: Electronic Notes in Theoretical Computer Science
Fecha: Abril 2000
Materias:
Escuela: Facultad de Informática (UPM) [antigua denominación]
Departamento: Inteligencia Artificial
Licencias Creative Commons: Reconocimiento - Sin obra derivada - No comercial

Texto completo

[img]
Vista Previa
PDF (Document Portable Format) - Se necesita un visor de ficheros PDF, como GSview, Xpdf o Adobe Acrobat Reader
Descargar (1MB) | Vista Previa

Resumen

We describe lpdoc, a tool which generates documentation manuals automatically from one or more logic program source files, written in ISO-Prolog, Ciao, and other (C)LP languages. It is particularly useful for documenting library modules, for which it automatically generates a rich description of the module interface. However, it can also be used quite successfully to document full applications. A fundamental advantage of using lpdoc is that it helps maintaining a true correspondence between the program and its documentation, and also identifying precisely to what version of the program a given printed manual corresponds. The quality of the documentation generated can be greatly enhanced by including within the program text assertions (declarations with types, modes, etc.) for the predicates in the program, and machine-readable comments. One of the main novelties of lpdoc is that these assertions and comments are written using the Ciao system assertion language, which is also the language of communication between the compiler and the user and between the components of the compiler. This allows a significant synergy among specification, documentation, optimization, etc. A simple compatibility library allows conventional (C)LP systems to ignore these assertions and comments and treat normally programs documented in this way. The documentation can be generated in many formats including texinfo, dvi, ps, pdf, info, html/css, Unix nroff/man, Windows help, etc., and can include bibliographic citations and images. lpdoc can also generate “man” pages (Unix man page format), nicely formatted plain ascii “readme” files, installation scripts useful when the manuals are included in software distributions, brief descriptions in html/css or info formats suitable for inclusion in on-line indices of manuals, and even complete WWW and info sites containing on-line catalogs of documents and software distributions. The lpdoc manual, all other Ciao system manuals, and parts of this paper are generated by lpdoc.

Más información

ID de Registro: 14626
Identificador DC: http://oa.upm.es/14626/
Identificador OAI: oai:oa.upm.es:14626
URL Oficial: http://www.sciencedirect.com/science/article/pii/S1571066105806632
Depositado por: Biblioteca Facultad de Informatica
Depositado el: 13 Mar 2013 08:35
Ultima Modificación: 21 Abr 2016 14:22
  • Open Access
  • Open Access
  • Sherpa-Romeo
    Compruebe si la revista anglosajona en la que ha publicado un artículo permite también su publicación en abierto.
  • Dulcinea
    Compruebe si la revista española en la que ha publicado un artículo permite también su publicación en abierto.
  • Recolecta
  • e-ciencia
  • Observatorio I+D+i UPM
  • OpenCourseWare UPM