You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openmeetings.apache.org by so...@apache.org on 2017/12/07 12:40:17 UTC
openmeetings git commit: [OPENMEETINGS-1777] javadocs are fixed
Repository: openmeetings
Updated Branches:
refs/heads/master 0cb0d848f -> b332f937a
[OPENMEETINGS-1777] javadocs are fixed
Project: http://git-wip-us.apache.org/repos/asf/openmeetings/repo
Commit: http://git-wip-us.apache.org/repos/asf/openmeetings/commit/b332f937
Tree: http://git-wip-us.apache.org/repos/asf/openmeetings/tree/b332f937
Diff: http://git-wip-us.apache.org/repos/asf/openmeetings/diff/b332f937
Branch: refs/heads/master
Commit: b332f937a18c4a82443d3500b6e1513125308f56
Parents: 0cb0d84
Author: Maxim Solodovnik <so...@gmail.com>
Authored: Thu Dec 7 19:40:08 2017 +0700
Committer: Maxim Solodovnik <so...@gmail.com>
Committed: Thu Dec 7 19:40:08 2017 +0700
----------------------------------------------------------------------
.../openmeetings/webservice/CalendarWebService.java | 15 ++++-----------
.../openmeetings/webservice/FileWebService.java | 6 ++++--
.../openmeetings/webservice/GroupWebService.java | 11 +++++------
.../openmeetings/webservice/RecordingWebService.java | 2 +-
.../openmeetings/webservice/RoomWebService.java | 1 +
5 files changed, 15 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/b332f937/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
----------------------------------------------------------------------
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
index 9bcfbac..1703043 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/CalendarWebService.java
@@ -82,7 +82,6 @@ public class CalendarWebService extends BaseWebService {
* end time
*
* @return - list of appointments in range
- * @throws {@link ServiceException} in case of any error
*/
@GET
@Path("/{start}/{end}")
@@ -111,7 +110,6 @@ public class CalendarWebService extends BaseWebService {
* end time
*
* @return - list of appointments in range
- * @throws {@link ServiceException} in case of any error
*/
@GET
@Path("/{userid}/{start}/{end}")
@@ -135,7 +133,6 @@ public class CalendarWebService extends BaseWebService {
* @param sid
* The SID of the User. This SID must be marked as Loggedin
* @return - next Calendar event
- * @throws {@link ServiceException} in case of any error
*/
@GET
@Path("/next")
@@ -155,7 +152,6 @@ public class CalendarWebService extends BaseWebService {
* the userId the calendar events should be loaded
*
* @return - next Calendar event
- * @throws {@link ServiceException} in case of any error
*/
@GET
@Path("/next/{userid}")
@@ -171,9 +167,10 @@ public class CalendarWebService extends BaseWebService {
* Load a calendar event by its room id
*
* @param sid
+ * The SID of the User. This SID must be marked as Loggedin
* @param roomid
+ * id of appointment special room
* @return - calendar event by its room id
- * @throws {@link ServiceException} in case of any error
*/
@GET
@Path("/room/{roomid}")
@@ -193,7 +190,6 @@ public class CalendarWebService extends BaseWebService {
* the search string
*
* @return - calendar event list
- * @throws {@link ServiceException} in case of any error
*/
@GET
@Path("/title/{title}")
@@ -210,7 +206,6 @@ public class CalendarWebService extends BaseWebService {
* calendar event
*
* @return - appointment saved
- * @throws {@link ServiceException} in case of any error
*/
@WebMethod
@POST
@@ -249,7 +244,7 @@ public class CalendarWebService extends BaseWebService {
* delete a calendar event
*
* If the given sid is from an Administrator or Web-Service user, the user
- * can delete any appointment.<br/>
+ * can delete any appointment.
* If the sid is assigned to a regular user, he can only delete appointments
* where he is also the owner/creator of the appointment
*
@@ -257,9 +252,7 @@ public class CalendarWebService extends BaseWebService {
* an authenticated SID
* @param id
* the id to delete
- * @return {@link ServiceResult} of type SUCCESS
- *
- * @throws {@link ServiceException} in case of any error
+ * @return {@link ServiceResult} with result type
*/
@DELETE
@Path("/{id}")
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/b332f937/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
----------------------------------------------------------------------
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
index e77b17f..d5e038d 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/FileWebService.java
@@ -79,7 +79,7 @@ public class FileWebService extends BaseWebService {
* The SID of the User. This SID must be marked as logged in
* @param id
* the id of the file or folder
- * @return - id of the file deleted, error code otherwise
+ * @return {@link ServiceResult} with result type
*/
@DELETE
@Path("/{id}")
@@ -111,7 +111,7 @@ public class FileWebService extends BaseWebService {
* the od of the file or folder
* @param externalType
* the externalType
- * @return - null
+ * @return {@link ServiceResult} with result type
*/
@DELETE
@Path("/{externaltype}/{externalid}")
@@ -275,6 +275,8 @@ public class FileWebService extends BaseWebService {
* SID The SID of the User. This SID must be marked as logged in
* @param id
* current file or folder id to be moved
+ * @param roomId
+ * room this file need to be moved
* @param parentId
* new parent folder id
* @return - resulting file object
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/b332f937/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
----------------------------------------------------------------------
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
index 7224854..e7a7a03 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/GroupWebService.java
@@ -83,7 +83,7 @@ public class GroupWebService extends BaseWebService {
* The SID from getSession
* @param name
* the name of the group
- * @return the new id of the group or -1 in case an error happened
+ * @return {@link ServiceResult} with result type, and id of the group added
*/
@POST
@Path("/")
@@ -119,7 +119,7 @@ public class GroupWebService extends BaseWebService {
* the user id
* @param id
* the group id
- * @return - id of the user added, or error id in case of the error
+ * @return {@link ServiceResult} with result type, and id of the user added, or error id in case of the error as text
*/
@POST
@Path("/{id}/users/{userid}")
@@ -150,7 +150,7 @@ public class GroupWebService extends BaseWebService {
* the user id
* @param id
* the group id
- * @return - id of the user added, or error id in case of the error
+ * @return {@link ServiceResult} with result type, and id of the user added, or error id in case of the error as text
*/
@DELETE
@Path("/{id}/users/{userid}")
@@ -183,7 +183,7 @@ public class GroupWebService extends BaseWebService {
* @param id - Id of group that the room is being paired with
* @param roomid - Id of room to be added
*
- * @return Id of the relation created, null or -1 in case of the error
+ * @return {@link ServiceResult} with result type
*/
@POST
@Path("/{id}/rooms/add/{roomId}")
@@ -265,8 +265,7 @@ public class GroupWebService extends BaseWebService {
* The SID of the User. This SID must be marked as Loggedin
* @param id
* the id of the group
- *
- * @throws {@link ServiceException} in case of any error
+ * @return {@link ServiceResult} with result type
*/
@WebMethod
@DELETE
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/b332f937/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
----------------------------------------------------------------------
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
index 74f1dfe..d429143 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RecordingWebService.java
@@ -70,7 +70,7 @@ public class RecordingWebService extends BaseWebService {
* @param id
* the id of the recording
*
- * @throws {@link ServiceException} in case of any error
+ * @return {@link ServiceResult} with result type
*/
@DELETE
@Path("/{id}")
http://git-wip-us.apache.org/repos/asf/openmeetings/blob/b332f937/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
----------------------------------------------------------------------
diff --git a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
index 898cfb8..dbbcbfc 100644
--- a/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
+++ b/openmeetings-webservice/src/main/java/org/apache/openmeetings/webservice/RoomWebService.java
@@ -84,6 +84,7 @@ public class RoomWebService extends BaseWebService {
* @param sid
* The SID of the User. This SID must be marked as Loggedin
* @param type
+ * Type of public rooms need to be retrieved
* @return - list of public rooms
*/
@WebMethod