Generated: May 25, 2004, 14:02:49 A SchemeDoc Manual

SchemeDoc Demo

Kurt Nørmark © Aalborg University, Denmark

Source file: /user/normark/scheme/examples/manual-xml-in-laml/scheme-documentation-tools/prog1.scm
LAML Version 24.00 (December, 2003, development)

This is a brief example of a Scheme program with SchemeDoc comments.

Table of Contents:
1. Factorials. 2. List selection functions.

Alphabetic index:
fac (fac n) The factorial functions.
head (head pair) An alias of car.
tail (tail pair) An alias of cdr.

1 Factorials.
This section demonstrates a plain function.

fac
Form (fac n)
Description The factorial functions. Also known as n!.
Precondition n >= 0.
Parameters n An integer.
Returns n * (n-1) * ... * 1

2 List selection functions.
This section demonstrates two aliased funcitions.

head
Form (head pair)
Description An alias of car.
Parameters pair a cons cell
Returns the first component of a cons cell

tail
Form (tail pair)
Description An alias of cdr.
Parameters pair a cons cell
Returns the second component of a cons cell.


Generated: May 25, 2004, 14:02:49
Generated by LAML SchemeDoc .
This documentation has been extracted automatically from the Scheme source file.