Adds doxygen for watch and sharable_watch

Change-Id: I4f446c9a1db6b8bbe263529dce204d3f6321e965
Signed-off-by: Inkyun Kil <inkyun.kil@samsung.com>

diff --git a/watch-holder/api/sharable_watch.h b/watch-holder/api/sharable_watch.h
index 1f7fb6a..4046644 100644 (file)
--- a/watch-holder/api/sharable_watch.h
+++ b/watch-holder/api/sharable_watch.h
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef __SHARABLE_WATCH_H__
-#define __SHARABLE_WATCH_H__
+#ifndef __TIZEN_WIDGET_VIEWER_SHARABLE_WATCH_H__
+#define __TIZEN_WIDGET_VIEWER_SHARABLE_WATCH_H__
 
 #include <Evas.h>
 #include <bundle.h>
@@ -26,26 +26,104 @@
 extern "C" {
 #endif
 
+/**
+ * @brief The sharable watch handle.
+ * @remarks This handle only for internal applications.
+ */
 typedef struct sharable_watch_s *sharable_watch_h;
 
+/**
+ * @brief Resumes the sharable watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @see sharable_watch_pause()
+ */
 int sharable_watch_resume(sharable_watch_h watch);
 
+/**
+ * @brief Pauses the sharable watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @see sharable_watch_resume()
+ */
 int sharable_watch_pause(sharable_watch_h watch);
 
+/**
+ * @brief Gets the application id of the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @param[out] appid The application id
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WATCH_HOLDER_OUT_OF_MEMORY Out of memory
+ */
 int sharable_watch_get_appid(sharable_watch_h watch, char **appid);
 
+/**
+ * @brief Gets the process id of the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @param[out] pid The process id
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int sharable_watch_get_pid(sharable_watch_h watch, int *pid);
 
+/**
+ * @brief Gets the extra bundle data received from holder.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @param[out] extra The extra bundle data
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int sharable_watch_get_extra(sharable_watch_h watch, bundle **extra);
 
+/**
+ * @brief Gets the current image of the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @param[out] image The Evas Object
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WATCH_HOLDER_ERROR_INVALID_OPERATION Invalid operation
+ */
 int sharable_watch_get_current_image(sharable_watch_h watch, Evas_Object **image);
 
+/**
+ * @brief Checks whether the watch is bound or not.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @param[out] bound Whether the watch is bound or not
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int sharable_watch_is_bound(sharable_watch_h watch, bool *bound);
 
+/**
+ * @brief Checks whether the watch is faulted or not.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The sharable watch handle
+ * @param[out] faulted Whether the watch is faulted or not
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int sharable_watch_is_faulted(sharable_watch_h watch, bool *faulted);
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
+#endif /* __TIZEN_WIDGET_VIEWER_WATCH_HOLDER_H__ */

diff --git a/watch-holder/api/watch.cc b/watch-holder/api/watch.cc
index 4a7f85a..1883c28 100644 (file)
--- a/watch-holder/api/watch.cc
+++ b/watch-holder/api/watch.cc
@@ -63,12 +63,18 @@ C_EXPORT int watch_bind(watch_h watch, Evas_Object *win) {
 
 C_EXPORT int watch_unbind(watch_h watch) {
   Watch* w = reinterpret_cast<Watch*>(watch);
+  if (w == nullptr)
+    return WATCH_HOLDER_ERROR_INVALID_PARAMETER;
+
   w->Unbind();
   return WATCH_HOLDER_ERROR_NONE;
 }
 
 C_EXPORT int watch_get_appid(watch_h watch, char **appid) {
   Watch* w = reinterpret_cast<Watch*>(watch);
+  if (w == nullptr)
+    return WATCH_HOLDER_ERROR_INVALID_PARAMETER;
+
   char* id = strdup(w->GetAppId().c_str());
   if (id == nullptr)
       return WATCH_HOLDER_ERROR_OUT_OF_MEMORY;

diff --git a/watch-holder/api/watch.h b/watch-holder/api/watch.h
index d840a11..e678b15 100644 (file)
--- a/watch-holder/api/watch.h
+++ b/watch-holder/api/watch.h
@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-#ifndef __WATCH_H__
-#define __WATCH_H__
+#ifndef __TIZEN_WIDGET_VIEWER_WATCH_H__
+#define __TIZEN_WIDGET_VIEWER_WATCH_H__
 
 #include <Evas.h>
 #include <bundle.h>
@@ -26,38 +26,186 @@
 extern "C" {
 #endif
 
+/**
+ * @brief The watch handle.
+ * @remarks This handle only for internal applications.
+ */
 typedef struct watch_s *watch_h;
 
+/**
+ * @brief Sends a resumed event to the display server.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @see watch_pause()
+ */
 int watch_resume(watch_h watch);
 
+/**
+ * @brief Sends a paused event to the display server.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @see watch_resume()
+ */
 int watch_pause(watch_h watch);
 
+/**
+ * @brief Terminates the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_terminate(watch_h watch);
 
+/**
+ * @brief Binds watch's window with the window.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[in] win The Evas Object
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_bind(watch_h watch, Evas_Object *win);
 
+/**
+ * @brief Unbinds watch's window.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_unbind(watch_h watch);
 
+/**
+ * @brief Notifies changed event.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WATCH_HOLDER_ERROR_IO_ERROR I/O error
+ */
 int watch_notify_changed_event(watch_h watch);
 
+/**
+ * @brief Gets the application id of the watch.
+ * @remarks This function only for internal applications.
+ * @remarks @a appid must be released using free().
+ * @param[in] watch The watch handle
+ * @param[out] appid The application id
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WATCH_HOLDER_OUT_OF_MEMORY Out of memory
+ */
 int watch_get_appid(watch_h watch, char **appid);
 
+/**
+ * @brief Gets the process id of the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] pid The process id
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_get_pid(watch_h watch, int *pid);
 
+/**
+ * @brief Gets the remote surface id of the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] rid The surface id
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_get_rid(watch_h watch, int *rid);
 
+/**
+ * @brief Gets the opr of the Evas Object
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] opr The OPR(On Pixel Ratio)
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_get_opr(watch_h watch, float *opr);
 
+/**
+ * @brief Gets the current image of the watch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] image The Evas Object
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #WATCH_HOLDER_ERROR_INVALID_OPERATION Invalid operation
+ */
 int watch_get_current_image(watch_h watch, Evas_Object **image);
 
+/**
+ * @brief Gets the extra bundle data received from holder.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] extra The extra bundle data
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_get_extra(watch_h watch, bundle **extra);
 
+/**
+ * @brief Checks whether the watch is faulted or not.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] faulted Whether the watch is faulted or not
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_is_faulted(watch_h watch, bool *faulted);
 
+/**
+ * @brief Checks whether the watch is bound or not.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[out] bound Whether the watch is bound or not
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_is_bound(watch_h watch, bool *bound);
 
+/**
+ * @brief Cancles touch.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_cancel_touch(watch_h watch);
 
+/**
+ * @brief Blocks updating surface.
+ * @remarks This function only for internal applications.
+ * @param[in] watch The watch handle
+ * @param[in] enable Whether block is true or not
+ * @return #WATCH_HOLDER_ERROR_NONE on success, otherwise a negative error value
+ * @retval #WATCH_HOLDER_ERROR_NONE Success
+ * @retval #WATCH_HOLDER_ERROR_INVALID_PARAMETER Invalid parameter
+ */
 int watch_block_update(watch_h watch, bool enable);
 
 
@@ -65,4 +213,4 @@ int watch_block_update(watch_h watch, bool enable);
 }
 #endif
 
-#endif
+#endif /* __TIZEN_WIDGET_VIEWER_WATCH_H__ */