:documentation option for define-command

• To: oli@ims.uni-stuttgart.de, clim@BBN.COM
• Subject: :documentation option for define-command
• From: Scott McKay <SWM@stony-brook.scrc.symbolics.com>
• Date: Tue, 22 Dec 1992 10:24-0500
• In-Reply-To: <9212221128.AA02866@adler.ims.uni-stuttgart.de>

    Date: Tue, 22 Dec 1992 06:28 EST
    From: Oliver Christ <oli@adler.ims.uni-stuttgart.de>

    I think it would be quite useful if CLIM (2.0?) would provide a :documentation
    option for define-command. The value of this key could serve as the
    documentation string for the created (command) function. One could then
    implement a simple 'help' facility for the commands the UI provides:

      (format *standard-output* "Enter the command you need help for: ")
      (documentation (first (clim:read-frame-command clim:*application-frame*)) 
		     'function)

    (This code is only to illustrate the idea). What do you think about it? Are
    there any difficulties to be expected from presentation-to-command-translators? 

No :DOCUMENTATION keyword is necessary, since the following correctly
puts the doc string in the appropriate place in the function COM-FOO
so that DOCUMENTATION can retrieve it.

  (clim:define-command com-foo ((arg 'form))
    "doc string"
    (print arg))


0,,

• :documentation option for define-command
• From: Oliver Christ <oli@adler.ims.uni-stuttgart.de>

• Prev: :documentation option for define-command
• Next: hermes 7.0 alpha test
• Index: CLIM Mailing list (1-Sep-92 to 31-Dec-92)
• Thread: CLIM Mailing list Index (1-Sep-92 to 31-Dec-92)