Generated: June 7, 2005, 21:58:12 A SchemeDoc Manual

SchemeDoc Demo

Kurt Normark © Aalborg University, Denmark

Source file: /user/normark/scheme/examples/schemedoc/scheme-documentation-tools/prog1a.scm
LAML Version 27.0 (June 2, 2005, development)

This is a brief example of a Scheme program with SchemeDoc comments, using the documentation mark style.

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

Alphabetic index:
fac (fac n) The factorial function.
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 function. 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 functions.

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: June 7, 2005, 21:58:12
Generated by LAML SchemeDoc.