patchset/0018-Add-documentation-to-xwalk-view-public-API.patch

   1 From e38a6704ca9553ce21dec90254bac85d8b648bf3 Mon Sep 17 00:00:00 2001
   2 From: Alexander Shalamov <alexander.shalamov@intel.com>
   3 Date: Tue, 6 Aug 2013 10:53:08 +0300
   4 Subject: [PATCH 18/33] Add documentation to xwalk view public API
   5
   6 ---
   7  efl_webview/public/xwalk_view.h | 49 ++++++++++++++++++++++++++++++++++++++++-
   8  1 file changed, 48 insertions(+), 1 deletion(-)
   9
  10 diff --git a/efl_webview/public/xwalk_view.h b/efl_webview/public/xwalk_view.h
  11 index 1e9077d..680a5ab 100644
  12 --- a/efl_webview/public/xwalk_view.h
  13 +++ b/efl_webview/public/xwalk_view.h
  14 @@ -21,16 +21,63 @@
  15  extern "C" {
  16  #endif
  17
  18 -EAPI Evas_Object *xwalk_view_add(Evas *canvas);
  19 +/**
  20 + * Creates a new EFL xwalk view object.
  21 + *
  22 + * @param evas canvas object where xwalk view should be created
  23 + *
  24 + * @return view object on success or @c NULL on failure
  25 + */
  26 +EAPI Evas_Object *xwalk_view_add(Evas *evas);
  27
  28 +/**
  29 + * Asks xwalk view to load given URL.
  30 + *
  31 + * @param obj xwalk view object to load @a URL
  32 + * @param url uniform resource identifier to be loaded
  33 + *
  34 + * @return @c EINA_TRUE is returned if @a obj is valid, irrespective of load,
  35 + *         or @c EINA_FALSE on failure
  36 + */
  37  EAPI Eina_Bool xwalk_view_url_set(Evas_Object *obj, const char *url);
  38
  39 +/**
  40 + * Returns current URL string of xwalk view object.
  41 + *
  42 + * It returns an internal string that should not
  43 + * be modified. The string is guaranteed to be stringshared.
  44 + *
  45 + * @param obj xwalk view object to get current URL
  46 + *
  47 + * @return current URL on success or @c NULL on failure
  48 + */
  49  EAPI const char *xwalk_view_url_get(const Evas_Object *obj);
  50
  51 +/**
  52 + * Asks xwalk view to reload current document.
  53 + *
  54 + * @param obj xwalk view object to reload current document
  55 + *
  56 + * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise
  57 + */
  58  EAPI Eina_Bool xwalk_view_reload(Evas_Object *obj);
  59
  60 +/**
  61 + * Asks xwalk view to navigate back in the history.
  62 + *
  63 + * @param obj xwalk view object to navigate back
  64 + *
  65 + * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise
  66 + */
  67  EAPI Eina_Bool xwalk_view_back(Evas_Object *obj);
  68
  69 +/**
  70 + * Asks xwalk view to navigate forward in the history.
  71 + *
  72 + * @param obj xwalk view object to navigate forward
  73 + *
  74 + * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise
  75 + */
  76  EAPI Eina_Bool xwalk_view_forward(Evas_Object *obj);
  77
  78  #ifdef __cplusplus
  79 --
  80 1.8.1.2
  81