Created
January 6, 2013 15:47
-
-
Save ngandriau/4468025 to your computer and use it in GitHub Desktop.
Looking for the best way to document groovy methods with a map as parameter.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Method with a Map as parameter | |
* | |
* @param properties Map for the parameters of the method. Supported key: <br/> | |
* - param1: String, mandatory<br/> | |
* - param2: boolean. Optional(default= true)<br/> | |
* - param3: String (any value), Optional(default="Def param3")<br/> | |
* @return | |
*/ | |
def maMethod(Map properties) { | |
... | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment