Changeset 80352 in webkit


Ignore:
Timestamp:
Mar 4, 2011 7:59:04 AM (13 years ago)
Author:
commit-queue@webkit.org
Message:

2011-03-04 Grzegorz Czajkowski <​g.czajkowski@samsung.com>

Reviewed by Kent Tamura.

[EFL] Doxygen documentation for ewk_settings
​https://bugs.webkit.org/show_bug.cgi?id=55667

  • ewk/ewk_settings.cpp: (ewk_settings_default_user_agent_get): only style is fixed
  • ewk/ewk_settings.h:
Location:
trunk/Source/WebKit/efl
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/Source/WebKit/efl/ChangeLog

    r80299 r80352  
     12011-03-04  Grzegorz Czajkowski  <g.czajkowski@samsung.com>
     2
     3        Reviewed by Kent Tamura.
     4
     5        [EFL] Doxygen documentation for ewk_settings
     6        https://bugs.webkit.org/show_bug.cgi?id=55667
     7
     8        * ewk/ewk_settings.cpp:
     9        (ewk_settings_default_user_agent_get): only style is fixed
     10        * ewk/ewk_settings.h:
     11
    1122011-03-03  Brady Eidson  <beidson@apple.com>
    213

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

    r80299 r80352  
    8181 *
    8282 * @return the current default database quota in bytes
    83  **/
     83 */
    8484uint64_t ewk_settings_web_database_default_quota_get()
    8585{
    … …  
    9191 * Database databases.
    9292 *
    93  * @path: the new database directory path
    94  *
     93 * @param path the new database directory path
    9594 */
    9695void ewk_settings_web_database_path_set(const char *path)
    … …  
    108107
    109108/**
    110  * Return directory path where web database is stored.
    111  *
    112  * @return database path or NULL if none or web database is not supported.
    113  *         This is guaranteed to be eina_stringshare, so whenever possible
    114  *         save yourself some cpu cycles and use
    115  *         eina_stringshare_ref() instead of eina_stringshare_add() or
    116  *         strdup().
     109 * Returns directory path where web database is stored.
     110 *
     111 * This is guaranteed to be eina_stringshare, so whenever possible
     112 * save yourself some cpu cycles and use eina_stringshare_ref()
     113 * instead of eina_stringshare_add() or strdup().
     114 *
     115 * @return database path or @c 0 if none or web database is not supported
    117116 */
    118117const char *ewk_settings_web_database_path_get()
    … …  
    126125
    127126/**
    128  * Sets directory where to store icon database, opening database.
     127 * Sets directory where to store icon database, opening or closing database.
    129128 *
    130129 * @param directory where to store icon database, must be
    131  *        write-able. If @c NULL is given, then database is closed.
    132  *
    133  * @return @c EINA_TRUE on success, @c EINA_FALSE on errors.
     130 *        write-able, if @c 0 is given, then database is closed
     131 *
     132 * @return @c EINA_TRUE on success, @c EINA_FALSE on errors
    134133 */
    135134Eina_Bool ewk_settings_icon_database_path_set(const char *directory)
    … …  
    174173
    175174/**
    176  * Return directory path where icon database is stored.
    177  *
    178  * @return database path or @c NULL if none is set or database is closed.
    179  *         This is guaranteed to be eina_stringshare, so whenever possible
    180  *         save yourself some cpu cycles and use
    181  *         eina_stringshare_ref() instead of eina_stringshare_add() or
    182  *         strdup().
     175 * Returns directory path where icon database is stored.
     176 *
     177 * This is guaranteed to be eina_stringshare, so whenever possible
     178 * save yourself some cpu cycles and use eina_stringshare_ref()
     179 * instead of eina_stringshare_add() or strdup().
     180 *
     181 * @return database path or @c 0 if none is set or database is closed
    183182 */
    184183const char* ewk_settings_icon_database_path_get(void)
    … …  
    193192
    194193/**
    195  * Remove all known icons from database.
     194 * Removes all known icons from database.
    196195 *
    197196 * Database must be opened with ewk_settings_icon_database_path_set()
    … …  
    213212
    214213/**
    215  * Query icon for given URL, returning associated cairo surface.
    216  *
    217  * @note in order to have this working, one must open icon database
     214 * Queries icon for given URL, returning associated cairo surface.
     215 *
     216 * @note In order to have this working, one must open icon database
    218217 *       with ewk_settings_icon_database_path_set().
    219218 *
    220  * @param url which url to query icon.
    221  *
    222  * @return cairo surface if any, or NULL on failure.
     219 * @param url which url to query icon
     220 *
     221 * @return cairo surface if any, or @c 0 on failure
    223222 */
    224223cairo_surface_t* ewk_settings_icon_database_icon_surface_get(const char *url)
    … …  
    238237
    239238/**
    240  * Create Evas_Object of type image representing the given URL.
     239 * Creates Evas_Object of type image representing the given URL.
    241240 *
    242241 * This is an utility function that creates an Evas_Object of type
    … …  
    244243 * (evas_object_image_filled_add()), saving some code to use it from Evas.
    245244 *
    246  * @note in order to have this working, one must open icon database
     245 * @note In order to have this working, one must open icon database
    247246 *       with ewk_settings_icon_database_path_set().
    248247 *
    249  * @param url which url to query icon.
    250  * @param canvas evas instance where to add resulting object.
    251  *
    252  * @return newly allocated Evas_Object instance or @c NULL on
     248 * @param url which url to query icon
     249 * @param canvas evas instance where to add resulting object
     250 *
     251 * @return newly allocated Evas_Object instance or @c 0 on
    253252 *         errors. Delete the object with evas_object_del().
    254253 */
    … …  
    274273 * Sets the given proxy URI to network backend.
    275274 *
    276  * @param proxy URI.
     275 * @param proxy URI to set
    277276 */
    278277void ewk_settings_proxy_uri_set(const char* proxy)
    … …  
    300299 * Gets the proxy URI from the network backend.
    301300 *
    302  * @return current proxy URI or @c 0 if it's not set.
     301 * @return current proxy URI or @c 0 if it's not set
    303302 */
    304303const char* ewk_settings_proxy_uri_get()
    … …  
    322321
    323322/**
    324 * @internal
    325 * Gets the default user agent string.
    326 *
    327 * @return A pointer to an eina_stringshare containing the user agent string.
    328 */
     323 * @internal
     324 *
     325 * Gets the default user agent string.
     326 *
     327 * @return a pointer to an eina_stringshare containing the user agent string
     328 */
    329329const char* ewk_settings_default_user_agent_get()
    330330{
    … …  
    333333
    334334    return eina_stringshare_add(static_ua.utf8().data());
    335 } 
     335}

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

    r77243 r80352  
    3333
    3434/**
    35  * @file
     35 * @file ewk_settings.h
    3636 *
    37  * General purpose settings, not tied to any view object.
     37 * @brief General purpose settings, not tied to any view object.
    3838 */
    3939
Note: See TracChangeset for help on using the changeset viewer.