next up previous
Next: Overloading and Structuring Up: Elaboration of Hooks Previous: Hook Combinators

Hook Documentation

  A hook documentation form allows a piece of informal documentation to be attached to a hook definition.gif

(hook-documentation hook-id documentation-string).

The information in the documentation string plays an important role in the tools, which support the hook mechanism. This will be discussed in section 6.

When a Lisp program is written or loaded, it is important that the Lisp programming environment gets a chance to be aware of the hooks of the program. The right way to achieve that is to modify the Lisp reader to do something special when a hook construct is encountered in a Lisp expression.gif Alternatively, the environment may get its knowledge of hooks through the hook documentation clauses. Following the latter approach, it is necessary to require that all hook documentation clauses are placed at the outer expression level of a Lisp program.

Kurt Noermark
Wed Mar 6 09:44:24 MET 1996