[ Reference Manual | Alphabetic Index ]

# library(document)

Tools for generating documentation from ECLiPSe sources [more]

## Predicates

> comment_to_html(?, ?)
>   No description available
> eci_to_html(++EciFile, ++HtmlTopDir, ++LinkBack)
>   Create HTML documentation from one .eci file
> ecis_to_htmls
>   Generate the HTML documentation tree for all ECLiPSe libraries
> ecis_to_htmls(++LibDirs, ++HtmlTopDir, ++LinkBack)
>   Generate an HTML documentation tree for the given library directories
> ecis_to_htmls(++LibDirs, ++HtmlTopDir, ++LinkBack, ++SystemName)
>   Generate an HTML documentation tree for the given library directories
> gen_cons_table(+HtmlTopDir, ++Roots, +Title)
>   Generate an HTML table of the constraints of the given types
> htmlify_string(?, ?)
>   No description available
> icompile(+File)
>   Generates an information file from the ECLiPSe source File.
> icompile(+File, +Destination)
>   Generates an information file from the ECLiPSe source File in directory Destination.
> object_spec_to_filename(?, ?)
>   No description available

## Description

This library contains the tools necessary to generate documentation from ECLiPSe sources. It complements the file-to-file compiler (compile/2) as follows:

        xyz.ecl  ---compile-->   xyz.eco
        xyz.ecl  ---icompile-->  xyz.eci  ---eci_to_html-->  xyz/...html

## About

- Status: stable
- Author: Kish Shen and Joachim Schimpf, IC-Parc
- Copyright © Cisco Systems, Inc
- Date: $Date: 2016/07/24 19:34:44 $

Generated from document.eci on 2020-02-26 22:26