On Mar 30, 2:27 pm, FND <[email protected]> wrote:
>
> While this often isn't very readable (esp. WRT distinguishing argument
> names and descriptions), the basic structure - flag plus slots for type,
> name and description - is useful.
>
> So here's what I imagine we might end up with:
> //# !foo
> // <summary>
> //#
> //# * param <name> (<type>): <description>
> //# * returns (<type>): <description>
> //#
> //# <details>
> function foo( ... ) { ... }
> (Note: Using individual "//" and "//#" markers instead of "/* ... */"
> because that's what Cook understands.)
I think the * before arguments adds to readability and definitely
prefer the usage of : after argument names
>
> As for supported markup, I think headings, lists, italics, monospace and
> links would probably suffice for starters.
Actually I'd say that's all we would probably ever need. In any case
that is a good start and rather than spend more time guessing what we
might need, we should start using it and adapt as we go along.
> We should agree on these basics ASAP so we can start on the actual
> documentation.
Agreed. There's a critical lack of organized documentation and this is
as a good chance to address that need as we are going to get.
What can I do to help?
Saq
>
> -- F.
>
> *http://jsdoc.sourceforge.net/
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"TiddlyWikiDev" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/TiddlyWikiDev?hl=en
-~----------~----~----~----~------~----~------~--~---
