From: raster Date: Sat, 31 Mar 2012 12:03:05 +0000 (+0000) Subject: From: Jérôme Pinot X-Git-Tag: build/2012-07-04.173327~235 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5edc0c403b5e45c7ddb882de24334af38815c40c;p=profile%2Fivi%2Fecore.git From: Jérôme Pinot Subject: [E-devel] [patch] ecore doxygen doc Here is a patch to correct some problems in ecore doxygen doc. It fixes: /tmp/ecore/doc/examples.dox:1173: warning: Unsupported xml/html tag found /tmp/ecore/doc/examples.dox:1174: warning: Unsupported xml/html tag found /tmp/ecore/doc/examples.dox:1176: warning: Unsupported xml/html tag found /tmp/ecore/src/lib/ecore_con/ecore_con_ssl.c:714: warning: The following parameters of ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, const char *key_file) are not documented: parameter 'svr' /tmp/ecore/src/lib/ecore_con/Ecore_Con.h:1360: warning: The following parameters of ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version) are not documented: parameter 'url_con' /tmp/ecore/src/lib/ecore_evas/Ecore_Evas.h:530: warning: argument 'demand_attention' of command @param is not found in the argument list of ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand) /tmp/ecore/src/lib/ecore_evas/Ecore_Evas.h:530: warning: The following parameters of ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand) are not documented: parameter 'demand' /tmp/ecore/src/lib/ecore_x/xcb/ecore_xcb_damage.c:129: warning: Unsupported xml/html tag found There are more things to fix due to API change but it's not so obvious for me. I will first continue to check/correct trivial things in the others efl doxygen doc. git-svn-id: http://svn.enlightenment.org/svn/e/trunk/ecore@69820 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- diff --git a/doc/examples.dox b/doc/examples.dox index f1064fa..469c36b 100644 --- a/doc/examples.dox +++ b/doc/examples.dox @@ -1170,10 +1170,10 @@ * The main function does some setup that includes reading parameters from * the command line to change its behaviour and test different results. * These are: - * @li -t maximum number of threads to run at the same time. - * @li -p adds @c some_path to the list used by the feedback jobs. + * @li -t \ maximum number of threads to run at the same time. + * @li -p \ adds @c some_path to the list used by the feedback jobs. * This parameter can be used multiple times. - * @li -m the number of messages to process before the program is + * @li -m \ the number of messages to process before the program is * signalled to exit. * * Skipping some bits, we init Ecore and our application data. diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index d0ca6f6..e6c65d4 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -1359,6 +1359,7 @@ typedef enum _Ecore_Con_Url_Http_Version /** * Change the HTTP version used for the request + * @param url_con Connection object through which the request will be sent. * @param version The version to be used * @return EINA_TRUE on success, EINA_FALSE on failure to change version * @since 1.2 diff --git a/src/lib/ecore_con/ecore_con_ssl.c b/src/lib/ecore_con/ecore_con_ssl.c index cd8b9c6..2887996 100644 --- a/src/lib/ecore_con/ecore_con_ssl.c +++ b/src/lib/ecore_con/ecore_con_ssl.c @@ -717,6 +717,7 @@ ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, * Use this function to add a SSL PEM private key * Simply specify the key file here to use it in the server object for connecting or listening. * If there is an error loading the key, an error will automatically be logged. + * @param svr The server object * @param key_file The path to the key file. * @return EINA_FALSE if the file cannot be loaded, * otherwise EINA_TRUE. diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 84f5345..75bdfc3 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -531,7 +531,7 @@ EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); * @brief Set the "i demand attention" flag on a canvas window * * @param ee The Ecore_Evas - * @param demand_attention The flag state to set + * @param demand The flag state to set * * A window may demand attention now (eg you must enter a password before * continuing), and so it may flag a window with this. diff --git a/src/lib/ecore_x/xcb/ecore_xcb_damage.c b/src/lib/ecore_x/xcb/ecore_xcb_damage.c index bbab308..deb3b9c 100644 --- a/src/lib/ecore_x/xcb/ecore_xcb_damage.c +++ b/src/lib/ecore_x/xcb/ecore_xcb_damage.c @@ -129,7 +129,7 @@ ecore_x_damage_free(Ecore_X_Damage damage) * Synchronously modifies the regions in the following manner: * If @p repair is @c XCB_NONE: * 1) parts = damage - * 2) damage = + * 2) damage = \ * Otherwise: * 1) parts = damage INTERSECT repair * 2) damage = damage - parts