Skip to content

Commit 7c7b079

Browse files
author
Caitlin Bales (MSFT)
committed
Method to generate JavaDoc for action parameters
1 parent 7942a87 commit 7c7b079

File tree

5 files changed

+13
-4
lines changed

5 files changed

+13
-4
lines changed

Templates/Java/BaseJavaModel.template.tt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,15 @@
386386
}
387387
return "Void";
388388
}
389+
390+
public string MethodParametersJavadocSignature(OdcmMethod method) {
391+
var parameterSignatureBuilder = new StringBuilder();
392+
foreach (var p in method.Parameters)
393+
{
394+
parameterSignatureBuilder.AppendFormat("\r\n * @param {0} The {0}", ParamName(p));
395+
}
396+
return parameterSignatureBuilder.ToString();
397+
}
389398

390399
public string MethodParametersSignature(OdcmMethod method) {
391400
var parameterSignatureBuilder = new StringBuilder();

Templates/Java/requests_extensions/MethodCollectionRequestBuilder.java.tt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* @param requestUrl The request url
1616
* @param client The service client
17-
* @param requestOptions The options for this request
17+
* @param requestOptions The options for this request<#=MethodParametersJavadocSignature(method)#>
1818
*/
1919
public <#=TypeCollectionRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final java.util.List<? extends Option> requestOptions<#=MethodParametersSignature(method)#>) {
2020
super(requestUrl, client, requestOptions<#=MethodParametersValues(method)#>);

Templates/Java/requests_extensions/MethodRequestBuilder.java.tt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* @param requestUrl The request url
1616
* @param client The service client
17-
* @param requestOptions The options for this request
17+
* @param requestOptions The options for this request<#=MethodParametersJavadocSignature(method)#>
1818
*/
1919
public <#=TypeRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final java.util.List<? extends Option> requestOptions<#=MethodParametersSignature(method)#>) {
2020
super(requestUrl, client, requestOptions<#=MethodParametersValues(method)#>);

Templates/Java/requests_generated/BaseMethodCollectionRequestBuilder.java.tt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* @param requestUrl The request url
1616
* @param client The service client
17-
* @param requestOptions The options for this request
17+
* @param requestOptions The options for this request<#=MethodParametersJavadocSignature(method)#>
1818
*/
1919
public <#=BaseTypeCollectionRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final java.util.List<? extends Option> requestOptions<#=MethodParametersSignature(method)#>) {
2020
super(requestUrl, client, requestOptions);

Templates/Java/requests_generated/BaseMethodRequestBuilder.java.tt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* @param requestUrl The request url
1616
* @param client The service client
17-
* @param requestOptions The options for this request
17+
* @param requestOptions The options for this request<#=MethodParametersJavadocSignature(method)#>
1818
*/
1919
public <#=BaseTypeRequestBuilder(c)#>(final String requestUrl, final <#=IBaseClientType()#> client, final java.util.List<? extends Option> requestOptions<#=MethodParametersSignature(method)#>) {
2020
super(requestUrl, client, requestOptions);

0 commit comments

Comments
 (0)