2014-03-02 21:07 GMT+01:00 Tom Hacohen <t...@stosb.com>:

> Hey,
>
> I think this is unneeded as the information it'll provide is redundant.
> Doxygen documentation already includes the @deprecated (and added API,
> using @since). It's possible to get it from the docs. I don't think it's
> needed in the commit message as well.


> Since I consider @feature and @fix very important, I'd rather not overwhelm
> people with a whole set of things, and start it one step at a time.
>
> In conclusion: I think we should consider these tags in the future (1.11),
> but not overwhelm people for 1.10.
>

I will then push for this again after 1.10, as I consider this very
important for 2 reason:

1. my mental sanity when I need to find out what has been added/deprecated
and need to be implemented in the bindings

2. will help to spot in time bad designed api, for example in 1.9 we added:
elm_win_wm_rotation_manual_rotation_done_set()
elm_win_wm_rotation_manual_rotation_done_get()
elm_win_wm_rotation_manual_rotation_done()

This is a bad designed api as rotation_done is a property and a function at
the same time.



>
> --
> Tom.
>
>
> On Sat, Mar 1, 2014 at 6:54 PM, Davide Andreoli <d...@gurumeditation.it
> >wrote:
>
> > Hi all,
> > I just finished now to port all the API additions of efl 1.9 to the
> python
> > bindings,
> > it has been quite a hell to go through all the commits to search what has
> > been added and what has been deprecated.
> >
> > So I'm going to propose/ask two more tags for commit messages: @api and
> > @deprecated
> >
> > Usage example for a commit where you added 2 new api and deprecate one:
> >
> > @api Elm_Object_Item *elm_object_focused_item_get(const Evas_Object
> *obj);
> > @api void elm_object_item_focus_set(Elm_Object_Item *it, Eina_Bool
> > focused);
> > @deprecated elm_object_old_function_name(params...);
> >
> > This has also the advantage to clarify to all the readers what has been
> > added at the api level so that we can spot earlier bad designed names and
> > params.
> >
> > The @api tags should also be used for added signals, example:
> > @api elm_button: "item,unfocused"
> >
> > Like the idea?
> > davemds
> >
> >
> ------------------------------------------------------------------------------
> > Flow-based real-time traffic analytics software. Cisco certified tool.
> > Monitor traffic, SLAs, QoS, Medianet, WAAS etc. with NetFlow Analyzer
> > Customize your own dashboards, set traffic alerts and generate reports.
> > Network behavioral analysis & security monitoring. All-in-one tool.
> >
> >
> http://pubads.g.doubleclick.net/gampad/clk?id=126839071&iu=/4140/ostg.clktrk
> > _______________________________________________
> > enlightenment-devel mailing list
> > enlightenment-devel@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
> >
>
> ------------------------------------------------------------------------------
> Flow-based real-time traffic analytics software. Cisco certified tool.
> Monitor traffic, SLAs, QoS, Medianet, WAAS etc. with NetFlow Analyzer
> Customize your own dashboards, set traffic alerts and generate reports.
> Network behavioral analysis & security monitoring. All-in-one tool.
>
> http://pubads.g.doubleclick.net/gampad/clk?id=126839071&iu=/4140/ostg.clktrk
> _______________________________________________
> enlightenment-devel mailing list
> enlightenment-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
>
------------------------------------------------------------------------------
Subversion Kills Productivity. Get off Subversion & Make the Move to Perforce.
With Perforce, you get hassle-free workflows. Merge that actually works. 
Faster operations. Version large binaries.  Built-in WAN optimization and the
freedom to use Git, Perforce or both. Make the move to Perforce.
http://pubads.g.doubleclick.net/gampad/clk?id=122218951&iu=/4140/ostg.clktrk
_______________________________________________
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to