Generated: Monday, November 14, 2011, 09:23:59 Copyright © 2011 , Kurt NÝrmark The local LAML software home page

SchemeDoc Demo

Kurt Normark Aalborg University, Denmark

LAML Source file: examples/schemedoc/scheme-documentation-tools/prog1.scm

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

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: Monday, November 14, 2011, 09:23:59
Generated by LAML SchemeDoc using LAML Version 38.0 (November 14, 2011, full)