[
https://issues.apache.org/jira/browse/STRATOS-987?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14493232#comment-14493232
]
Chamila de Alwis commented on STRATOS-987:
------------------------------------------
Fixed in commit d42e63efb600e4cdfcd6d9f3d7491534ed083242. The status codes that
are returned from the method are mentioned in the @return doc tag.
> Add meaningful paragraph type code comments
> -------------------------------------------
>
> Key: STRATOS-987
> URL: https://issues.apache.org/jira/browse/STRATOS-987
> Project: Stratos
> Issue Type: Sub-task
> Components: REST API
> Affects Versions: 4.1.0 M4
> Reporter: Mariangela Hills
> Priority: Minor
> Fix For: 4.1.0
>
>
> It is good if meaningful descriptions are added as code comments for all the
> methods in REST API, so that it will help a user to get a better
> understanding of the various methods. Currently, only the following paragraph
> type code comment has been added:
> /**
> * This method gets called by the client who are interested in using
> session mechanism to authenticate
> * themselves in subsequent calls. This method call get authenticated by
> the basic authenticator.
> * Once the authenticated call received, the method creates a session and
> returns the session id.
> *
> * @return
> */
>
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
