You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@stratos.apache.org by "Dinithi De SIlva (JIRA)" <ji...@apache.org> on 2015/05/14 10:48:00 UTC
[jira] [Updated] (STRATOS-987) Add meaningful paragraph type code
comments
[ https://issues.apache.org/jira/browse/STRATOS-987?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dinithi De SIlva updated STRATOS-987:
-------------------------------------
Fix Version/s: 4.1.0 RC1
> 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 Beta2, 4.1.0 RC1
>
>
> 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)