Hi, 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 <some_num> found /tmp/ecore/doc/examples.dox:1174: warning: Unsupported xml/html tag <some_path> found /tmp/ecore/doc/examples.dox:1176: warning: Unsupported xml/html tag <some_num> 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 <empty> 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. -- Jérôme Pinot http://ngc891.blogdns.net/
Index: ecore/doc/examples.dox =================================================================== --- ecore/doc/examples.dox (revision 69808) +++ ecore/doc/examples.dox (working copy) @@ -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 <some_num> maximum number of threads to run at the same time. - * @li -p <some_path> adds @c some_path to the list used by the feedback jobs. + * @li -t \<some_num\> maximum number of threads to run at the same time. + * @li -p \<some_path\> adds @c some_path to the list used by the feedback jobs. * This parameter can be used multiple times. - * @li -m <some_num> the number of messages to process before the program is + * @li -m \<some_num\> the number of messages to process before the program is * signalled to exit. * * Skipping some bits, we init Ecore and our application data. Index: ecore/src/lib/ecore_con/Ecore_Con.h =================================================================== --- ecore/src/lib/ecore_con/Ecore_Con.h (revision 69808) +++ ecore/src/lib/ecore_con/Ecore_Con.h (working copy) @@ -1359,6 +1359,7 @@ /** * 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 Index: ecore/src/lib/ecore_con/ecore_con_ssl.c =================================================================== --- ecore/src/lib/ecore_con/ecore_con_ssl.c (revision 69808) +++ ecore/src/lib/ecore_con/ecore_con_ssl.c (working copy) @@ -717,6 +717,7 @@ * 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. Index: ecore/src/lib/ecore_x/xcb/ecore_xcb_damage.c =================================================================== --- ecore/src/lib/ecore_x/xcb/ecore_xcb_damage.c (revision 69808) +++ ecore/src/lib/ecore_x/xcb/ecore_xcb_damage.c (working copy) @@ -129,7 +129,7 @@ * Synchronously modifies the regions in the following manner: * If @p repair is @c XCB_NONE: * 1) parts = damage - * 2) damage = <empty> + * 2) damage = \<empty\> * Otherwise: * 1) parts = damage INTERSECT repair * 2) damage = damage - parts Index: ecore/src/lib/ecore_evas/Ecore_Evas.h =================================================================== --- ecore/src/lib/ecore_evas/Ecore_Evas.h (revision 69808) +++ ecore/src/lib/ecore_evas/Ecore_Evas.h (working copy) @@ -531,7 +531,7 @@ * @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.
signature.asc
Description: Digital signature
------------------------------------------------------------------------------ This SF email is sponsosred by: Try Windows Azure free for 90 days Click Here http://p.sf.net/sfu/sfd2d-msazure
_______________________________________________ enlightenment-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
