Public SourceMage Discussion List

["Eric D. Schabell M.Sc." <eschabell AT sourcemage.org>]

Sounds good to me... I would also like to add the listed @'s below to the 
bashdoc spell so gaze what bashdoc would list something like that for our 
helpers. Right now it just dumps the --help stuff.

erics

On Friday 27 February 2004 05:30, David Kowis wrote:
> So, are we going to have a standard of some sort, so that we don't have
> @wanker tags and such?
> Just so that people like me, or new coders know what to do and don't have
> to wing-it?
> Probably what you've suggested are perfectly fine
>
> So unless someone has complaints/suggestions I'll set up a bashdoc wiki
> page tomorrow
> I'll add more junk to it as I continue in this endeavor
> David Kowis
>
> -----Original Message-----
> From: sm-discuss-bounces AT lists.ibiblio.org
> [mailto:sm-discuss-bounces AT lists.ibiblio.org] On Behalf Of Paul
> Sent: Thursday, February 26, 2004 5:48 PM
> To: sm-discuss
> Subject: Re: [SM-Discuss] Bashdoc
>
>
> Hmm? Wha?
> Oh, any can be used, @param is the only one treated specialy.
>
> The specific set of tags to use is an smgl specific issue, and should
> not be documented in bashdoc. Most of the tags I mentioned above are
> actualy used in the bashdoc source.
>
> I would suggest the following:
> @param: when order is important
> @Arguments: when order is unimportant
> @Stdout: what is dumped to stdout by this function
> @Stderr: whe is dumped to stderr
> @Stdin: what is expected from stdin
> @return: what the return values mean
> @Globals: global variables used
>
> Some others are that are used:
> @Type API: if it's an API function
> @Synopsis
> @Copyright
> @License
>
> Keep in mind that
> <@function some_function> will make a link to the function in the docs.
> I blieve the function is limited to being in the same file. I can't
> recall at the moment.
>
> Any funny symbols will not be translated for you, so putting <something>
> in the comments would be a no-no.
>
> On Thu, 2004-02-26 at 16:36, Eric D. Schabell M.Sc. wrote:
> > On Thursday 26 February 2004 21:57, David Kowis wrote:
> > > By looking through the bashdoc.sh script, I've determined that any
> > > @<something> can be a tag. Are there any specific tags we should (not)
> > > use?
> >
> > I think the easiest is to look at existing libs... the only documentation
>
> is
>
> > at the top of bashdoc. The author will most likely be able to help,
> > dufflebunk!
> >
> > erics
> > _