You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by se...@apache.org on 2011/12/18 13:00:34 UTC
svn commit: r1220371 [1/4] - in
/incubator/openmeetings/trunk/singlewebapp/docs: ApiMethodsTemplate.vm
FileService.html RoomService.html UserService.html
Author: sebawagner
Date: Sun Dec 18 12:00:34 2011
New Revision: 1220371
URL: http://svn.apache.org/viewvc?rev=1220371&view=rev
Log:
Sync r4720 trunk to new svn
Modified:
incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm
incubator/openmeetings/trunk/singlewebapp/docs/FileService.html
incubator/openmeetings/trunk/singlewebapp/docs/RoomService.html
incubator/openmeetings/trunk/singlewebapp/docs/UserService.html
Modified: incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm
URL: http://svn.apache.org/viewvc/incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm?rev=1220371&r1=1220370&r2=1220371&view=diff
==============================================================================
--- incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm (original)
+++ incubator/openmeetings/trunk/singlewebapp/docs/ApiMethodsTemplate.vm Sun Dec 18 12:00:34 2011
@@ -85,32 +85,42 @@ limitations under the License.
Return Type: $method.returnType()
</p>
<p>Params:</p>
- <table rules="all" border="1">
- <thead>
- <tr>
- <th width="200" align="left">Type</th>
- <th width="200" align="left">Fieldname</th>
- <th width="400" align="left">Description</th>
- </tr>
- </thead>
- <tbody>
- #set ($index = 0)
- #foreach ( $parameter in $method.paramTags() )
- <tr>
- <td valign="top">
- #if ($method.parameters().size() > $index)
- $index Doclet Param Mismatch: fix JavaDocs in this Method!
- #end
- $method.parameters().get($index).type().simpleTypeName()
- </td>
- <td valign="top">$parameter.parameterName()</td>
- <td valign="top">$parameter.parameterComment()</td>
- </tr>
-
- #set ($index = $index+1)
- #end
- </tbody>
- </table>
+ #if ( $method.paramTags().size() != $method.parameters().size() )
+ <b>Warning:</b><i> Params in this method do not seem to be correctly documentated</i>
+ <br/><br/>
+ #end
+
+ #if ($method.paramTags().size() > 0)
+ <table rules="all" border="1">
+ <thead>
+ <tr>
+ <th width="200" align="left">Type</th>
+ <th width="200" align="left">Fieldname</th>
+ <th width="400" align="left">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ #set ($index = 0)
+ #foreach ( $parameter in $method.paramTags() )
+ <tr>
+ <td valign="top">
+ #if ($method.parameters().size() <= $index)
+ $index Doclet Param Mismatch: fix JavaDocs in this Method!
+ #else
+ $method.parameters().get($index).type().simpleTypeName()
+ #end
+ </td>
+ <td valign="top">$parameter.parameterName()</td>
+ <td valign="top">$parameter.parameterComment()</td>
+ </tr>
+
+ #set ($index = $index+1)
+ #end
+ </tbody>
+ </table>
+ #else
+ <i>No Params</i>
+ #end
</div>
#end
#end