Diff
Modified: trunk/Source/WebKit/efl/ChangeLog (94033 => 94034)
--- trunk/Source/WebKit/efl/ChangeLog 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ChangeLog 2011-08-30 01:29:59 UTC (rev 94034)
@@ -1,3 +1,21 @@
+2011-08-29 Grzegorz Czajkowski <[email protected]>
+
+ [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 <[email protected]>
REGRESSION(r93637) Build break because header file is missing.
Modified: trunk/Source/WebKit/efl/ewk/ewk_contextmenu.h (94033 => 94034)
--- trunk/Source/WebKit/efl/ewk/ewk_contextmenu.h 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ewk/ewk_contextmenu.h 2011-08-30 01:29:59 UTC (rev 94034)
@@ -192,7 +192,7 @@
* @param action specifies a action of the item
* @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
*
@@ -282,7 +282,21 @@
*/
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);
/**
Modified: trunk/Source/WebKit/efl/ewk/ewk_cookies.cpp (94033 => 94034)
--- trunk/Source/WebKit/efl/ewk/ewk_cookies.cpp 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ewk/ewk_cookies.cpp 2011-08-30 01:29:59 UTC (rev 94034)
@@ -165,12 +165,6 @@
#endif
}
-/**
- * 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)
{
Ewk_Cookie_Policy ewk_policy = EWK_COOKIE_JAR_ACCEPT_ALWAYS;
Modified: trunk/Source/WebKit/efl/ewk/ewk_cookies.h (94033 => 94034)
--- trunk/Source/WebKit/efl/ewk/ewk_cookies.h 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ewk/ewk_cookies.h 2011-08-30 01:29:59 UTC (rev 94034)
@@ -122,6 +122,13 @@
* @see Ewk_Cookie_Policy
*/
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);
#ifdef __cplusplus
Modified: trunk/Source/WebKit/efl/ewk/ewk_frame.cpp (94033 => 94034)
--- trunk/Source/WebKit/efl/ewk/ewk_frame.cpp 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ewk/ewk_frame.cpp 2011-08-30 01:29:59 UTC (rev 94034)
@@ -494,14 +494,6 @@
return EINA_TRUE;
}
-/**
- * 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)
{
EWK_FRAME_SD_GET_OR_RETURN(o, sd, EINA_FALSE);
Modified: trunk/Source/WebKit/efl/ewk/ewk_frame.h (94033 => 94034)
--- trunk/Source/WebKit/efl/ewk/ewk_frame.h 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ewk/ewk_frame.h 2011-08-30 01:29:59 UTC (rev 94034)
@@ -381,7 +381,6 @@
* @return number of matched @a string
*/
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);
/**
* Unmarks all marked matches in a document.
@@ -391,6 +390,16 @@
*
* @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
+ */
EAPI Eina_Bool ewk_frame_text_matches_highlight_set(Evas_Object *o, Eina_Bool highlight);
/**
Modified: trunk/Source/WebKit/efl/ewk/ewk_js.h (94033 => 94034)
--- trunk/Source/WebKit/efl/ewk/ewk_js.h 2011-08-29 23:47:23 UTC (rev 94033)
+++ trunk/Source/WebKit/efl/ewk/ewk_js.h 2011-08-30 01:29:59 UTC (rev 94034)
@@ -17,6 +17,11 @@
Boston, MA 02110-1301, USA.
*/
+/**
+ * @file ewk_js.h
+ * @brief Allows to export objects to _javascript_ API.
+ */
+
#ifndef ewk_js_h
#define ewk_js_h
