Generated: July 9, 2004, 14:37:14 Copyright © 2004 , Kurt Nørmark The local LAML software home page

Tutorial Manual - A Mixed Example

Kurt Nørmark © normark@cs.auc.dk Department of Computer Science Aalborg University Denmark

LAML Version 24.00 (July 9 2004, beta 5, full)

This is just an example of a manual - adapted from an existing LAML example, and part of the LAML tutorial. The example shows how to mix an LAML manual style document with contributions extracted via SchemeDoc.

Table of Contents:
1. Introduction 2. The fac and fib functions. 3. A couple of higher order function.

Alphabetic index:
compose (compose f g) A higher order function that composes two functions.
f (f a b) Description of function f - a function described in a manual-page
fac (fac n) Calculate the factorial of n
fib (fib n) Calculated the fib function.
negate (negate p) A higher order functions which negates the predicate p.

1 Introduction
This is an introduction, authored in a manual section.

f
Form (f a b)
Description Description of function f - a function described in a manual-page
Precondition What to ensure before f is called
Parameters a Explanation of a
b Explanation of g
See also similar function g
Note What else to to say about f

2 The fac and fib functions.
These functions are found in the source file prog4.scm. The manual stuff for these is done via SchemeDoc. See also the other section.

fac
Form (fac n)
Description Calculate the factorial of n

fib
Form (fib n)
Description Calculated the fib function. Notice that this is a very inefficient Implementation.

3 A couple of higher order function.
These functions are useful in many situations. You may also consult the first section.

negate
Form (negate p)
Description A higher order functions which negates the predicate p. Negate accepts a predicate and returns the negated predicate.
.parameter In case I need to start this line with a dot, which is not an internal tag.
Parameters p A predicate

compose
Form (compose f g)
Description A higher order function that composes two functions. Returns a function which applies f on g. Both f and g are supposed to take a single argument. It is possible to use the escaping character $ by escaping it. Thus, to writte dolar twice, you must write $$.
Returns Return value description
See also section abc
section SECTION2
Note Miscelaneous information
Internal remark Internal comment


Generated: July 9, 2004, 14:37:14
Generated by LAML SchemeDoc .