Re: [E-devel] [patch] elementary: doxygen doc fixes
On 05/29/12 14:36, Jonas M. Gastal wrote: On Tuesday 29 May 2012 11:43:19 Jérôme Pinot wrote: Hi, Here is a patch to fix elementary doxygen doc: - #link on the beginning of a new line does give ugly output: http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png - some typos - some missing @c - in elm_web, convert remaining @li parameter lists to @param - minor random fixes This patch apply to trunk and elementary-1.0 branch. Jérôme, Did you take the screenshot from the online docs or from documentation generated on your machine? I ask because I only ever saw that problem with doxygen versions newer than the one on e2, and for those versions the # is unneeded, it makes links regardless. To be clear, I'm not complaining about your patch, it seems to make things work for both newer and older versions which is great, I'm just looking to know if the formatting problem is present on older doxygen versions. Seems it was really a bug in Doxygen which was fixed in Doxygen 1.8.1. We should not worry anymore about where we put the #link. Gastal. -- Jérôme Pinot http://ngc891.blogdns.net/ signature.asc Description: Digital signature -- Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/___ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
Re: [E-devel] [patch] elementary: doxygen doc fixes
On Wed, 30 May 2012 08:43:03 +0900 Jérôme Pinot ngc...@gmail.com said: On 05/29/12 14:36, Jonas M. Gastal wrote: On Tuesday 29 May 2012 11:43:19 Jérôme Pinot wrote: Hi, Here is a patch to fix elementary doxygen doc: - #link on the beginning of a new line does give ugly output: http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png - some typos - some missing @c - in elm_web, convert remaining @li parameter lists to @param - minor random fixes This patch apply to trunk and elementary-1.0 branch. Jérôme, Did you take the screenshot from the online docs or from documentation generated on your machine? I ask because I only ever saw that problem with doxygen versions newer than the one on e2, and for those versions the # is unneeded, it makes links regardless. I got the problem on my box, with Doxygen 1.8.0, and I don't remember having seen this problem before the upgrade. To be clear, I'm not complaining about your patch, it seems to make things work for both newer and older versions which is great, That's why I sent it. I'm just looking to know if the formatting problem is present on older doxygen versions. Gastal. BTW, do you think this kind of small doc fixes worth backporting as I did yesterday? i'm not 100% sure on that. i think there is value, but not as much as bug fixes :) -- - Codito, ergo sum - I code, therefore I am -- The Rasterman (Carsten Haitzler)ras...@rasterman.com -- Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ ___ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
Re: [E-devel] [patch] elementary: doxygen doc fixes
On Tue, 29 May 2012 11:58:50 +0900 Cedric BAIL cedric.b...@free.fr said: Hey, On Tue, May 29, 2012 at 11:43 AM, Jérôme Pinot ngc...@gmail.com wrote: Here is a patch to fix elementary doxygen doc: - #link on the beginning of a new line does give ugly output: http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png - some typos - some missing @c - in elm_web, convert remaining @li parameter lists to @param - minor random fixes This patch apply to trunk and elementary-1.0 branch. You series of patch are always good and get directly to svn. Maybe you should just send me your ssh public key with an info.txt so I can setup a svn account for you. why not? the french cabal here isn't big enough. we need more of these french types messing around in svn! :-P :) -- - Codito, ergo sum - I code, therefore I am -- The Rasterman (Carsten Haitzler)ras...@rasterman.com -- Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ ___ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
Re: [E-devel] [patch] elementary: doxygen doc fixes
On 05/29/12 14:36, Jonas M. Gastal wrote: On Tuesday 29 May 2012 11:43:19 Jérôme Pinot wrote: Hi, Here is a patch to fix elementary doxygen doc: - #link on the beginning of a new line does give ugly output: http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png - some typos - some missing @c - in elm_web, convert remaining @li parameter lists to @param - minor random fixes This patch apply to trunk and elementary-1.0 branch. Jérôme, Did you take the screenshot from the online docs or from documentation generated on your machine? I ask because I only ever saw that problem with doxygen versions newer than the one on e2, and for those versions the # is unneeded, it makes links regardless. I got the problem on my box, with Doxygen 1.8.0, and I don't remember having seen this problem before the upgrade. To be clear, I'm not complaining about your patch, it seems to make things work for both newer and older versions which is great, That's why I sent it. I'm just looking to know if the formatting problem is present on older doxygen versions. Gastal. BTW, do you think this kind of small doc fixes worth backporting as I did yesterday? -- Jérôme Pinot http://ngc891.blogdns.net/ signature.asc Description: Digital signature -- Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/___ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
[E-devel] [patch] elementary: doxygen doc fixes
Hi,
Here is a patch to fix elementary doxygen doc:
- #link on the beginning of a new line does give ugly output:
http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png
- some typos
- some missing @c
- in elm_web, convert remaining @li parameter lists to @param
- minor random fixes
This patch apply to trunk and elementary-1.0 branch.
--
Jérôme Pinot
http://ngc891.blogdns.net/
Index: src/lib/elm_genlist.h
===
--- src/lib/elm_genlist.h (revision 71484)
+++ src/lib/elm_genlist.h (working copy)
@@ -57,8 +57,8 @@
* existing (content) swallow parts in the Edje group implementing the item's
* theme. It must return @c NULL, when no content is desired, or a valid
* object handle, otherwise. The object will be deleted by the genlist on
- * its deletion or when the item is unrealized. See
- * #Elm_Genlist_Item_Content_Get_Cb.
+ * its deletion or when the item is unrealized.
+ * See #Elm_Genlist_Item_Content_Get_Cb.
* - @c func.state_get - The @c part parameter is the name string of one of
* the state parts in the Edje group implementing the item's theme. Return
* @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
@@ -120,15 +120,14 @@
* the applications internal data (eg. the struct with the original item
* data). The parent parameter is the parent genlist item this belongs to if
* it is a tree or an indexed group, and NULL if there is no parent. The
- * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
- * #ELM_GENLIST_ITEM_TREE and #ELM_GENLIST_ITEM_GROUP. If
- * #ELM_GENLIST_ITEM_TREE is set then this item is displayed as an item
- * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
- * is set then this item is group index item that is displayed at the top
- * until the next group comes. The func parameter is a convenience callback
- * that is called when the item is selected and the data parameter will be
- * the func_data parameter, obj be the genlist object and event_info will be
- * the genlist item.
+ * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE, #ELM_GENLIST_ITEM_TREE
+ * and #ELM_GENLIST_ITEM_GROUP. If #ELM_GENLIST_ITEM_TREE is set then this
+ * item is displayed as an item that is able to expand and have child items.
+ * If #ELM_GENLIST_ITEM_GROUP is set then this item is group index item that
+ * is displayed at the top until the next group comes. The func parameter is
+ * a convenience callback that is called when the item is selected and the
+ * data parameter will be the func_data parameter, @c obj be the genlist
+ * object and event_info will be the genlist item.
*
* elm_genlist_item_append() adds an item to the end of the list, or if
* there is a parent, to the end of all the child items of the parent.
@@ -792,11 +791,10 @@
*
* This sets the scrollbar visibility policy for the given genlist
* scroller. #ELM_SCROLLER_POLICY_AUTO means the scrollbar is
- * made visible if it is needed, and otherwise kept hidden.
- * #ELM_SCROLLER_POLICY_ON turns it on all the time, and
- * #ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
- * respectively for the horizontal and vertical scrollbars. Default is
- * #ELM_SCROLLER_POLICY_AUTO
+ * made visible if it is needed, and otherwise kept hidden.
#ELM_SCROLLER_POLICY_ON
+ * turns it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
+ * This applies respectively for the horizontal and vertical scrollbars.
+ * Default is #ELM_SCROLLER_POLICY_AUTO
*
* @see elm_genlist_scroller_policy_get()
*
Index: src/lib/elm_map.h
===
--- src/lib/elm_map.h (revision 71484)
+++ src/lib/elm_map.h (working copy)
@@ -131,7 +131,7 @@
typedef enum
{
ELM_MAP_ROUTE_METHOD_FASTEST, /** Route should prioritize time. */
- ELM_MAP_ROUTE_METHOD_SHORTEST, /** Route should prioritized distance. */
+ ELM_MAP_ROUTE_METHOD_SHORTEST, /** Route should prioritize distance. */
ELM_MAP_ROUTE_METHOD_LAST
} Elm_Map_Route_Method;
@@ -217,9 +217,8 @@
*
* By default these values are 0 (world map) and 18 (maximum zoom).
*
- * This function should be used when zoom mode is set to
- * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
- * with elm_map_zoom_mode_set().
+ * This function should be used when zoom mode is set to
#ELM_MAP_ZOOM_MODE_MANUAL.
+ * This is the default mode, and can be set with elm_map_zoom_mode_set().
*
* @see elm_map_zoom_mode_set()
* @see elm_map_zoom_get()
@@ -250,9 +249,8 @@
* Set the zoom mode used by the map object.
*
* @param obj The map object.
- * @param mode The zoom mode of the map, being it one of
- * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
- * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
+ * @param mode The zoom mode of the map, being it one of
#ELM_MAP_ZOOM_MODE_MANUAL
+ * (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT, or
Re: [E-devel] [patch] elementary: doxygen doc fixes
Hey, On Tue, May 29, 2012 at 11:43 AM, Jérôme Pinot ngc...@gmail.com wrote: Here is a patch to fix elementary doxygen doc: - #link on the beginning of a new line does give ugly output: http://ngc891.blogdns.net/pub/projects/debug/doxygen-formating-eww.png - some typos - some missing @c - in elm_web, convert remaining @li parameter lists to @param - minor random fixes This patch apply to trunk and elementary-1.0 branch. You series of patch are always good and get directly to svn. Maybe you should just send me your ssh public key with an info.txt so I can setup a svn account for you. Anyway, I will apply this latest patch. -- Cedric BAIL -- Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ ___ enlightenment-devel mailing list enlightenment-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
