Re: [Chicken-users] egg documentation

[Jim Ursetto]

<proc> and <macro> look good.  The wiki pages use either
 '''procedure:''' (proc a b)          or
 [procedure] (proc a b)

depending on the author, so the rendering is up to you.

On 2/19/08, Alejandro Forero Cuervo <address@hidden> wrote:
> > <param>eggdoc:doctype</param>

> Is this meant to be used as in "The procedure sets the contents of the
> string <param>a</param> to a copy of the contents of
> <param>b</param>"?

No.  To define a SRFI-39 parameter.  It would expand to
  [parameter] '''eggdoc:doctype'''

according to your expansion of proc/macro.  For parameters
a procedure syntax should be accepted as well, e.g.
<param>(eggdoc:doctype TYPE)</param>.

> > <record>hostinfo</record>
> > <signature type="string">doctype:xhtml-1.0-strict</signature>

> Care to give me an example as to how these are used and what you think
> they should expand to?  I'm not completely sure I understand their
> semantics.

Same thing.  Semantics are they introduce a definition, not that they
are used whenever this type is encountered in the text.
Check out any of the existing eggs, such as objc:

<read>@[RECEIVER KEYWORD ARGUMENT ...]</read>
'''read-syntax:''' @[RECEIVER KEYWORD ARGUMENT ...]

<record>objc:instance</record>
'''record:''' objc:instance

<signature type="string">doctype:xhtml-1.0-strict</signature>
'''string:''' doctype:xhtml-1.0-strict

This is so that symbols/variables other than procedures and macros
can be automatically indexed.  Compare @deffn / @defmac / @defspec
/ @defvr / @defvar in Texinfo, which serve a similar purpose.
In other words, these tags are 'definition commands'.