Changeset 92473 – WebKit

trunk/Source/WebKit/efl/ChangeLog

-                      r92265
+                      r92473
+-08-05  Grzegorz Czajkowski  <g.czajkowski@samsung.com>
+        [EFL] Move API documentation of ewk files to the headers
+        https://bugs.webkit.org/show_bug.cgi?id=65373
+        There are two arguments for this:
+. Developers using webkit-efl from packages probably won't have the C/CPP files with them
+           and the doxygen documentation can be generated from the headers without the need
+           for the whole source files.
+. It will be consistent with structures descriptions.
+        Reviewed by Kent Tamura.
+        * ewk/ewk_auth.cpp:
+        * ewk/ewk_auth.h:
+        * ewk/ewk_contextmenu.cpp:
+        * ewk/ewk_contextmenu.h:
+        * ewk/ewk_cookies.cpp:
+        * ewk/ewk_cookies.h:
+        * ewk/ewk_frame.cpp:
+        * ewk/ewk_frame.h:
+        * ewk/ewk_history.cpp:
+        * ewk/ewk_history.h:
+        * ewk/ewk_main.cpp:
+        * ewk/ewk_main.h:
+        * ewk/ewk_network.cpp:
+        * ewk/ewk_network.h:
+        * ewk/ewk_settings.cpp:
+        * ewk/ewk_settings.h:
+        * ewk/ewk_window_features.cpp:
+        * ewk/ewk_window_features.h:
 -08-03  Pavel Feldman  <pfeldman@chromium.org>

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

-                      r91972
+                      r92473
 #endif
-/**
- * Sets callback to be called when authentication is required.
+ *
- * @param callback callback to be called.
- */
 void ewk_auth_show_dialog_callback_set(Ewk_Auth_Show_Dialog_Callback callback)
+{

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

-                      r91972
+                      r92473
 /**
+ * Sets callback to be called when authentication is required
+ * Sets callback to be called when authentication is required.
+ *
+ * @param callback callback to be called
  */
 EAPI void ewk_auth_show_dialog_callback_set(Ewk_Auth_Show_Dialog_Callback);

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

-                      r91972
+                      r92473
 };
-/**
- * Increases the reference count of the given object.
+ *
- * @param menu the context menu object to increase the reference count
- */
 void ewk_context_menu_ref(Ewk_Context_Menu *menu)
+{
 …
+}
-/**
- * Decreases the reference count of the given object, possibly freeing it.
+ *
- * When the reference count it's reached 0, the menu with all items are freed.
+ *
- * @param menu the context menu object to decrease the reference count
- */
 void ewk_context_menu_unref(Ewk_Context_Menu *menu)
+{
 …
+}
-/**
- * Destroys the context menu object.
+ *
- * @param menu the context menu object to destroy
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
+ *
- * @see ewk_context_menu_item_free
- */
 Eina_Bool ewk_context_menu_destroy(Ewk_Context_Menu *menu)
+{
 …
+}
-/**
- * Gets the list of items.
+ *
- * @param o the context menu object to get list of the items
- * @return the list of the items on success or @c 0 on failure
- */
 const Eina_List *ewk_context_menu_item_list_get(Ewk_Context_Menu *o)
+{
 …
+}
-/**
- * Creates a new item of the context menu.
+ *
- * @param type specifies a type of the item
- * @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 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
+ *
- * @note The return value @b should @b be freed after use.
- */
 Ewk_Context_Menu_Item *ewk_context_menu_item_new(Ewk_Context_Menu_Item_Type type,
         Ewk_Context_Menu_Action action, Ewk_Context_Menu *submenu,
 …
+}
-/**
- * Selects the item from the context menu object.
+ *
- * @param menu the context menu object
- * @param item the item is selected
- * @return @c EINA_TRUE on success or @c EINA_FALSE on failure
- */
 Eina_Bool ewk_context_menu_item_select(Ewk_Context_Menu *menu, Ewk_Context_Menu_Item *item)
+{
 …
+}
-/**
- * Destroys the item of the context menu object.
+ *
- * @param item the item to destroy
+ *
- * @see ewk_context_menu_destroy
- * @see ewk_context_menu_unref
- */
 void ewk_context_menu_item_free(Ewk_Context_Menu_Item *item)
+{
 …
+}
-/**
- * Gets type of the item.
+ *
- * @param o the item to get the type
- * @return type of the item on success or @c EWK_ACTION_TYPE on failure
+ *
- * @see ewk_context_menu_item_type_set
- */
 Ewk_Context_Menu_Item_Type ewk_context_menu_item_type_get(Ewk_Context_Menu_Item *o)
+{
 …
+}
-/**
- * Sets the type of item.
+ *
- * @param o the item to set the type
- * @param type a new type for the item object
- * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ *
- * @see ewk_context_menu_item_type_get
- */
 Eina_Bool ewk_context_menu_item_type_set(Ewk_Context_Menu_Item *o, Ewk_Context_Menu_Item_Type type)
+{
 …
+}
-/**
- * Gets an action of the item.
+ *
- * @param o the item to get the action
- * @return an action of the item on success or @c EWK_CONTEXT_MENU_ITEM_TAG_NO_ACTION on failure
+ *
- * @see ewk_context_menu_item_action_set
- */
 Ewk_Context_Menu_Action ewk_context_menu_item_action_get(Ewk_Context_Menu_Item *o)
+{
 …
+}
-/**
- * Sets an action of the item.
+ *
- * @param o the item to set the action
- * @param action a new action for the item object
- * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ *
- * @see ewk_context_menu_item_action_get
- */
 Eina_Bool ewk_context_menu_item_action_set(Ewk_Context_Menu_Item *o, Ewk_Context_Menu_Action action)
+{
 …
+}
-/**
- * Gets a title of the item.
+ *
- * @param o the item to get the title
- * @return a title of the item on success, or @c 0 on failure
+ *
- * @see ewk_context_menu_item_title_set
- */
 const char *ewk_context_menu_item_title_get(Ewk_Context_Menu_Item *o)
+{
 …
+}
-/**
- * Sets a title of the item.
+ *
- * @param o the item to set the title
- * @param title a new title for the item object
- * @return a new title of the item on success or @c 0 on failure
+ *
- * @see ewk_context_menu_item_title_get
- */
 const char *ewk_context_menu_item_title_set(Ewk_Context_Menu_Item *o, const char *title)
+{
 …
+}
-/**
- * Gets if the item is enabled.
+ *
- * @param o the item to get enabled state
- * @return @c EINA_TRUE if it's enabled, @c EINA_FALSE if not or on failure
+ *
- * @see ewk_context_menu_item_enabled_set
- */
 Eina_Bool ewk_context_menu_item_enabled_get(Ewk_Context_Menu_Item *o)
+{
 …
+}
-/**
- * Enables/disables the item.
+ *
- * @param o the item to enable/disable
- * @param enabled @c EINA_TRUE to enable the item or @c EINA_FALSE to disable
- * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ *
- * @see ewk_context_menu_item_enabled_get
- */
 Eina_Bool ewk_context_menu_item_enabled_set(Ewk_Context_Menu_Item *o, Eina_Bool enabled)
+{

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

-                      r91972
+                      r92473
 /************************** Exported functions ***********************/
+/**
+ * Increases the reference count of the given object.
+ *
+ * @param menu the context menu object to increase the reference count
+ */
 EAPI void                        ewk_context_menu_ref(Ewk_Context_Menu *menu);
+/**
+ * Decreases the reference count of the given object, possibly freeing it.
+ *
+ * When the reference count it's reached 0, the menu with all items are freed.
+ *
+ * @param menu the context menu object to decrease the reference count
+ */
 EAPI void                        ewk_context_menu_unref(Ewk_Context_Menu *menu);
+/**
+ * Destroys the context menu object.
+ *
+ * @param menu the context menu object to destroy
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
+ *
+ * @see ewk_context_menu_item_free
+ */
 EAPI Eina_Bool                   ewk_context_menu_destroy(Ewk_Context_Menu *menu);
+/**
+ * Gets the list of items.
+ *
+ * @param o the context menu object to get list of the items
+ * @return the list of the items on success or @c 0 on failure
+ */
 EAPI const Eina_List            *ewk_context_menu_item_list_get(Ewk_Context_Menu *o);
+/**
+ * Creates a new item of the context menu.
+ *
+ * @param type specifies a type of the item
+ * @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 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
+ *
+ * @note The return value @b should @b be freed after use.
+ */
 EAPI Ewk_Context_Menu_Item      *ewk_context_menu_item_new(Ewk_Context_Menu_Item_Type type, Ewk_Context_Menu_Action action, Ewk_Context_Menu *submenu, const char *title, Eina_Bool checked, Eina_Bool enabled);
+/**
+ * Destroys the item of the context menu object.
+ *
+ * @param item the item to destroy
+ *
+ * @see ewk_context_menu_destroy
+ * @see ewk_context_menu_unref
+ */
 EAPI void                        ewk_context_menu_item_free(Ewk_Context_Menu_Item *item);
+/**
+ * Selects the item from the context menu object.
+ *
+ * @param menu the context menu object
+ * @param item the item is selected
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on failure
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_select(Ewk_Context_Menu *menu, Ewk_Context_Menu_Item *item);
+/**
+ * Gets type of the item.
+ *
+ * @param o the item to get the type
+ * @return type of the item on success or @c EWK_ACTION_TYPE on failure
+ *
+ * @see ewk_context_menu_item_type_set
+ */
 EAPI Ewk_Context_Menu_Item_Type  ewk_context_menu_item_type_get(Ewk_Context_Menu_Item *o);
+/**
+ * Sets the type of item.
+ *
+ * @param o the item to set the type
+ * @param type a new type for the item object
+ * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ *
+ * @see ewk_context_menu_item_type_get
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_type_set(Ewk_Context_Menu_Item *o, Ewk_Context_Menu_Item_Type type);
+/**
+ * Gets an action of the item.
+ *
+ * @param o the item to get the action
+ * @return an action of the item on success or @c EWK_CONTEXT_MENU_ITEM_TAG_NO_ACTION on failure
+ *
+ * @see ewk_context_menu_item_action_set
+ */
 EAPI Ewk_Context_Menu_Action     ewk_context_menu_item_action_get(Ewk_Context_Menu_Item *o);
+/**
+ * Sets an action of the item.
+ *
+ * @param o the item to set the action
+ * @param action a new action for the item object
+ * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ *
+ * @see ewk_context_menu_item_action_get
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_action_set(Ewk_Context_Menu_Item *o, Ewk_Context_Menu_Action action);
+/**
+ * Gets a title of the item.
+ *
+ * @param o the item to get the title
+ * @return a title of the item on success, or @c 0 on failure
+ *
+ * @see ewk_context_menu_item_title_set
+ */
 EAPI const char                 *ewk_context_menu_item_title_get(Ewk_Context_Menu_Item *o);
+/**
+ * Sets a title of the item.
+ *
+ * @param o the item to set the title
+ * @param title a new title for the item object
+ * @return a new title of the item on success or @c 0 on failure
+ *
+ * @see ewk_context_menu_item_title_get
+ */
 EAPI const char                 *ewk_context_menu_item_title_set(Ewk_Context_Menu_Item *o, const char *title);
 EAPI Eina_Bool                   ewk_context_menu_item_checked_get(Ewk_Context_Menu_Item *o);
 EAPI Eina_Bool                   ewk_context_menu_item_checked_set(Ewk_Context_Menu_Item *o, Eina_Bool checked);
+/**
+ * Gets if the item is enabled.
+ *
+ * @param o the item to get enabled state
+ * @return @c EINA_TRUE if it's enabled, @c EINA_FALSE if not or on failure
+ *
+ * @see ewk_context_menu_item_enabled_set
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_enabled_get(Ewk_Context_Menu_Item *o);
+/**
+ * Enables/disables the item.
+ *
+ * @param o the item to enable/disable
+ * @param enabled @c EINA_TRUE to enable the item or @c EINA_FALSE to disable
+ * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ *
+ * @see ewk_context_menu_item_enabled_get
+ */
 EAPI Eina_Bool                   ewk_context_menu_item_enabled_set(Ewk_Context_Menu_Item *o, Eina_Bool enabled);

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

-                      r91972
+                      r92473
-/**
- * Sets the path where the cookies are going to be stored. Use @c NULL for keep
- * them just in memory.
+ *
- * @param filename path to the cookies.txt file.
+ *
- * @return @c EINA_FALSE if it wasn't possible to create the cookie jar,
- *          @c EINA_FALSE otherwise.
- */
 Eina_Bool ewk_cookies_file_set(const char *filename)
+{
 …
+}
-/**
- * Clears all the cookies from the cookie jar.
- */
 void ewk_cookies_clear(void)
+{
 …
+}
-/**
- * Returns a list of cookies in the cookie jar.
+ *
- * @return an @c Eina_List with all the cookies in the cookie jar.
- */
 Eina_List *ewk_cookies_get_all(void)
+{
 …
+}
-/**
- * Deletes a cookie from the cookie jar.
+ *
- * Note that the fields name, value, domain and path are used to match this
- * cookie in the cookie jar.
+ *
- * @param cookie an @c Ewk_Cookie that has the info relative to that cookie.
- */
 void ewk_cookies_cookie_del(Ewk_Cookie *cookie)
+{
 …
+}
-/**
- * Frees the memory used by a cookie.
+ *
- * @param cookie the Ewk_Cookie struct that will be freed.
- */
 void ewk_cookies_cookie_free(Ewk_Cookie *cookie)
+{
 …
+}
-/**
- * Sets the cookies accept policy.
+ *
- * @param p the acceptance policy
- * @see Ewk_Cookie_Policy
- */
 void ewk_cookies_policy_set(Ewk_Cookie_Policy p)
+{

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

-                      r84771
+                      r92473
 /************************** Exported functions ***********************/
+/**
+ * Sets the path where the cookies are going to be stored.
+ *
+ * @param filename path to the cookies.txt file, use @c 0 for keep
+ *        cookies just in memory.
+ *
+ * @return @c EINA_FALSE if it wasn't possible to create the cookie jar,
+ *          @c EINA_TRUE otherwise.
+ */
 EAPI Eina_Bool          ewk_cookies_file_set(const char *filename);
+/**
+ * Clears all the cookies from the cookie jar.
+ */
 EAPI void               ewk_cookies_clear(void);
+/**
+ * Returns a list of cookies in the cookie jar.
+ *
+ * @return an @c Eina_List with all the cookies in the cookie jar
+ */
 EAPI Eina_List*         ewk_cookies_get_all(void);
+/**
+ * Deletes a cookie from the cookie jar.
+ *
+ * Note that the fields name, value, domain and path are used to match this
+ * cookie in the cookie jar.
+ *
+ * @param cookie an @c Ewk_Cookie that has the info relative to that cookie
+ */
 EAPI void               ewk_cookies_cookie_del(Ewk_Cookie *cookie);
+/**
+ * Frees the memory used by a cookie.
+ *
+ * @param cookie the Ewk_Cookie struct that will be freed
+ */
 EAPI void               ewk_cookies_cookie_free(Ewk_Cookie *cookie);
+/**
+ * Sets accept policy for the cookies.
+ *
+ * @param p the acceptance policy
+ *
+ * @see Ewk_Cookie_Policy
+ */
 EAPI void               ewk_cookies_policy_set(Ewk_Cookie_Policy p);
 EAPI Ewk_Cookie_Policy  ewk_cookies_policy_get(void);

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

-                      r92039
+                      r92473
+}
-/**
- * Retrieves the ewk_view object that owns this frame.
+ *
- * @param o frame object to get view object
+ *
- * @return view object or @c 0 on failure
- */
 Evas_Object *ewk_frame_view_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Returns a new iterator over all direct children frames.
+ *
- * Keep frame object intact while iteration happens otherwise frame
- * may be destroyed while iterated.
+ *
- * Iteration results are Evas_Object*, so give eina_iterator_next() a
- * pointer to it.
+ *
- * Returned iterator should be freed by eina_iterator_free().
+ *
- * @param o frame object to create the iterator
+ *
- * @return a newly allocated iterator on sucess, or @c 0 if not possible to
- *      create the iterator
- */
 Eina_Iterator *ewk_frame_children_iterator_new(Evas_Object *o)
+{
 …
+}
-/**
- * Finds a child frame by its name, recursively.
+ *
- * For pre-defined names, returns @a o if @a name is "_self" or
- * "_current", returns @a o's parent frame if @a name is "_parent",
- * and returns the main frame if @a name is "_top". Also returns @a o
- * if it is the main frame and @a name is either "_parent" or
- * "_top". For other names, this function returns the first frame that
- * matches @a name. This function searches @a o and its descendents
- * first, then @a o's parent and its children moving up the hierarchy
- * until a match is found. If no match is found in @a o's hierarchy,
- * this function will search for a matching frame in other main frame
- * hierarchies.
+ *
- * @param o frame object to find a child frame
- * @param name child frame name
+ *
- * @return child frame of the given frame, or @c 0 if the the child wasn't found
- */
 Evas_Object *ewk_frame_child_find(Evas_Object *o, const char *name)
+{
 …
+}
-/**
- * Asks the main frame to load the given URI.
+ *
- * @param o frame object to load uri
- * @param uri uniform resource identifier to load
+ *
- * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
- */
 Eina_Bool ewk_frame_uri_set(Evas_Object *o, const char *uri)
+{
 …
+}
-/**
- * Gets the uri of this frame.
+ *
- * It returns an internal string and should not
- * be modified. The string is guaranteed to be stringshared.
+ *
- * @param o frame object to get uri
+ *
- * @return frame uri on success or @c 0 on failure
- */
 const char *ewk_frame_uri_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Gets the title of this frame.
+ *
- * It returns an internal string and should not
- * be modified. The string is guaranteed to be stringshared.
+ *
- * @param o frame object to get title
+ *
- * @return frame title on success or @c 0 on failure
- */
 const char *ewk_frame_title_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Gets the name of this frame.
+ *
- * It returns an internal string and should not
- * be modified. The string is guaranteed to be stringshared.
+ *
- * @param o frame object to get name
+ *
- * @return frame name on success or @c 0 on failure
- */
 const char *ewk_frame_name_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Gets last known contents size.
+ *
- * @param o frame object to get contents size
- * @param w pointer to store contents size width, may be @c 0
- * @param h pointer to store contents size height, may be @c 0
+ *
- * @return @c EINA_TRUE on success or @c EINA_FALSE on failure and
- *         @a w and @a h will be zeroed
- */
 Eina_Bool ewk_frame_contents_size_get(const Evas_Object *o, Evas_Coord *w, Evas_Coord *h)
+{
 …
+}
-/**
- * Requests loading the given contents in this frame.
+ *
- * @param o frame object to load document
- * @param contents what to load into frame
- * @param contents_size size of @a contents (in bytes),
- *        if @c 0 is given, length of @a contents is used
- * @param mime_type type of @a contents data, if @c 0 is given "text/html" is assumed
- * @param encoding encoding for @a contents data, if @c 0 is given "UTF-8" is assumed
- * @param base_uri base uri to use for relative resources, may be @c 0,
- *        if provided @b must be an absolute uri
+ *
- * @return @c EINA_TRUE on successful request, @c EINA_FALSE on errors
- */
 Eina_Bool ewk_frame_contents_set(Evas_Object *o, const char *contents, size_t contents_size, const char *mime_type, const char *encoding, const char *base_uri)
+{
 …
+}
-/**
- * Requests loading alternative contents for unreachable URI in this frame.
+ *
- * This is similar to ewk_frame_contents_set(), but is used when some
- * URI was failed to load, using the provided content instead. The main
- * difference is that back-forward navigation list is not changed.
+ *
- * @param o frame object to load alternative content
- * @param contents what to load into frame, must @b not be @c 0
- * @param contents_size size of @a contents (in bytes),
- *        if @c 0 is given, length of @a contents is used
- * @param mime_type type of @a contents data, if @c 0 is given "text/html" is assumed
- * @param encoding encoding used for @a contents data, if @c 0 is given "UTF-8" is assumed
- * @param base_uri base URI to use for relative resources, may be @c 0,
- *        if provided must be an absolute uri
- * @param unreachable_uri the URI that failed to load and is getting the
- *        alternative representation
+ *
- * @return @c EINA_TRUE on successful request, @c EINA_FALSE on errors
- */
 Eina_Bool ewk_frame_contents_alternate_set(Evas_Object *o, const char *contents, size_t contents_size, const char *mime_type, const char *encoding, const char *base_uri, const char *unreachable_uri)
+{
 …
+}
-/**
- * Requests execution of the given script.
+ *
- * @param o frame object to execute script
- * @param script Java Script to execute
+ *
- * @return @c EINA_TRUE if request was done, @c EINA_FALSE on errors
- */
 Eina_Bool ewk_frame_script_execute(Evas_Object *o, const char *script)
+{
 …
+}
-/**
- * Queries if the frame is editable.
+ *
- * @param o the frame object to query editable state
+ *
- * @return @c EINA_TRUE if the frame is editable, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_editable_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Sets editable state for frame.
+ *
- * @param o the frame object to set editable state
- * @param editable a new state to set
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_editable_set(Evas_Object *o, Eina_Bool editable)
+{
 …
+}
-/**
- * Gets the copy of the selected text.
+ *
- * The returned string @b should be freed after use.
+ *
- * @param o the frame object to get selected text
+ *
- * @return a newly allocated string or @c 0 if nothing is selected or on failure
- */
 char *ewk_frame_selection_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Searches the given string in a document.
+ *
- * @param o frame object where to search the text
- * @param string reference string to search
- * @param case_sensitive if search should be case sensitive or not
- * @param forward if search is from cursor and on or backwards
- * @param wrap if search should wrap at the end
+ *
- * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not or failure
- */
 Eina_Bool ewk_frame_text_search(const Evas_Object *o, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap)
+{
 …
+}
-/**
- * Marks matches the given string in a document.
+ *
- * @param o frame object where to search text
- * @param string reference string to match
- * @param case_sensitive if match should be case sensitive or not
- * @param highlight if matches should be highlighted
- * @param limit maximum amount of matches, or zero to unlimited
+ *
- * @return number of matched @a string
- */
 unsigned int ewk_frame_text_matches_mark(Evas_Object *o, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit)
+{
 …
+}
-/**
- * Unmarks all marked matches in a document.
- * Reverses the effect of ewk_frame_text_matches_mark().
+ *
- * @param o frame object where to unmark matches
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure
- */
 Eina_Bool ewk_frame_text_matches_unmark_all(Evas_Object *o)
+{
 …
+}
-/**
- * Returns whether matches marked with ewk_frame_text_matches_mark() are highlighted.
+ *
- * @param o frame object to query if matches are highlighted or not
+ *
- * @return @c EINA_TRUE if matches are highlighted, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_text_matches_highlight_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Returns the position of the n-th matched text in the frame.
+ *
- * @param o frame object where matches are marked
- * @param n index of element
- * @param x the pointer to store the horizontal position of @a n matched text, may be @c 0
- * @param y the pointer to store the vertical position of @a n matched text, may be @c 0
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE when no matches were found or
- *         @a n is bigger than search results or on failure
- */
 Eina_Bool ewk_frame_text_matches_nth_pos_get(Evas_Object *o, size_t n, int *x, int *y)
+{
 …
+}
-/**
- * Asks frame to stop loading.
+ *
- * @param o frame object to stop loading
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_stop(Evas_Object *o)
+{
 …
+}
-/**
- * Asks frame to reload current document.
+ *
- * @param o frame object to reload current document
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
- * @see ewk_frame_reload_full()
- */
 Eina_Bool ewk_frame_reload(Evas_Object *o)
+{
 …
+}
-/**
- * Asks frame to fully reload current document, using no previous caches.
+ *
- * @param o frame object to reload current document
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_reload_full(Evas_Object *o)
+{
 …
+}
-/**
- * Asks the frame to navigate back in the history.
+ *
- * @param o frame object to navigate back
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
- * @see ewk_frame_navigate()
- */
 Eina_Bool ewk_frame_back(Evas_Object *o)
+{
 …
+}
-/**
- * Asks frame to navigate forward in the history.
+ *
- * @param o frame object to navigate forward
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
- * @see ewk_frame_navigate()
- */
 Eina_Bool ewk_frame_forward(Evas_Object *o)
+{
 …
+}
-/**
- * Navigates back or forward in the history.
+ *
- * @param o frame object to navigate
- * @param steps if positive navigates that amount forwards, if negative
- *        does backwards
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_navigate(Evas_Object *o, int steps)
+{
 …
+}
-/**
- * Queries if it's possible to navigate backwards one item in the history.
+ *
- * @param o frame object to query if backward navigation is possible
+ *
- * @return @c EINA_TRUE if it's possible to navigate backwards one item in the history, @c EINA_FALSE otherwise
+ *
- * @see ewk_frame_navigate_possible()
- */
 Eina_Bool ewk_frame_back_possible(Evas_Object *o)
+{
 …
+}
-/**
- * Queries if it's possible to navigate forwards one item in the history.
+ *
- * @param o frame object to query if forward navigation is possible
+ *
- * @return @c EINA_TRUE if it's possible to navigate forwards in the history, @c EINA_FALSE otherwise
+ *
- * @see ewk_frame_navigate_possible()
- */
 Eina_Bool ewk_frame_forward_possible(Evas_Object *o)
+{
 …
+}
-/**
- * Queries if it's possible to navigate given @a steps in the history.
+ *
- * @param o frame object to query if is possible to navigate @a steps in the history
- * @param steps positive value navigates that amount forwards, negative value
- *        does backwards
+ *
- * @return @c EINA_TRUE if it's possible to navigate @a steps in the history, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_navigate_possible(Evas_Object *o, int steps)
+{
 …
+}
-/**
- * Gets the current zoom level used by this frame.
+ *
- * @param o frame object to get zoom level
+ *
- * @return zoom level for the frame or @c -1.0 on failure
- */
 float ewk_frame_zoom_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Sets the current zoom level used by this frame.
+ *
- * @param o frame object to change zoom level
- * @param zoom a new zoom level
+ *
- * @return @c EINA_TRUE on success or @c EINA_FALSE on failure
+ *
- * @see ewk_frame_zoom_text_only_set()
- */
 Eina_Bool ewk_frame_zoom_set(Evas_Object *o, float zoom)
+{
 …
+}
-/**
- * Queries if zoom level just applies to text only and not other elements.
+ *
- * @param o frame to query zoom level for text only
+ *
- * @return @c EINA_TRUE if zoom level is applied to text only, @c EINA_FALSE if not or on failure
- */
 Eina_Bool ewk_frame_zoom_text_only_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Sets if zoom level just applies to text only and not other elements.
+ *
- * @param o frame to apply zoom level for text only
- * @param setting @c EINA_TRUE if zoom level should be applied to text only, @c EINA_FALSE if not
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_zoom_text_only_set(Evas_Object *o, Eina_Bool setting)
+{
 …
+}
-/**
- * Frees hit test instance created by ewk_frame_hit_test_new().
+ *
- * @param hit_test instance
- */
 void ewk_frame_hit_test_free(Ewk_Hit_Test *hit_test)
+{
 …
+}
-/**
- * Creates a new hit test for the given frame and point.
+ *
- * The returned object should be freed by ewk_frame_hit_test_free().
+ *
- * @param o frame object to do hit test on
- * @param x the horizontal position to query
- * @param y the vertical position to query
+ *
- * @return a newly allocated hit test on success, @c 0 otherwise
- */
 Ewk_Hit_Test *ewk_frame_hit_test_new(const Evas_Object *o, int x, int y)
+{
 …
+}
-/**
- * Sets a relative scroll of the given frame.
+ *
- * This function does scroll @a dx and @a dy pixels
- * from the current position of scroll.
+ *
- * @param o frame object to scroll
- * @param dx horizontal offset to scroll
- * @param dy vertical offset to scroll
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool
 ewk_frame_scroll_add(Evas_Object *o, int dx, int dy)
 …
+}
-/**
- * Sets an absolute scroll of the given frame.
+ *
- * Both values are from zero to the contents size minus the viewport
- * size. See ewk_frame_scroll_size_get().
+ *
- * @param o frame object to scroll
- * @param x horizontal position to scroll
- * @param y vertical position to scroll
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
- */
 Eina_Bool
 ewk_frame_scroll_set(Evas_Object *o, int x, int y)
 …
+}
-/**
- * Gets the possible scroll size of the given frame.
+ *
- * Possible scroll size is contents size minus the viewport
- * size. It's the last allowed value for ewk_frame_scroll_set()
+ *
- * @param o frame object to get scroll size
- * @param w the pointer to store the horizontal size that is possible to scroll,
- *        may be @c 0
- * @param h the pointer to store the vertical size that is possible to scroll,
- *        may be @c 0
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise and
- *         values are zeroed
- */
 Eina_Bool
 ewk_frame_scroll_size_get(const Evas_Object *o, int *w, int *h)
 …
+}
-/**
- * Gets the current scroll position of given frame.
+ *
- * @param o frame object to get the current scroll position
- * @param x the pointer to store the horizontal position, may be @c 0
- * @param y the pointer to store the vertical position. may be @c 0
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise and
- *         values are zeroed.
- */
 Eina_Bool
 ewk_frame_scroll_pos_get(const Evas_Object *o, int *x, int *y)
 …
+}
-/**
- * Gets the visible content geometry of the frame.
+ *
- * @param o frame object to query visible content geometry
- * @param include_scrollbars whenever to include scrollbars size
- * @param x the pointer to store the horizontal position, may be @c 0
- * @param y the pointer to store the vertical position, may be @c 0
- * @param w the pointer to store width, may be @c 0
- * @param h the pointer to store height, may be @c 0
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise and
- *         values are zeroed
- */
 Eina_Bool ewk_frame_visible_content_geometry_get(const Evas_Object *o, Eina_Bool include_scrollbars, int *x, int *y, int *w, int *h)
+{
 …
+}
-/**
- * Queries if the frame should be repainted completely.
+ *
- * Function tells if dirty areas should be repainted
- * even if they are out of the screen.
+ *
- * @param o frame object to query if the frame should be repainted completely
+ *
- * @return @c EINA_TRUE if any dirty areas should be repainted, @c EINA_FALSE
- *         otherwise
- */
 Eina_Bool ewk_frame_paint_full_get(const Evas_Object *o)
+{
 …
+}
-/**
- * Sets if the frame should be repainted completely.
+ *
- * Function sets if dirty areas should be repainted
- * even if they are out of the screen.
+ *
- * @param o frame object to set if the frame should be repainted completely
- * @param flag @c EINA_TRUE to repaint the frame completely,
- *             @c EINA_FALSE if not
- */
 void ewk_frame_paint_full_set(Evas_Object *o, Eina_Bool flag)
+{
 …
+}
-/**
- * Feeds the focus in event to the frame.
+ *
- * @param o frame object to feed focus
+ *
- * @return @c EINA_TRUE if the focus was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_focus_in(Evas_Object *o)
+{
 …
+}
-/**
- * Feeds the focus out event to the frame.
+ *
- * @param o frame object to remove focus
+ *
- * @return @c EINA_FALSE since the feature is not implemented
- */
 Eina_Bool ewk_frame_feed_focus_out(Evas_Object *o)
+{
 …
+}
-/**
- * Feeds the mouse wheel event to the frame.
+ *
- * @param o frame object to feed the mouse wheel event
- * @param ev the mouse wheel event
+ *
- * @return @c EINA_TRUE if the mouse wheel event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_mouse_wheel(Evas_Object *o, const Evas_Event_Mouse_Wheel *ev)
+{
 …
+}
-/**
- * Feeds the mouse down event to the frame.
+ *
- * @param o frame object to feed the mouse down event
- * @param ev the mouse down event
+ *
- * @return @c EINA_TRUE if the mouse down event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_mouse_down(Evas_Object *o, const Evas_Event_Mouse_Down *ev)
+{
 …
+}
-/**
- * Feeds the mouse up event to the frame.
+ *
- * @param o frame object to feed the mouse up event
- * @param ev the mouse up event
+ *
- * @return @c EINA_TRUE if the mouse up event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_mouse_up(Evas_Object *o, const Evas_Event_Mouse_Up *ev)
+{
 …
+}
-/**
- * Feeds the mouse move event to the frame.
+ *
- * @param o frame object to feed the mouse move event
- * @param ev the mouse move event
+ *
- * @return @c EINA_TRUE if the mouse move event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_mouse_move(Evas_Object *o, const Evas_Event_Mouse_Move *ev)
+{
 …
+}
-/**
- * Feeds the touch event to the frame.
+ *
- * @param o frame object to feed touch event
- * @param action the action of touch event
- * @param points a list of points (Ewk_Touch_Point) to process
- * @param metaState DEPRECTAED, not supported for now
+ *
- * @return @c EINA_TRUE if touch event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_touch_event(Evas_Object *o, Ewk_Touch_Event_Type action, Eina_List *points, int metaState)
+{
 …
+}
-/**
- * Feeds the keyboard key down event to the frame.
+ *
- * @param o frame object to feed event
- * @param ev keyboard key down event
+ *
- * @return @c EINA_TRUE if the key down event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_key_down(Evas_Object *o, const Evas_Event_Key_Down *ev)
+{
 …
+}
-/**
- * Feeds the keyboard key up event to the frame.
+ *
- * @param o frame object to feed event
- * @param ev keyboard key up event
+ *
- * @return @c EINA_TRUE if the key up event was handled, @c EINA_FALSE otherwise
- */
 Eina_Bool ewk_frame_feed_key_up(Evas_Object *o, const Evas_Event_Key_Up *ev)
+{
 …
+}
-/**
- * Returns current text selection type.
+ *
- * @param o a frame object to check selection type
- * @return Current text selection type on success or no selection otherwise
- */
 Ewk_Text_Selection_Type ewk_frame_text_selection_type_get(Evas_Object *o)
+{

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

-                      r92039
+                      r92473
 } Ewk_Text_Selection_Type;
+/**
+ * Retrieves the ewk_view object that owns this frame.
+ *
+ * @param o frame object to get view object
+ *
+ * @return view object or @c 0 on failure
+ */
 EAPI Evas_Object *ewk_frame_view_get(const Evas_Object *o);
+/**
+ * Returns a new iterator over all direct children frames.
+ *
+ * Keep frame object intact while iteration happens otherwise frame
+ * may be destroyed while iterated.
+ *
+ * Iteration results are Evas_Object*, so give eina_iterator_next() a
+ * pointer to it.
+ *
+ * Returned iterator should be freed by eina_iterator_free().
+ *
+ * @param o frame object to create the iterator
+ *
+ * @return a newly allocated iterator on sucess, or @c 0 if not possible to
+ *      create the iterator
+ */
 EAPI Eina_Iterator *ewk_frame_children_iterator_new(Evas_Object *o);
+/**
+ * Finds a child frame by its name, recursively.
+ *
+ * For pre-defined names, returns @a o if @a name is "_self" or
+ * "_current", returns @a o's parent frame if @a name is "_parent",
+ * and returns the main frame if @a name is "_top". Also returns @a o
+ * if it is the main frame and @a name is either "_parent" or
+ * "_top". For other names, this function returns the first frame that
+ * matches @a name. This function searches @a o and its descendents
+ * first, then @a o's parent and its children moving up the hierarchy
+ * until a match is found. If no match is found in @a o's hierarchy,
+ * this function will search for a matching frame in other main frame
+ * hierarchies.
+ *
+ * @param o frame object to find a child frame
+ * @param name child frame name
+ *
+ * @return child frame of the given frame, or @c 0 if the the child wasn't found
+ */
 EAPI Evas_Object   *ewk_frame_child_find(Evas_Object *o, const char *name);
+/**
+ * Asks the main frame to load the given URI.
+ *
+ * @param o frame object to load uri
+ * @param uri uniform resource identifier to load
+ *
+ * @return @c EINA_TRUE on success, or @c EINA_FALSE on failure
+ */
 EAPI Eina_Bool    ewk_frame_uri_set(Evas_Object *o, const char *uri);
+/**
+ * Gets the uri of this frame.
+ *
+ * It returns an internal string and should not
+ * be modified. The string is guaranteed to be stringshared.
+ *
+ * @param o frame object to get uri
+ *
+ * @return frame uri on success or @c 0 on failure
+ */
 EAPI const char  *ewk_frame_uri_get(const Evas_Object *o);
+/**
+ * Gets the title of this frame.
+ *
+ * It returns an internal string and should not
+ * be modified. The string is guaranteed to be stringshared.
+ *
+ * @param o frame object to get title
+ *
+ * @return frame title on success or @c 0 on failure
+ */
 EAPI const char  *ewk_frame_title_get(const Evas_Object *o);
+/**
+ * Gets the name of this frame.
+ *
+ * It returns an internal string and should not
+ * be modified. The string is guaranteed to be stringshared.
+ *
+ * @param o frame object to get name
+ *
+ * @return frame name on success or @c 0 on failure
+ */
 EAPI const char  *ewk_frame_name_get(const Evas_Object *o);
+/**
+ * Gets last known contents size.
+ *
+ * @param o frame object to get contents size
+ * @param w pointer to store contents size width, may be @c 0
+ * @param h pointer to store contents size height, may be @c 0
+ *
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on failure and
+ *         @a w and @a h will be zeroed
+ */
 EAPI Eina_Bool    ewk_frame_contents_size_get(const Evas_Object *o, Evas_Coord *w, Evas_Coord *h);
+/**
+ * Requests loading the given contents in this frame.
+ *
+ * @param o frame object to load document
+ * @param contents what to load into frame
+ * @param contents_size size of @a contents (in bytes),
+ *        if @c 0 is given, length of @a contents is used
+ * @param mime_type type of @a contents data, if @c 0 is given "text/html" is assumed
+ * @param encoding encoding for @a contents data, if @c 0 is given "UTF-8" is assumed
+ * @param base_uri base uri to use for relative resources, may be @c 0,
+ *        if provided @b must be an absolute uri
+ *
+ * @return @c EINA_TRUE on successful request, @c EINA_FALSE on errors
+ */
 EAPI Eina_Bool    ewk_frame_contents_set(Evas_Object *o, const char *contents, size_t contents_size, const char *mime_type, const char *encoding, const char *base_uri);
+/**
+ * Requests loading alternative contents for unreachable URI in this frame.
+ *
+ * This is similar to ewk_frame_contents_set(), but is used when some
+ * URI was failed to load, using the provided content instead. The main
+ * difference is that back-forward navigation list is not changed.
+ *
+ * @param o frame object to load alternative content
+ * @param contents what to load into frame, must @b not be @c 0
+ * @param contents_size size of @a contents (in bytes),
+ *        if @c 0 is given, length of @a contents is used
+ * @param mime_type type of @a contents data, if @c 0 is given "text/html" is assumed
+ * @param encoding encoding used for @a contents data, if @c 0 is given "UTF-8" is assumed
+ * @param base_uri base URI to use for relative resources, may be @c 0,
+ *        if provided must be an absolute uri
+ * @param unreachable_uri the URI that failed to load and is getting the
+ *        alternative representation
+ *
+ * @return @c EINA_TRUE on successful request, @c EINA_FALSE on errors
+ */
 EAPI Eina_Bool    ewk_frame_contents_alternate_set(Evas_Object *o, const char *contents, size_t contents_size, const char *mime_type, const char *encoding, const char *base_uri, const char *unreachable_uri);
+/**
+ * Requests execution of the given script.
+ *
+ * @param o frame object to execute script
+ * @param script Java Script to execute
+ *
+ * @return @c EINA_TRUE if request was done, @c EINA_FALSE on errors
+ */
 EAPI Eina_Bool    ewk_frame_script_execute(Evas_Object *o, const char *script);
+/**
+ * Queries if the frame is editable.
+ *
+ * @param o the frame object to query editable state
+ *
+ * @return @c EINA_TRUE if the frame is editable, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_editable_get(const Evas_Object *o);
+/**
+ * Sets editable state for frame.
+ *
+ * @param o the frame object to set editable state
+ * @param editable a new state to set
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_editable_set(Evas_Object *o, Eina_Bool editable);
+/**
+ * Gets the copy of the selected text.
+ *
+ * The returned string @b should be freed after use.
+ *
+ * @param o the frame object to get selected text
+ *
+ * @return a newly allocated string or @c 0 if nothing is selected or on failure
+ */
 EAPI char        *ewk_frame_selection_get(const Evas_Object *o);
+/**
+ * Searches the given string in a document.
+ *
+ * @param o frame object where to search the text
+ * @param string reference string to search
+ * @param case_sensitive if search should be case sensitive or not
+ * @param forward if search is from cursor and on or backwards
+ * @param wrap if search should wrap at the end
+ *
+ * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not or failure
+ */
 EAPI Eina_Bool    ewk_frame_text_search(const Evas_Object *o, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
+/**
+ * Marks matches the given string in a document.
+ *
+ * @param o frame object where to search text
+ * @param string reference string to match
+ * @param case_sensitive if match should be case sensitive or not
+ * @param highlight if matches should be highlighted
+ * @param limit maximum amount of matches, or zero to unlimited
+ *
+ * @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.
+ * Reverses the effect of ewk_frame_text_matches_mark().
+ *
+ * @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_highlight_set(Evas_Object *o, Eina_Bool highlight);
+/**
+ * Returns whether matches marked with ewk_frame_text_matches_mark() are highlighted.
+ *
+ * @param o frame object to query if matches are highlighted or not
+ *
+ * @return @c EINA_TRUE if matches are highlighted, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_text_matches_highlight_get(const Evas_Object *o);
+/**
+ * Returns the position of the n-th matched text in the frame.
+ *
+ * @param o frame object where matches are marked
+ * @param n index of element
+ * @param x the pointer to store the horizontal position of @a n matched text, may be @c 0
+ * @param y the pointer to store the vertical position of @a n matched text, may be @c 0
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE when no matches were found or
+ *         @a n is bigger than search results or on failure
+ */
 EAPI Eina_Bool    ewk_frame_text_matches_nth_pos_get(Evas_Object *o, size_t n, int *x, int *y);
+/**
+ * Asks frame to stop loading.
+ *
+ * @param o frame object to stop loading
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_stop(Evas_Object *o);
+/**
+ * Asks frame to reload current document.
+ *
+ * @param o frame object to reload current document
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
+ * @see ewk_frame_reload_full()
+ */
 EAPI Eina_Bool    ewk_frame_reload(Evas_Object *o);
+/**
+ * Asks frame to fully reload current document, using no previous caches.
+ *
+ * @param o frame object to reload current document
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_reload_full(Evas_Object *o);
+/**
+ * Asks the frame to navigate back in the history.
+ *
+ * @param o frame object to navigate back
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
+ * @see ewk_frame_navigate()
+ */
 EAPI Eina_Bool    ewk_frame_back(Evas_Object *o);
+/**
+ * Asks frame to navigate forward in the history.
+ *
+ * @param o frame object to navigate forward
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
+ * @see ewk_frame_navigate()
+ */
 EAPI Eina_Bool    ewk_frame_forward(Evas_Object *o);
+/**
+ * Navigates back or forward in the history.
+ *
+ * @param o frame object to navigate
+ * @param steps if positive navigates that amount forwards, if negative
+ *        does backwards
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_navigate(Evas_Object *o, int steps);
+/**
+ * Queries if it's possible to navigate backwards one item in the history.
+ *
+ * @param o frame object to query if backward navigation is possible
+ *
+ * @return @c EINA_TRUE if it's possible to navigate backwards one item in the history, @c EINA_FALSE otherwise
+ *
+ * @see ewk_frame_navigate_possible()
+ */
 EAPI Eina_Bool    ewk_frame_back_possible(Evas_Object *o);
+/**
+ * Queries if it's possible to navigate forwards one item in the history.
+ *
+ * @param o frame object to query if forward navigation is possible
+ *
+ * @return @c EINA_TRUE if it's possible to navigate forwards in the history, @c EINA_FALSE otherwise
+ *
+ * @see ewk_frame_navigate_possible()
+ */
 EAPI Eina_Bool    ewk_frame_forward_possible(Evas_Object *o);
+/**
+ * Queries if it's possible to navigate given @a steps in the history.
+ *
+ * @param o frame object to query if is possible to navigate @a steps in the history
+ * @param steps positive value navigates that amount forwards, negative value
+ *        does backwards
+ *
+ * @return @c EINA_TRUE if it's possible to navigate @a steps in the history, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_navigate_possible(Evas_Object *o, int steps);
+/**
+ * Gets the current zoom level used by this frame.
+ *
+ * @param o frame object to get zoom level
+ *
+ * @return zoom level for the frame or @c -1.0 on failure
+ */
 EAPI float        ewk_frame_zoom_get(const Evas_Object *o);
+/**
+ * Sets the current zoom level used by this frame.
+ *
+ * @param o frame object to change zoom level
+ * @param zoom a new zoom level
+ *
+ * @return @c EINA_TRUE on success or @c EINA_FALSE on failure
+ *
+ * @see ewk_frame_zoom_text_only_set()
+ */
 EAPI Eina_Bool    ewk_frame_zoom_set(Evas_Object *o, float zoom);
+/**
+ * Queries if zoom level just applies to text only and not other elements.
+ *
+ * @param o frame to query zoom level for text only
+ *
+ * @return @c EINA_TRUE if zoom level is applied to text only, @c EINA_FALSE if not or on failure
+ */
 EAPI Eina_Bool    ewk_frame_zoom_text_only_get(const Evas_Object *o);
+/**
+ * Sets if zoom level just applies to text only and not other elements.
+ *
+ * @param o frame to apply zoom level for text only
+ * @param setting @c EINA_TRUE if zoom level should be applied to text only, @c EINA_FALSE if not
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_zoom_text_only_set(Evas_Object *o, Eina_Bool setting);
+/**
+ * Frees hit test instance created by ewk_frame_hit_test_new().
+ *
+ * @param hit_test instance
+ */
 EAPI void          ewk_frame_hit_test_free(Ewk_Hit_Test *hit_test);
+/**
+ * Creates a new hit test for the given frame and point.
+ *
+ * The returned object should be freed by ewk_frame_hit_test_free().
+ *
+ * @param o frame object to do hit test on
+ * @param x the horizontal position to query
+ * @param y the vertical position to query
+ *
+ * @return a newly allocated hit test on success, @c 0 otherwise
+ */
 EAPI Ewk_Hit_Test *ewk_frame_hit_test_new(const Evas_Object *o, int x, int y);
+/**
+ * Sets a relative scroll of the given frame.
+ *
+ * This function does scroll @a dx and @a dy pixels
+ * from the current position of scroll.
+ *
+ * @param o frame object to scroll
+ * @param dx horizontal offset to scroll
+ * @param dy vertical offset to scroll
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_scroll_add(Evas_Object *o, int dx, int dy);
+/**
+ * Sets an absolute scroll of the given frame.
+ *
+ * Both values are from zero to the contents size minus the viewport
+ * size. See ewk_frame_scroll_size_get().
+ *
+ * @param o frame object to scroll
+ * @param x horizontal position to scroll
+ * @param y vertical position to scroll
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_scroll_set(Evas_Object *o, int x, int y);
+/**
+ * Gets the possible scroll size of the given frame.
+ *
+ * Possible scroll size is contents size minus the viewport
+ * size. It's the last allowed value for ewk_frame_scroll_set()
+ *
+ * @param o frame object to get scroll size
+ * @param w the pointer to store the horizontal size that is possible to scroll,
+ *        may be @c 0
+ * @param h the pointer to store the vertical size that is possible to scroll,
+ *        may be @c 0
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise and
+ *         values are zeroed
+ */
 EAPI Eina_Bool    ewk_frame_scroll_size_get(const Evas_Object *o, int *w, int *h);
+/**
+ * Gets the current scroll position of given frame.
+ *
+ * @param o frame object to get the current scroll position
+ * @param x the pointer to store the horizontal position, may be @c 0
+ * @param y the pointer to store the vertical position. may be @c 0
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise and
+ *         values are zeroed.
+ */
 EAPI Eina_Bool    ewk_frame_scroll_pos_get(const Evas_Object *o, int *x, int *y);
+/**
+ * Gets the visible content geometry of the frame.
+ *
+ * @param o frame object to query visible content geometry
+ * @param include_scrollbars whenever to include scrollbars size
+ * @param x the pointer to store the horizontal position, may be @c 0
+ * @param y the pointer to store the vertical position, may be @c 0
+ * @param w the pointer to store width, may be @c 0
+ * @param h the pointer to store height, may be @c 0
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise and
+ *         values are zeroed
+ */
 EAPI Eina_Bool    ewk_frame_visible_content_geometry_get(const Evas_Object *o, Eina_Bool include_scrollbars, int *x, int *y, int *w, int *h);
+/**
+ * Queries if the frame should be repainted completely.
+ *
+ * Function tells if dirty areas should be repainted
+ * even if they are out of the screen.
+ *
+ * @param o frame object to query if the frame should be repainted completely
+ *
+ * @return @c EINA_TRUE if any dirty areas should be repainted, @c EINA_FALSE
+ *         otherwise
+ */
 EAPI Eina_Bool    ewk_frame_paint_full_get(const Evas_Object *o);
+/**
+ * Sets if the frame should be repainted completely.
+ *
+ * Function sets if dirty areas should be repainted
+ * even if they are out of the screen.
+ *
+ * @param o frame object to set if the frame should be repainted completely
+ * @param flag @c EINA_TRUE to repaint the frame completely,
+ *             @c EINA_FALSE if not
+ */
 EAPI void         ewk_frame_paint_full_set(Evas_Object *o, Eina_Bool flag);
+/**
+ * Feeds the focus in event to the frame.
+ *
+ * @param o frame object to feed focus
+ *
+ * @return @c EINA_TRUE if the focus was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_focus_in(Evas_Object *o);
+/**
+ * Feeds the focus out event to the frame.
+ *
+ * @param o frame object to remove focus
+ *
+ * @return @c EINA_FALSE since the feature is not implemented
+ */
 EAPI Eina_Bool    ewk_frame_feed_focus_out(Evas_Object *o);
+/**
+ * Feeds the mouse wheel event to the frame.
+ *
+ * @param o frame object to feed the mouse wheel event
+ * @param ev the mouse wheel event
+ *
+ * @return @c EINA_TRUE if the mouse wheel event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_mouse_wheel(Evas_Object *o, const Evas_Event_Mouse_Wheel *ev);
+/**
+ * Feeds the mouse down event to the frame.
+ *
+ * @param o frame object to feed the mouse down event
+ * @param ev the mouse down event
+ *
+ * @return @c EINA_TRUE if the mouse down event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_mouse_down(Evas_Object *o, const Evas_Event_Mouse_Down *ev);
+/**
+ * Feeds the mouse up event to the frame.
+ *
+ * @param o frame object to feed the mouse up event
+ * @param ev the mouse up event
+ *
+ * @return @c EINA_TRUE if the mouse up event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_mouse_up(Evas_Object *o, const Evas_Event_Mouse_Up *ev);
+/**
+ * Feeds the mouse move event to the frame.
+ *
+ * @param o frame object to feed the mouse move event
+ * @param ev the mouse move event
+ *
+ * @return @c EINA_TRUE if the mouse move event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_mouse_move(Evas_Object *o, const Evas_Event_Mouse_Move *ev);
+/**
+ * Feeds the touch event to the frame.
+ *
+ * @param o frame object to feed touch event
+ * @param action the action of touch event
+ * @param points a list of points (Ewk_Touch_Point) to process
+ * @param metaState DEPRECTAED, not supported for now
+ *
+ * @return @c EINA_TRUE if touch event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_touch_event(Evas_Object *o, Ewk_Touch_Event_Type action, Eina_List *points, int metaState);
+/**
+ * Feeds the keyboard key down event to the frame.
+ *
+ * @param o frame object to feed event
+ * @param ev keyboard key down event
+ *
+ * @return @c EINA_TRUE if the key down event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_key_down(Evas_Object *o, const Evas_Event_Key_Down *ev);
+/**
+ * Feeds the keyboard key up event to the frame.
+ *
+ * @param o frame object to feed event
+ * @param ev keyboard key up event
+ *
+ * @return @c EINA_TRUE if the key up event was handled, @c EINA_FALSE otherwise
+ */
 EAPI Eina_Bool    ewk_frame_feed_key_up(Evas_Object *o, const Evas_Event_Key_Up *ev);
+/**
+ * Returns current text selection type.
+ *
+ * @param o a frame object to check selection type
+ * @return current text selection type on success or no selection otherwise
+ */
 EAPI Ewk_Text_Selection_Type ewk_frame_text_selection_type_get(Evas_Object *o);

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

-                      r86480
+                      r92473
+}
-/**
- * Go forward in history one item, if possible.
+ *
- * @param history which history instance to modify.
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
- */
 Eina_Bool ewk_history_forward(Ewk_History* history)
+{
 …
+}
-/**
- * Go back in history one item, if possible.
+ *
- * @param history which history instance to modify.
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
- */
 Eina_Bool ewk_history_back(Ewk_History* history)
+{
 …
+}
-/**
- * Adds the given item to history.
+ *
- * Memory handling: This will not modify or even take references to
- * given item (Ewk_History_Item), so you should still handle it with
- * ewk_history_item_free().
+ *
- * @param history which history instance to modify.
- * @param item reference to add to history. Unmodified. Must @b not be @c NULL.
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
- */
 Eina_Bool ewk_history_history_item_add(Ewk_History* history, const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Sets the given item as current in history (go to item).
+ *
- * Memory handling: This will not modify or even take references to
- * given item (Ewk_History_Item), so you should still handle it with
- * ewk_history_item_free().
+ *
- * @param history which history instance to modify.
- * @param item reference to go to history. Unmodified. Must @b not be @c NULL.
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
- */
 Eina_Bool ewk_history_history_item_set(Ewk_History* history, const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Get the first item from back list, if any.
+ *
- * @param history which history instance to query.
+ *
- * @return the @b newly allocated item instance. This memory must be
- *         released with ewk_history_item_free() after use.
- */
 Ewk_History_Item* ewk_history_history_item_back_get(const Ewk_History* history)
+{
 …
+}
-/**
- * Get the current item in history, if any.
+ *
- * @param history which history instance to query.
+ *
- * @return the @b newly allocated item instance. This memory must be
- *         released with ewk_history_item_free() after use.
- */
 Ewk_History_Item* ewk_history_history_item_current_get(const Ewk_History* history)
+{
 …
+}
-/**
- * Get the first item from forward list, if any.
+ *
- * @param history which history instance to query.
+ *
- * @return the @b newly allocated item instance. This memory must be
- *         released with ewk_history_item_free() after use.
- */
 Ewk_History_Item* ewk_history_history_item_forward_get(const Ewk_History* history)
+{
 …
+}
-/**
- * Get item at given position, if any at that index.
+ *
- * @param history which history instance to query.
- * @param index position of item to get.
+ *
- * @return the @b newly allocated item instance. This memory must be
- *         released with ewk_history_item_free() after use.
- */
 Ewk_History_Item* ewk_history_history_item_nth_get(const Ewk_History* history, int index)
+{
 …
+}
-/**
- * Queries if given item is in history.
+ *
- * Memory handling: This will not modify or even take references to
- * given item (Ewk_History_Item), so you should still handle it with
- * ewk_history_item_free().
+ *
- * @param history which history instance to modify.
- * @param item reference to check in history. Must @b not be @c NULL.
+ *
- * @return @c EINA_TRUE if in history, @c EINA_FALSE if not or failure.
- */
 Eina_Bool ewk_history_history_item_contains(const Ewk_History* history, const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Get the whole forward list.
+ *
- * @param history which history instance to query.
+ *
- * @return a newly allocated list of @b newly allocated item
- *         instance. This memory of each item must be released with
- *         ewk_history_item_free() after use. use
- *         ewk_history_item_list_free() for convenience.
+ *
- * @see ewk_history_item_list_free()
- * @see ewk_history_forward_list_get_with_limit()
- */
 Eina_List* ewk_history_forward_list_get(const Ewk_History* history)
+{
 …
+}
-/**
- * Get the forward list within the given limit.
+ *
- * @param history which history instance to query.
- * @param limit the maximum number of items to return.
+ *
- * @return a newly allocated list of @b newly allocated item
- *         instance. This memory of each item must be released with
- *         ewk_history_item_free() after use. use
- *         ewk_history_item_list_free() for convenience.
+ *
- * @see ewk_history_item_list_free()
- * @see ewk_history_forward_list_length()
- * @see ewk_history_forward_list_get()
- */
 Eina_List* ewk_history_forward_list_get_with_limit(const Ewk_History* history, int limit)
+{
 …
+}
-/**
- * Get the whole size of forward list.
+ *
- * @param history which history instance to query.
+ *
- * @return number of elements in whole list.
+ *
- * @see ewk_history_forward_list_get_with_limit()
- */
 int ewk_history_forward_list_length(const Ewk_History* history)
+{
 …
+}
-/**
- * Get the whole back list.
+ *
- * @param history which history instance to query.
+ *
- * @return a newly allocated list of @b newly allocated item
- *         instance. This memory of each item must be released with
- *         ewk_history_item_free() after use. use
- *         ewk_history_item_list_free() for convenience.
+ *
- * @see ewk_history_item_list_free()
- * @see ewk_history_back_list_get_with_limit()
- */
 Eina_List* ewk_history_back_list_get(const Ewk_History* history)
+{
 …
+}
-/**
- * Get the back list within the given limit.
+ *
- * @param history which history instance to query.
- * @param limit the maximum number of items to return.
+ *
- * @return a newly allocated list of @b newly allocated item
- *         instance. This memory of each item must be released with
- *         ewk_history_item_free() after use. use
- *         ewk_history_item_list_free() for convenience.
+ *
- * @see ewk_history_item_list_free()
- * @see ewk_history_back_list_length()
- * @see ewk_history_back_list_get()
- */
 Eina_List* ewk_history_back_list_get_with_limit(const Ewk_History* history, int limit)
+{
 …
+}
-/**
- * Get the whole size of back list.
+ *
- * @param history which history instance to query.
+ *
- * @return number of elements in whole list.
+ *
- * @see ewk_history_back_list_get_with_limit()
- */
 int ewk_history_back_list_length(const Ewk_History* history)
+{
 …
+}
-/**
- * Get maximum capacity of given history.
+ *
- * @param history which history instance to query.
+ *
- * @return maximum number of entries this history will hold.
- */
 int ewk_history_limit_get(Ewk_History* history)
+{
 …
+}
-/**
- * Set maximum capacity of given history.
+ *
- * @param history which history instance to modify.
- * @param limit maximum size to allow.
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
- */
 Eina_Bool ewk_history_limit_set(const Ewk_History* history, int limit)
+{
 …
+}
-/**
- * Create a new history item with given URI and title.
+ *
- * @param uri where this resource is located.
- * @param title resource title.
+ *
- * @return newly allocated history item or @c NULL on errors. You must
- *         free this item with ewk_history_item_free().
- */
 Ewk_History_Item* ewk_history_item_new(const char* uri, const char* title)
+{
 …
+}
-/**
- * Free given history item instance.
+ *
- * @param item what to free.
- */
 void ewk_history_item_free(Ewk_History_Item* item)
+{
 …
+}
-/**
- * Free given list and associated history items instances.
+ *
- * @param history_items list of items to free (both list nodes and
- *        item instances).
- */
 void ewk_history_item_list_free(Eina_List* history_items)
+{
 …
+}
-/**
- * Query title for given history item.
+ *
- * @param item history item to query.
+ *
- * @return the title pointer, that may be @c NULL. This pointer is
- *         guaranteed to be eina_stringshare, so whenever possible
- *         save yourself some cpu cycles and use
- *         eina_stringshare_ref() instead of eina_stringshare_add() or
- *         strdup().
- */
 const char* ewk_history_item_title_get(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Query alternate title for given history item.
+ *
- * @param item history item to query.
+ *
- * @return the alternate title pointer, that may be @c NULL. This
- *         pointer is guaranteed to be eina_stringshare, so whenever
- *         possible save yourself some cpu cycles and use
- *         eina_stringshare_ref() instead of eina_stringshare_add() or
- *         strdup().
- */
 const char* ewk_history_item_title_alternate_get(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Set alternate title for given history item.
+ *
- * @param item history item to query.
- * @param title new alternate title to use for given item. No
- *        references are kept after this function returns.
- */
 void ewk_history_item_title_alternate_set(Ewk_History_Item* item, const char* title)
+{
 …
+}
-/**
- * Query URI for given history item.
+ *
- * @param item history item to query.
+ *
- * @return the URI pointer, that may be @c NULL. This pointer is
- *         guaranteed to be eina_stringshare, so whenever possible
- *         save yourself some cpu cycles and use
- *         eina_stringshare_ref() instead of eina_stringshare_add() or
- *         strdup().
- */
 const char* ewk_history_item_uri_get(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Query original URI for given history item.
+ *
- * @param item history item to query.
+ *
- * @return the original URI pointer, that may be @c NULL. This pointer
- *         is guaranteed to be eina_stringshare, so whenever possible
- *         save yourself some cpu cycles and use
- *         eina_stringshare_ref() instead of eina_stringshare_add() or
- *         strdup().
- */
 const char* ewk_history_item_uri_original_get(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Query last visited time for given history item.
+ *
- * @param item history item to query.
+ *
- * @return the time in seconds this item was visited.
- */
 double ewk_history_item_time_last_visited_get(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Get the icon (aka favicon) associated with this history item.
+ *
- * @note in order to have this working, one must open icon database
- *       with ewk_settings_icon_database_path_set().
+ *
- * @param item history item to query.
+ *
- * @return the surface reference or @c NULL on errors. Note that the
- *         reference may be to a standard fallback icon.
- */
 cairo_surface_t* ewk_history_item_icon_surface_get(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Add an Evas_Object of type 'image' to given canvas with history item icon.
+ *
- * This is an utility function that creates an Evas_Object of type
- * image set to have fill always match object size
- * (evas_object_image_filled_add()), saving some code to use it from Evas.
+ *
- * @note in order to have this working, one must open icon database
- *       with ewk_settings_icon_database_path_set().
+ *
- * @param item history item to query.
- * @param canvas evas instance where to add resulting object.
+ *
- * @return newly allocated Evas_Object instance or @c NULL on
- *         errors. Delete the object with evas_object_del().
- */
 Evas_Object* ewk_history_item_icon_object_add(const Ewk_History_Item* item, Evas* canvas)
+{
 …
+}
-/**
- * Query if given item is still in page cache.
+ *
- * @param item history item to query.
+ *
- * @return @c EINA_TRUE if in cache, @c EINA_FALSE otherwise.
- */
 Eina_Bool ewk_history_item_page_cache_exists(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Query number of times item was visited.
+ *
- * @param item history item to query.
+ *
- * @return number of visits.
- */
 int ewk_history_item_visit_count(const Ewk_History_Item* item)
+{
 …
+}
-/**
- * Query if last visit to item was failure or not.
+ *
- * @param item history item to query.
+ *
- * @return @c EINA_TRUE if last visit was failure, @c EINA_FALSE if it
- *         was fine.
- */
 Eina_Bool ewk_history_item_visit_last_failed(const Ewk_History_Item* item)
+{

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

-                      r84771
+                      r92473
+/**
+ * Go forward in history one item, if possible.
+ *
+ * @param history which history instance to modify.
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
+ */
 EAPI Eina_Bool         ewk_history_forward(Ewk_History *history);
+/**
+ * Go back in history one item, if possible.
+ *
+ * @param history which history instance to modify.
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
+ */
 EAPI Eina_Bool         ewk_history_back(Ewk_History *history);
+/**
+ * Adds the given item to history.
+ *
+ * Memory handling: This will not modify or even take references to
+ * given item (Ewk_History_Item), so you should still handle it with
+ * ewk_history_item_free().
+ *
+ * @param history which history instance to modify.
+ * @param item reference to add to history. Unmodified. Must @b not be @c NULL.
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
+ */
 EAPI Eina_Bool         ewk_history_history_item_add(Ewk_History *history, const Ewk_History_Item *item);
+/**
+ * Sets the given item as current in history (go to item).
+ *
+ * Memory handling: This will not modify or even take references to
+ * given item (Ewk_History_Item), so you should still handle it with
+ * ewk_history_item_free().
+ *
+ * @param history which history instance to modify.
+ * @param item reference to go to history. Unmodified. Must @b not be @c NULL.
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on failure.
+ */
 EAPI Eina_Bool         ewk_history_history_item_set(Ewk_History *history,  const Ewk_History_Item *item);
+/**
+ * Get the first item from back list, if any.
+ *
+ * @param history which history instance to query.
+ *
+ * @return the @b newly allocated item instance. This memory must be
+ *         released with ewk_history_item_free() after use.
+ */
 EAPI Ewk_History_Item *ewk_history_history_item_back_get(const Ewk_History *history);
+/**
+ * Get the current item in history, if any.
+ *
+ * @param history which history instance to query.
+ *
+ * @return the @b newly allocated item instance. This memory must be
+ *         released with ewk_history_item_free() after use.
+ */
 EAPI Ewk_History_Item *ewk_history_history_item_current_get(const Ewk_History *history);
+/**
+ * Get the first item from forward list, if any.
+ *
+ * @param history which history instance to query.
+ *
+ * @return the @b newly allocated item instance. This memory must be
+ *         released with ewk_history_item_free() after use.
+ */
 EAPI Ewk_History_Item *ewk_history_history_item_forward_get(const Ewk_History *history);
+/**
+ * Get item at given position, if any at that index.
+ *
+ * @param history which history instance to query.
+ * @param index position of item to get.
+ *
+ * @return the @b newly allocated item instance. This memory must be
+ *         released with ewk_history_item_free() after use.
+ */
 EAPI Ewk_History_Item *ewk_history_history_item_nth_get(const Ewk_History *history, int index);
+/**
+ * Queries if given item is in history.
+ *
+ * Memory handling: This will not modify or even take references to
+ * given item (Ewk_History_Item), so you should still handle it with
+ * ewk_history_item_free().
+ *
+ * @param history which history instance to modify.
+ * @param item reference to check in history. Must @b not be @c NULL.
+ *
+ * @return @c EINA_TRUE if in history, @c EINA_FALSE if not or failure.
+ */
 EAPI Eina_Bool         ewk_history_history_item_contains(const Ewk_History *history, const Ewk_History_Item *item);
+/**
+ * Get the whole forward list.
+ *
+ * @param history which history instance to query.
+ *
+ * @return a newly allocated list of @b newly allocated item
+ *         instance. This memory of each item must be released with
+ *         ewk_history_item_free() after use. use
+ *         ewk_history_item_list_free() for convenience.
+ *
+ * @see ewk_history_item_list_free()
+ * @see ewk_history_forward_list_get_with_limit()
+ */
 EAPI Eina_List        *ewk_history_forward_list_get(const Ewk_History *history);
+/**
+ * Get the forward list within the given limit.
+ *
+ * @param history which history instance to query.
+ * @param limit the maximum number of items to return.
+ *
+ * @return a newly allocated list of @b newly allocated item
+ *         instance. This memory of each item must be released with
+ *         ewk_history_item_free() after use. use
+ *         ewk_history_item_list_free() for convenience.
+ *
+ * @see ewk_history_item_list_free()
+ * @see ewk_history_forward_list_length()
+ * @see ewk_history_forward_list_get()
+ */
 EAPI Eina_List        *ewk_history_forward_list_get_with_limit(const Ewk_History *history, int limit);
+/**
+ * Get the whole size of forward list.
+ *
+ * @param history which history instance to query.
+ *
+ * @return number of elements in whole list.
+ *
+ * @see ewk_history_forward_list_get_with_limit()
+ */
 EAPI int               ewk_history_forward_list_length(const Ewk_History *history);
+/**
+ * Get the whole back list.
+ *
+ * @param history which history instance to query.
+ *
+ * @return a newly allocated list of @b newly allocated item
+ *         instance. This memory of each item must be released with
+ *         ewk_history_item_free() after use. use
+ *         ewk_history_item_list_free() for convenience.
+ *
+ * @see ewk_history_item_list_free()
+ * @see ewk_history_back_list_get_with_limit()
+ */
 EAPI Eina_List        *ewk_history_back_list_get(const Ewk_History *history);
+/**
+ * Get the back list within the given limit.
+ *
+ * @param history which history instance to query.
+ * @param limit the maximum number of items to return.
+ *
+ * @return a newly allocated list of @b newly allocated item
+ *         instance. This memory of each item must be released with
+ *         ewk_history_item_free() after use. use
+ *         ewk_history_item_list_free() for convenience.
+ *
+ * @see ewk_history_item_list_free()
+ * @see ewk_history_back_list_length()
+ * @see ewk_history_back_list_get()
+ */
 EAPI Eina_List        *ewk_history_back_list_get_with_limit(const Ewk_History *history, int limit);
+/**
+ * Get the whole size of back list.
+ *
+ * @param history which history instance to query.
+ *
+ * @return number of elements in whole list.
+ *
+ * @see ewk_history_back_list_get_with_limit()
+ */
 EAPI int               ewk_history_back_list_length(const Ewk_History *history);
+/**
+ * Get maximum capacity of given history.
+ *
+ * @param history which history instance to query.
+ *
+ * @return maximum number of entries this history will hold.
+ */
 EAPI int               ewk_history_limit_get(Ewk_History *history);
+/**
+ * Set maximum capacity of given history.
+ *
+ * @param history which history instance to modify.
+ * @param limit maximum size to allow.
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
+ */
 EAPI Eina_Bool         ewk_history_limit_set(const Ewk_History *history, int limit);
+/**
+ * Create a new history item with given URI and title.
+ *
+ * @param uri where this resource is located.
+ * @param title resource title.
+ *
+ * @return newly allocated history item or @c NULL on errors. You must
+ *         free this item with ewk_history_item_free().
+ */
 EAPI Ewk_History_Item *ewk_history_item_new(const char *uri, const char *title);
+/**
+ * Free given history item instance.
+ *
+ * @param item what to free.
+ */
 EAPI void              ewk_history_item_free(Ewk_History_Item *item);
+/**
+ * Free given list and associated history items instances.
+ *
+ * @param history_items list of items to free (both list nodes and
+ *        item instances).
+ */
 EAPI void              ewk_history_item_list_free(Eina_List *history_items);
+/**
+ * Query title for given history item.
+ *
+ * @param item history item to query.
+ *
+ * @return the title pointer, that may be @c NULL. This pointer is
+ *         guaranteed to be eina_stringshare, so whenever possible
+ *         save yourself some cpu cycles and use
+ *         eina_stringshare_ref() instead of eina_stringshare_add() or
+ *         strdup().
+ */
 EAPI const char       *ewk_history_item_title_get(const Ewk_History_Item *item);
+/**
+ * Query alternate title for given history item.
+ *
+ * @param item history item to query.
+ *
+ * @return the alternate title pointer, that may be @c NULL. This
+ *         pointer is guaranteed to be eina_stringshare, so whenever
+ *         possible save yourself some cpu cycles and use
+ *         eina_stringshare_ref() instead of eina_stringshare_add() or
+ *         strdup().
+ */
 EAPI const char       *ewk_history_item_title_alternate_get(const Ewk_History_Item *item);
+/**
+ * Set alternate title for given history item.
+ *
+ * @param item history item to query.
+ * @param title new alternate title to use for given item. No
+ *        references are kept after this function returns.
+ */
 EAPI void              ewk_history_item_title_alternate_set(Ewk_History_Item *item, const char *title);
+/**
+ * Query URI for given history item.
+ *
+ * @param item history item to query.
+ *
+ * @return the URI pointer, that may be @c NULL. This pointer is
+ *         guaranteed to be eina_stringshare, so whenever possible
+ *         save yourself some cpu cycles and use
+ *         eina_stringshare_ref() instead of eina_stringshare_add() or
+ *         strdup().
+ */
 EAPI const char       *ewk_history_item_uri_get(const Ewk_History_Item *item);
+/**
+ * Query original URI for given history item.
+ *
+ * @param item history item to query.
+ *
+ * @return the original URI pointer, that may be @c NULL. This pointer
+ *         is guaranteed to be eina_stringshare, so whenever possible
+ *         save yourself some cpu cycles and use
+ *         eina_stringshare_ref() instead of eina_stringshare_add() or
+ *         strdup().
+ */
 EAPI const char       *ewk_history_item_uri_original_get(const Ewk_History_Item *item);
+/**
+ * Query last visited time for given history item.
+ *
+ * @param item history item to query.
+ *
+ * @return the time in seconds this item was visited.
+ */
 EAPI double            ewk_history_item_time_last_visited_get(const Ewk_History_Item *item);
+/**
+ * Get the icon (aka favicon) associated with this history item.
+ *
+ * @note in order to have this working, one must open icon database
+ *       with ewk_settings_icon_database_path_set().
+ *
+ * @param item history item to query.
+ *
+ * @return the surface reference or @c NULL on errors. Note that the
+ *         reference may be to a standard fallback icon.
+ */
 EAPI cairo_surface_t  *ewk_history_item_icon_surface_get(const Ewk_History_Item *item);
+/**
+ * Add an Evas_Object of type 'image' to given canvas with history item icon.
+ *
+ * This is an utility function that creates an Evas_Object of type
+ * image set to have fill always match object size
+ * (evas_object_image_filled_add()), saving some code to use it from Evas.
+ *
+ * @note in order to have this working, one must open icon database
+ *       with ewk_settings_icon_database_path_set().
+ *
+ * @param item history item to query.
+ * @param canvas evas instance where to add resulting object.
+ *
+ * @return newly allocated Evas_Object instance or @c NULL on
+ *         errors. Delete the object with evas_object_del().
+ */
 EAPI Evas_Object      *ewk_history_item_icon_object_add(const Ewk_History_Item *item, Evas *canvas);
+/**
+ * Query if given item is still in page cache.
+ *
+ * @param item history item to query.
+ *
+ * @return @c EINA_TRUE if in cache, @c EINA_FALSE otherwise.
+ */
 EAPI Eina_Bool         ewk_history_item_page_cache_exists(const Ewk_History_Item *item);
+/**
+ * Query number of times item was visited.
+ *
+ * @param item history item to query.
+ *
+ * @return number of visits.
+ */
 EAPI int               ewk_history_item_visit_count(const Ewk_History_Item *item);
+/**
+ * Query if last visit to item was failure or not.
+ *
+ * @param item history item to query.
+ *
+ * @return @c EINA_TRUE if last visit was failure, @c EINA_FALSE if it
+ *         was fine.
+ */
 EAPI Eina_Bool         ewk_history_item_visit_last_failed(const Ewk_History_Item *item);

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

-                      r91972
+                      r92473
 static Eina_Bool _ewk_init_body(void);
-/**
- * Initializes webkit's instance.
+ *
- * - initializes components needed by Efl,
- * - sets web database location,
- * - sets page cache capacity,
- * - increases a reference count of webkit's instance.
+ *
- * @return a reference count of webkit's instance on success or 0 on failure
- */
 int ewk_init(void)
+{
 …
+}
-/**
- * Decreases a reference count of webkit's instance, possibly destroying it.
+ *
- * If the reference count reaches 0 webkit's instance is destroyed.
+ *
- * @return a reference count of webkit's instance
- */
 int ewk_shutdown(void)
+{

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

-                      r84771
+                      r92473
 #endif
+/**
+ * Initializes webkit's instance.
+ *
+ * - initializes components needed by Efl,
+ * - sets web database location,
+ * - sets page cache capacity,
+ * - increases a reference count of webkit's instance.
+ *
+ * @return a reference count of webkit's instance on success or 0 on failure
+ */
 EAPI int ewk_init(void);
+/**
+ * Decreases a reference count of webkit's instance, possibly destroying it.
+ *
+ * If the reference count reaches 0 webkit's instance is destroyed.
+ *
+ * @return a reference count of webkit's instance
+ */
 EAPI int ewk_shutdown(void);

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

-                      r91972
+                      r92473
 #endif
-/**
- * Sets the given proxy URI to network backend.
+ *
- * @param proxy URI to set.
- */
 void ewk_network_proxy_uri_set(const char *proxy)
+{
 …
+}
-/**
- * Gets the proxy URI from the network backend.
+ *
- * The returned string should be freed by eina_stringshare_del() after use.
+ *
- * @return current proxy URI or @c 0 if it's not set.
- */
 const char *ewk_network_proxy_uri_get(void)
+{
 …
+}
-/**
- * Sets if network backend is online or not.
+ *
- * @param online @c EINA_FALSE if network is disconnected.
- */
 void ewk_network_state_notifier_online_set(Eina_Bool online)
+{

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

-                      r91972
+                      r92473
 #endif
+/**
+ * Sets the given proxy URI to network backend.
+ *
+ * @param proxy URI to set
+ */
 EAPI void             ewk_network_proxy_uri_set(const char *proxy);
+/**
+ * Gets the proxy URI from the network backend.
+ *
+ * The returned string should be freed by eina_stringshare_del() after use.
+ *
+ * @return current proxy URI or @c 0 if it's not set
+ */
 EAPI const char      *ewk_network_proxy_uri_get(void);
+/**
+ * Sets if network backend is online or not.
+ *
+ * @param online @c EINA_FALSE if network is disconnected
+ */
 EAPI void             ewk_network_state_notifier_online_set(Eina_Bool online);

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

-                      r91972
+                      r92473
+}
-/**
- * Returns the default quota for Web Database databases. By default
- * this value is 1MB.
+ *
- * @return the current default database quota in bytes
- */
 uint64_t ewk_settings_web_database_default_quota_get(void)
+{
 …
+}
-/**
- * Sets the current path to the directory WebKit will write Web
- * Database databases.
+ *
- * @param path the new database directory path
- */
 void ewk_settings_web_database_path_set(const char *path)
+{
 …
+}
-/**
- * Returns directory path where web database is stored.
+ *
- * This is guaranteed to be eina_stringshare, so whenever possible
- * save yourself some cpu cycles and use eina_stringshare_ref()
- * instead of eina_stringshare_add() or strdup().
+ *
- * @return database path or @c 0 if none or web database is not supported
- */
 const char *ewk_settings_web_database_path_get(void)
+{
 …
+}
-/**
- * Sets directory where to store icon database, opening or closing database.
+ *
- * Icon database must be opened only once. If you try to set a path when the icon
- * database is already open, this function returns @c EINA_FALSE.
+ *
- * @param directory where to store icon database, must be
- *        write-able, if @c 0 is given, then database is closed
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE on errors
- */
 Eina_Bool ewk_settings_icon_database_path_set(const char *directory)
+{
 …
+}
-/**
- * Returns directory path where icon database is stored.
+ *
- * This is guaranteed to be eina_stringshare, so whenever possible
- * save yourself some cpu cycles and use eina_stringshare_ref()
- * instead of eina_stringshare_add() or strdup().
+ *
- * @return database path or @c 0 if none is set or database is closed
- */
 const char *ewk_settings_icon_database_path_get(void)
+{
 …
+}
-/**
- * Removes all known icons from database.
+ *
- * Database must be opened with ewk_settings_icon_database_path_set()
- * in order to work.
+ *
- * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise, like
- *         closed database.
- */
 Eina_Bool ewk_settings_icon_database_clear(void)
+{
 …
+}
-/**
- * Queries icon for given URL, returning associated cairo surface.
+ *
- * @note In order to have this working, one must open icon database
- *       with ewk_settings_icon_database_path_set().
+ *
- * @param url which url to query icon
+ *
- * @return cairo surface if any, or @c 0 on failure
- */
 cairo_surface_t *ewk_settings_icon_database_icon_surface_get(const char *url)
+{
 …
+}
-/**
- * Creates Evas_Object of type image representing the given URL.
+ *
- * This is an utility function that creates an Evas_Object of type
- * image set to have fill always match object size
- * (evas_object_image_filled_add()), saving some code to use it from Evas.
+ *
- * @note In order to have this working, one must open icon database
- *       with ewk_settings_icon_database_path_set().
+ *
- * @param url which url to query icon
- * @param canvas evas instance where to add resulting object
+ *
- * @return newly allocated Evas_Object instance or @c 0 on
- *         errors. Delete the object with evas_object_del().
- */
 Evas_Object *ewk_settings_icon_database_icon_object_add(const char *url, Evas *canvas)
+{
 …
+}
-/**
- * Gets status of the memory cache of WebCore.
+ *
- * @return @c EINA_TRUE if the cache is enabled or @c EINA_FALSE if not
- */
 Eina_Bool ewk_settings_cache_enable_get(void)
+{
 …
+}
-/**
- * Enables/disables the memory cache of WebCore, possibly clearing it.
+ *
- * Disabling the cache will remove all resources from the cache.
- * They may still live on if they are referenced by some Web page though.
+ *
- * @param set @c EINA_TRUE to enable memory cache, @c EINA_FALSE to disable
- */
 void ewk_settings_cache_enable_set(Eina_Bool set)
+{
 …
+}
-/**
- * Sets capacity of memory cache of WebCore.
+ *
- * WebCore sets default value of memory cache on 8192 * 1024 bytes.
+ *
- * @param capacity the maximum number of bytes that the cache should consume overall
- */
 void ewk_settings_cache_capacity_set(unsigned capacity)
+{
 …
+}
-/**
- * Sets values for repaint throttling.
+ *
- * It allows to slow down page loading and
- * should ensure displaying a content with many css/gif animations.
+ *
- * These values can be used as a example for repaints throttling.
- * 0,     0,   0,    0    - default WebCore's values, these do not delay any repaints
- * 0.025, 0,   2.5,  0.5  - recommended values for dynamic content
- * 0.01,  0,   1,    0.2  - minimal level
- * 0.025, 1,   5,    0.5  - medium level
- * 0.1,   2,   10,   1    - heavy level
+ *
- * @param deferred_repaint_delay a normal delay
- * @param initial_deferred_repaint_delay_during_loading negative value would mean that first few repaints happen without a delay
- * @param max_deferred_repaint_delay_during_loading the delay grows on each repaint to this maximum value
- * @param deferred_repaint_delay_increment_during_loading on each repaint the delay increses by this amount
- */
 void ewk_settings_repaint_throttling_set(double deferred_repaint_delay, double initial_deferred_repaint_delay_during_loading, double max_deferred_repaint_delay_during_loading, double deferred_repaint_delay_increment_during_loading)
+{
 …
+}
-/**
- * Sets cache directory.
+ *
- * @param path where to store cache, must be write-able.
+ *
- * @return @c EINA_TRUE on success, @c EINA_FALSE if path is NULL or offline
- *         web application is not supported.
- */
 Eina_Bool ewk_settings_cache_directory_path_set(const char *path)
+{
 …
+}
-/**
- * Return cache directory path.
+ *
- * This is guaranteed to be eina_stringshare, so whenever possible
- * save yourself some cpu cycles and use eina_stringshare_ref()
- * instead of eina_stringshare_add() or strdup().
+ *
- * @return cache directory path.
- */
 const char *ewk_settings_cache_directory_path_get()
+{

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

-                      r91255
+                      r92473
  */
+/**
+ * Returns the default quota for Web Database databases. By default
+ * this value is 1MB.
+ *
+ * @return the current default database quota in bytes
+ */
 EAPI uint64_t         ewk_settings_web_database_default_quota_get(void);
+/**
+ * Sets the current path to the directory WebKit will write Web
+ * Database databases.
+ *
+ * @param path the new database directory path
+ */
 EAPI void             ewk_settings_web_database_path_set(const char *path);
+/**
+ * Returns directory path where web database is stored.
+ *
+ * This is guaranteed to be eina_stringshare, so whenever possible
+ * save yourself some cpu cycles and use eina_stringshare_ref()
+ * instead of eina_stringshare_add() or strdup().
+ *
+ * @return database path or @c 0 if none or web database is not supported
+ */
 EAPI const char      *ewk_settings_web_database_path_get(void);
+/**
+ * Sets directory where to store icon database, opening or closing database.
+ *
+ * Icon database must be opened only once. If you try to set a path when the icon
+ * database is already open, this function returns @c EINA_FALSE.
+ *
+ * @param directory where to store icon database, must be
+ *        write-able, if @c 0 is given, then database is closed
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE on errors
+ */
 EAPI Eina_Bool        ewk_settings_icon_database_path_set(const char *path);
+/**
+ * Returns directory path where icon database is stored.
+ *
+ * This is guaranteed to be eina_stringshare, so whenever possible
+ * save yourself some cpu cycles and use eina_stringshare_ref()
+ * instead of eina_stringshare_add() or strdup().
+ *
+ * @return database path or @c 0 if none is set or database is closed
+ */
 EAPI const char      *ewk_settings_icon_database_path_get(void);
+/**
+ * Removes all known icons from database.
+ *
+ * Database must be opened with ewk_settings_icon_database_path_set()
+ * in order to work.
+ *
+ * @return @c EINA_TRUE on success or @c EINA_FALSE otherwise, like
+ *         closed database.
+ */
 EAPI Eina_Bool        ewk_settings_icon_database_clear(void);
+/**
+ * Queries icon for given URL, returning associated cairo surface.
+ *
+ * @note In order to have this working, one must open icon database
+ *       with ewk_settings_icon_database_path_set().
+ *
+ * @param url which url to query icon
+ *
+ * @return cairo surface if any, or @c 0 on failure
+ */
 EAPI cairo_surface_t *ewk_settings_icon_database_icon_surface_get(const char *url);
+/**
+ * Creates Evas_Object of type image representing the given URL.
+ *
+ * This is an utility function that creates an Evas_Object of type
+ * image set to have fill always match object size
+ * (evas_object_image_filled_add()), saving some code to use it from Evas.
+ *
+ * @note In order to have this working, one must open icon database
+ *       with ewk_settings_icon_database_path_set().
+ *
+ * @param url which url to query icon
+ * @param canvas evas instance where to add resulting object
+ *
+ * @return newly allocated Evas_Object instance or @c 0 on
+ *         errors. Delete the object with evas_object_del().
+ */
 EAPI Evas_Object     *ewk_settings_icon_database_icon_object_add(const char *url, Evas *canvas);
+/**
+ * Sets cache directory.
+ *
+ * @param path where to store cache, must be write-able.
+ *
+ * @return @c EINA_TRUE on success, @c EINA_FALSE if path is NULL or offline
+ *         web application is not supported.
+ */
 EAPI Eina_Bool        ewk_settings_cache_directory_path_set(const char *path);
+/**
+ * Return cache directory path.
+ *
+ * This is guaranteed to be eina_stringshare, so whenever possible
+ * save yourself some cpu cycles and use eina_stringshare_ref()
+ * instead of eina_stringshare_add() or strdup().
+ *
+ * @return cache directory path.
+ */
 EAPI const char      *ewk_settings_cache_directory_path_get(void);
+/**
+ * Gets status of the memory cache of WebCore.
+ *
+ * @return @c EINA_TRUE if the cache is enabled or @c EINA_FALSE if not
+ */
 EAPI Eina_Bool        ewk_settings_cache_enable_get(void);
+/**
+ * Enables/disables the memory cache of WebCore, possibly clearing it.
+ *
+ * Disabling the cache will remove all resources from the cache.
+ * They may still live on if they are referenced by some Web page though.
+ *
+ * @param set @c EINA_TRUE to enable memory cache, @c EINA_FALSE to disable
+ */
 EAPI void             ewk_settings_cache_enable_set(Eina_Bool set);
+/**
+ * Sets capacity of memory cache of WebCore.
+ *
+ * WebCore sets default value of memory cache on 8192 * 1024 bytes.
+ *
+ * @param capacity the maximum number of bytes that the cache should consume overall
+ */
 EAPI void             ewk_settings_cache_capacity_set(unsigned capacity);
+/**
+ * Sets values for repaint throttling.
+ *
+ * It allows to slow down page loading and
+ * should ensure displaying a content with many css/gif animations.
+ *
+ * These values can be used as a example for repaints throttling.
+ * 0,     0,   0,    0    - default WebCore's values, these do not delay any repaints
+ * 0.025, 0,   2.5,  0.5  - recommended values for dynamic content
+ * 0.01,  0,   1,    0.2  - minimal level
+ * 0.025, 1,   5,    0.5  - medium level
+ * 0.1,   2,   10,   1    - heavy level
+ *
+ * @param deferred_repaint_delay a normal delay
+ * @param initial_deferred_repaint_delay_during_loading negative value would mean that first few repaints happen without a delay
+ * @param max_deferred_repaint_delay_during_loading the delay grows on each repaint to this maximum value
+ * @param deferred_repaint_delay_increment_during_loading on each repaint the delay increses by this amount
+ */
 EAPI void             ewk_settings_repaint_throttling_set(double deferred_repaint_delay, double initial_deferred_repaint_delay_during_loading, double max_deferred_repaint_delay_during_loading, double deferred_repaint_delay_increment_during_loading);

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

-                      r91972
+                      r92473
 };
-/**
- * Decreases the referece count of an Ewk_Window_Features, possibly freeing it.
+ *
- * When the reference count of the object reaches 0, the one is freed.
+ *
- * @param window_features the object to decrease reference count
- */
 void ewk_window_features_unref(Ewk_Window_Features *window_features)
+{
 …
+}
-/**
- * Increases the reference count of an Ewk_Window_Features.
+ *
- * @param window_features the object to increase reference count
- */
 void ewk_window_features_ref(Ewk_Window_Features *window_features)
+{
 …
+}
-/**
- * Gets boolean properties of an Ewk_Window_Features.
+ *
- * Properties are returned in the respective pointers. Passing @c 0 to any of
- * these pointers will make that property to not be returned.
+ *
- * @param window_features the object to get boolean properties
- * @param toolbar_visible the pointer to store if toolbar is visible
- * @param statusbar_visible the pointer to store if statusbar is visible
- * @param scrollbars_visible the pointer to store if scrollbars is visible
- * @param menubar_visible the pointer to store if menubar is visible
- * @param locationbar_visible the pointer to store if locationbar is visible
- * @param fullscreen the pointer to store if fullscreen is enabled
+ *
- * @see ewk_window_features_int_property_get
- */
 void ewk_window_features_bool_property_get(Ewk_Window_Features *window_features, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visible, Eina_Bool *fullscreen)
+{
 …
+}
-/**
- * Gets int properties of an Ewk_Window_Features.
+ *
- * Properties are returned in the respective pointers. Passing @c 0 to any of
- * these pointers will make that property to not be returned.
+ *
- * Make sure to check if the value returned is less than 0 before using it, since in
- * that case it means that property was not set in winwdow_features object.
+ *
- * @param window_features the window's features
- * @param x the pointer to store x position
- * @param y the pointer to store y position
- * @param w the pointer to store width
- * @param h the pointer to store height
+ *
- * @see ewk_window_features_bool_property_get
- */
 void ewk_window_features_int_property_get(Ewk_Window_Features *window_features, int *x, int *y, int *w, int *h)
+{

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

-                      r91972
+                      r92473
 typedef struct _Ewk_Window_Features Ewk_Window_Features;
+/**
+ * Decreases the referece count of an Ewk_Window_Features, possibly freeing it.
+ *
+ * When the reference count of the object reaches 0, the one is freed.
+ *
+ * @param window_features the object to decrease reference count
+ */
 EAPI void         ewk_window_features_unref(Ewk_Window_Features *window_features);
+/**
+ * Increases the reference count of an Ewk_Window_Features.
+ *
+ * @param window_features the object to increase reference count
+ */
 EAPI void         ewk_window_features_ref(Ewk_Window_Features *window_features);
+/**
+ * Gets boolean properties of an Ewk_Window_Features.
+ *
+ * Properties are returned in the respective pointers. Passing @c 0 to any of
+ * these pointers will make that property to not be returned.
+ *
+ * @param window_features the object to get boolean properties
+ * @param toolbar_visible the pointer to store if toolbar is visible
+ * @param statusbar_visible the pointer to store if statusbar is visible
+ * @param scrollbars_visible the pointer to store if scrollbars is visible
+ * @param menubar_visible the pointer to store if menubar is visible
+ * @param locationbar_visible the pointer to store if locationbar is visible
+ * @param fullscreen the pointer to store if fullscreen is enabled
+ *
+ * @see ewk_window_features_int_property_get
+ */
 EAPI void         ewk_window_features_bool_property_get(Ewk_Window_Features *window_features, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visible, Eina_Bool *fullscreen);
+/**
+ * Gets int properties of an Ewk_Window_Features.
+ *
+ * Properties are returned in the respective pointers. Passing @c 0 to any of
+ * these pointers will make that property to not be returned.
+ *
+ * Make sure to check if the value returned is less than 0 before using it, since in
+ * that case it means that property was not set in winwdow_features object.
+ *
+ * @param window_features the window's features
+ * @param x the pointer to store x position
+ * @param y the pointer to store y position
+ * @param w the pointer to store width
+ * @param h the pointer to store height
+ *
+ * @see ewk_window_features_bool_property_get
+ */
 EAPI void         ewk_window_features_int_property_get(Ewk_Window_Features *window_features, int *x, int *y, int *w, int *h);

Context Navigation

Changeset 92473 in webkit

Legend:

trunk/Source/WebKit/efl/ChangeLog

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Download in other formats: