Changeset 6044 for DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/AutheticationResource.java

Timestamp:

02/24/15 18:53:22 (9 years ago)

Author:

olhsha@mpi.nl

Message:

Revising javadoc is completed

File:

• DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/AutheticationResource.java (modified) (3 diffs)

DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/src/main/java/eu/dasish/annotation/backend/rest/AutheticationResource.java

@@ -35 +35 @@
 
 /**
- * REST class for GETting a logged in principal, log-in and log-out;
- * Every REST method in the case of successful completion of its action outputs the declared output type
+ * A REST class for GETting a logged in principal, log-in and log-out.
+ * Every REST method in the case of successful completion produces the object of the declared output type
  * (a JAXB-element or a message string) or sends a HTTP-error with the corresponding diagnostics otherwise.
  * @author olhsha
@@ -47 +47 @@
     /**
      * 
-     * @return the {@link Principal} object representing the current logged-on principal.
-     * @throws IOException if sending the error fails.
+     * @return the {@link Principal} object representing the current logged-in principal.
+     * @throws IOException if sending an error fails.
      */
     @GET
@@ -84 +84 @@
     /**
      * 
-     * @throws IOException if sending redirect fails.
+     * @throws IOException if sending the redirect to logout page fails.
      */
     @GET