[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[no subject]

DEFVAR should accept a documentation string as its fourth argument.  For
that matter, it should be possible to include documentation strings in
DEFCLASS, DEFMETHOD, DEFSTRUCT, and other symbol definition forms.  The
documentation information may want to be more structured than just a simple
string, and perhaps a protocol should be designed which can be used and
extended by other subsystems.  But while tools may not currently exist for
viewing documentation strings from ZWEI or the error handler, DEFVAR should
accept them so that they can be included in new code.  I.e. we can write

(DEFVAR X 0.0 "current x position")

instead of

(DEFVAR X 0.0)  ;current x position

Is anybody thinking about compiling part of the manual from documentation
contained in the code?