AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

@param doc tags in asdoc don't work the same as in Java. If you supply a @param for only one

Browse Source 
paremeter, it assumes you're supplying the description for the first parameter, even if you 
supply the name of the parameter you're describing.  This basically means that docs for functions
need to supply @params for all parameters or none.


git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@525 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
Nathan Curtis
2007-12-12 19:55:31 +00:00
parent 35b7e33984
commit 7f1ee2e1f4
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/as/com/threerings/ezgame/EZGameControl.as
+3 -1
View File
@@ -428,7 +428,7 @@ public class EZGameControl extends BaseControl
/** /**
* Checks to see if the dictionary for the given locale contains the given word. * Checks to see if the dictionary for the given locale contains the given word.
* *
* @param RFC 3066 string that represents language settings * @param locale RFC 3066 string that represents language settings
* @param dictionary the dictionary to use, or null for the default. * @param dictionary the dictionary to use, or null for the default.
* TODO: document possible parameters. * TODO: document possible parameters.
* @param word the string contains the word to be checked * @param word the string contains the word to be checked
@@ -448,6 +448,8 @@ public class EZGameControl extends BaseControl
* property, except that the value will not be saved- it will merely end up coming out as a * property, except that the value will not be saved- it will merely end up coming out as a
* MessageReceivedEvent. * MessageReceivedEvent.
* *
* @param messageName The message to send.
* @param value The value to attach to the message.
* @param playerId if 0 (or unset), sends to all players, otherwise the message will be private * @param playerId if 0 (or unset), sends to all players, otherwise the message will be private
* to just one player * to just one player
*/ */