Yeah, I sort of liked the look of that one too. It's pretty quick to find all of the information you need about an argument (optional/required, restrictions, default value, etc.).
Some of the functions/arguments that are really multiple functions hiding under the same name might be handled with multiple diagrams/lists for each of the variations. arg(), date(), and time() are 3 that suffer from that sort of problem. The first argument determines the meaning/validity of the rest of the arguments. Rick On Sun, Aug 24, 2008 at 2:01 PM, Mark Miesfeld <[EMAIL PROTECTED]> wrote: > On Sun, Aug 24, 2008 at 10:45 AM, Rick McGuire <[EMAIL PROTECTED]> wrote: >> I did a little nosing around to see how some other languages that I >> know allow optional arguments ... while >> javascript does not mark arguments as optional, but uses a javadoc >> style of where each of the arguments is in a list and the description >> indicates whether the argument is optional or required >> (http://www.w3schools.com/jsref/jsref_substr.asp). > > I like this javascript look. Marking in the table whether each arg is > required or optional is easy to follow. It is very black and white, > for each arg make the first word Required or Optional. > > I'm mostly coming from my experience with the ooDialog docs where > there is a lot of inconsistency between the doc for one method and the > next. For myself, I've found constructing a table in the SGML files > to be a lot easier than constructing the variablelist. The javascript > args look like they are presented in a table. > > I think the syntax line itself is easier to read when it does not have > the square brackets in it. Especially in our doc where so many args > are optional. > > -- > Mark Miesfeld > > ------------------------------------------------------------------------- > This SF.Net email is sponsored by the Moblin Your Move Developer's challenge > Build the coolest Linux based applications with Moblin SDK & win great prizes > Grand prize is a trip for two to an Open Source event anywhere in the world > http://moblin-contest.org/redirect.php?banner_id=100&url=/ > _______________________________________________ > Oorexx-devel mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/oorexx-devel > ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ Oorexx-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/oorexx-devel
