Source file: /user/normark/.public_html/schemedoc/examples/ex1

This is some introduction to a Scheme program.

Table of Contents:

Alphabetic index:

a-final-function | (a-final-function y) | A final function |

add | (add x y) | The function f adds to numbers |

fac | (fac n) | Calculate the factorial of n |

sample-function | (sample-function) | A function that returns a number of factorial numbers. |

subtract | (subtract x y) | The function f subtracts to numbers |

yet-another-function | (yet-another-function x) | Yet another function |

1 Section one. | |||

This is section one. The two functions in this section are documented by quite a few SchemeDoc tags. | |||

add | |||

Form | (add x y) | ||

Description | The function f adds to numbers | ||

Precondition | Both a and b are numbers | ||

Parameters | x | The first number | |

y | The second number | ||

Returns | Return the sum of x and y | ||

Postcondition | The result is the sum of x and y | ||

Example | (add 1 2) | ||

See also | Scheme source file | add | |

Context | SchemeDoc | ||

next section | second | ||

the other function | subtract | ||

Note | Miscelaneous information | ||

subtract | |||

Form | (subtract x y) | ||

Description | The function f subtracts to numbers | ||

Precondition | Both a and b are numbers | ||

Parameters | x | The first number | |

y | The second number | ||

Returns | Returns x - y | ||

Postcondition | The result is the difference between x and y | ||

Example | (subtract 7 5) | ||

See also | Scheme source file | subtract | |

Context | SchemeDoc | ||

the other function | add | ||

2 Section two. | |||

This is the second section, only with a couple of functions. The comment of these functions are not documented with a lot of SchemeDoc tags. | |||

fac | |||

Form | (fac n) | ||

Description | Calculate the factorial of n | ||

See also | Scheme source file | fac | |

sample-function | |||

Form | (sample-function) | ||

Description | A function that returns a number of factorial numbers. | ||

See also | Scheme source file | sample-function | |

yet-another-function | |||

Form | (yet-another-function x) | ||

Description | Yet another function | ||

See also | Scheme source file | yet-another-function | |

a-final-function | |||

Form | (a-final-function y) | ||

Description | A final function | ||

See also | Scheme source file | a-final-function | |

Generated: Monday, January 23, 2006, 20:12:22

Generated by LAML SchemeDoc using LAML Version 30.2 (January 20, 2006, full, alpha)

Generated by LAML SchemeDoc using LAML Version 30.2 (January 20, 2006, full, alpha)