Changeset 94034 in webkit

Timestamp:

Aug 29, 2011, 6:29:59 PM (15 years ago)

Author:

commit-queue@webkit.org

Message:

[EFL] Add missing API documentation.
​https://bugs.webkit.org/show_bug.cgi?id=66927

Patch by Grzegorz Czajkowski <​g.czajkowski@samsung.com> on 2011-08-29
Reviewed by Kent Tamura.

Adds missing documentation for ewk_context_menu_item_checked_get/set.
Moves API documentation from cpp to the headers.
Adds brief and file commands for ewk_js.h.

• ewk/ewk_contextmenu.h:
• ewk/ewk_cookies.cpp:
• ewk/ewk_cookies.h:
• ewk/ewk_frame.cpp:
• ewk/ewk_frame.h:
• ewk/ewk_js.h:

Location:

trunk/Source/WebKit/efl

Files:

• ChangeLog (modified) (1 diff)
• ewk/ewk_contextmenu.h (modified) (2 diffs)
• ewk/ewk_cookies.cpp (modified) (1 diff)
• ewk/ewk_cookies.h (modified) (1 diff)
• ewk/ewk_frame.cpp (modified) (1 diff)
• ewk/ewk_frame.h (modified) (2 diffs)
• ewk/ewk_js.h (modified) (1 diff)

trunk/Source/WebKit/efl/ChangeLog

@@ +1 @@
+2011-08-29  Grzegorz Czajkowski  <g.czajkowski@samsung.com>
+
+        [EFL] Add missing API documentation.
+        https://bugs.webkit.org/show_bug.cgi?id=66927
+
+        Reviewed by Kent Tamura.
+
+        Adds missing documentation for ewk_context_menu_item_checked_get/set.
+        Moves API documentation from cpp to the headers.
+        Adds brief and file commands for ewk_js.h.
+
+        * ewk/ewk_contextmenu.h:
+        * ewk/ewk_cookies.cpp:
+        * ewk/ewk_cookies.h:
+        * ewk/ewk_frame.cpp:
+        * ewk/ewk_frame.h:
+        * ewk/ewk_js.h:
+
 2011-08-29  Ryuan Choi  <ryuan.choi@samsung.com>
 

trunk/Source/WebKit/efl/ewk/ewk_contextmenu.h

@@ -193 +193 @@
  * @param submenu specifies a submenu of the item
  * @param title specifies a title of the item
- * @param checked
+ * @param checked @c EINA_TRUE if the item should be toggled or @c EINA_FALSE if not
  * @param enabled @c EINA_TRUE to enable the item or @c EINA_FALSE to disable
  * @return the pointer to the new item on success or @c 0 on failure
@@ -283 +283 @@
 EAPI const char                 *ewk_context_menu_item_title_set(Ewk_Context_Menu_Item *o, const char *title);
 
+/**
+ * Queries if the item is toggled.
+ *
+ * @param o the item to query if the item is toggled
+ * @return @c EINA_TRUE if the item is toggled or @c EINA_FALSE if not or on failure
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_checked_get(Ewk_Context_Menu_Item *o);
+
+/**
+ * Sets if the item should be toggled.
+ *
+ * @param o the item to be toggled
+ * @param checked @c EINA_TRUE if the item should be toggled or @c EINA_FALSE if not
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on failure
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_checked_set(Ewk_Context_Menu_Item *o, Eina_Bool checked);
 

trunk/Source/WebKit/efl/ewk/ewk_cookies.cpp

@@ -166 +166 @@
 }
 
-/**
- * Gets the acceptance policy used in the current cookie jar.
- *
- * @return the current acceptance policy
- * @see Ewk_Cookie_Policy
- */
 Ewk_Cookie_Policy ewk_cookies_policy_get(void)
 {

trunk/Source/WebKit/efl/ewk/ewk_cookies.h

@@ -123 +123 @@
  */
 EAPI void               ewk_cookies_policy_set(Ewk_Cookie_Policy p);
+
+/**
+ * Gets the acceptance policy used in the current cookie jar.
+ *
+ * @return the current acceptance policy
+ * @see Ewk_Cookie_Policy
+ */
 EAPI Ewk_Cookie_Policy  ewk_cookies_policy_get(void);
 

trunk/Source/WebKit/efl/ewk/ewk_frame.cpp

@@ -495 +495 @@
 }
 
-/**
- * Sets whether matches marked with ewk_frame_text_matches_mark() should be highlighted.
- *
- * @param o frame object where to set if matches are highlighted or not
- * @param highlight @c EINA_TRUE if matches are highlighted, @c EINA_FALSE if not
- *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
- */
 Eina_Bool ewk_frame_text_matches_highlight_set(Evas_Object *o, Eina_Bool highlight)
 {

trunk/Source/WebKit/efl/ewk/ewk_frame.h

@@ -382 +382 @@
  */
 EAPI unsigned int ewk_frame_text_matches_mark(Evas_Object *o, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
-EAPI Eina_Bool    ewk_frame_text_matches_unmark_all(Evas_Object *o);
 
 /**
@@ -389 +388 @@
  *
  * @param o frame object where to unmark matches
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
+ */
+EAPI Eina_Bool    ewk_frame_text_matches_unmark_all(Evas_Object *o);
+
+/**
+ * Sets whether matches marked with ewk_frame_text_matches_mark() should be highlighted.
+ *
+ * @param o frame object where to set if matches are highlighted or not
+ * @param highlight @c EINA_TRUE if matches are highlighted, @c EINA_FALSE if not
  *
  * @return @c EINA_TRUE on success, @c EINA_FALSE on failure

trunk/Source/WebKit/efl/ewk/ewk_js.h

@@ -17 +17 @@
     Boston, MA 02110-1301, USA.
 */
+
+/**
+ * @file    ewk_js.h
+ * @brief   Allows to export objects to JavaScript API.
+ */
 
 #ifndef ewk_js_h