Public SourceMage Discussion List

[Paul <dufflebunk AT dufflebunk.homeip.net>]

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
> _______________________________________________
> SM-Discuss mailing list
> SM-Discuss AT lists.ibiblio.org
> http://lists.ibiblio.org/mailman/listinfo/sm-discuss
-- 
De mortuis nihil nisi bonum.

Attachment: signature.asc
Description: This is a digitally signed message part