| Re: [aj@xxxxxxxxxx: RE: [AD] [AL] docs, return values?] |
[ Thread Index |
Date Index
| More lists.liballeg.org/allegro-developers Archives
]
On Thu, Nov 07, 2002 at 11:37:58AM +1100, Peter Wang wrote:
> > > ><retval>blah blah</retval>
> > > >
> > > > which would translate nicely into the standard format for
> > > > any given output. eg man pages traditionally have a separate
> > > > section for return values.
>
> I'd be glad to see someone do this, and update allegro._tx, but
> I don't think that's the right syntax for makedoc. It should
> probably be line-based. Maybe like this:
>
> @retval
> blah blah
> @!retval
>
> Wait for a response from Grzegorz :-)
That's ok, quite easy to add. The opening command would create the
apropiate man section, html output could use the close command
to finish yet another css trick. The big problem is the current
documentation, many texts don't fit nicely with this "return"
block at the end and will have to be rewritten.