Generated: Monday, November 14, 2011, 09:23:59 | Copyright © 2011 , Kurt Nørmark | ![The local LAML software home page](../../../../images/laml-home.gif) |
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.
|
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 |
|