[Qgis-developer] Time for 1.0 API freeze

[Martin Dobias]

On Sun, Nov 16, 2008 at 11:22 PM, Tim Sutton <tim at linfiniti.com> wrote:
> Hi Folks
>
> I'd like to go ahead and declare an API freeze for QGIS 1.0. Martin I
> see you were making a couple of useful tweaks over last week. Do you or
> anyone else have anything else to change on the API.

Hi Tim,
I've been doing some tweaks only when I stumble across something, but
nothing really systematical. I think we can put a fixed date for API
freeze, let's say November 20th?


> Once the API is
> frozen, cleanups to the API should be done in a manner similar to the
> trolls e.g.
>
>
> class Foo
> {
>  public:
>     /** This method will be deprecated, you are encouraged to use
>         doSomethingBetter() rather.
>         @see doSomethingBetter()
>     */
>     bool doSomething();
>
>     /** Does something a better way.
>         @note This method was introduced in QGIS version 1.1
>     */
>     bool doSomethingBetter();
>
> }

I've been thinking also about more complex changes in QGIS v1.x
without breaking API. My idea is that if we do some BIG changes, the
resulting class can be named differently, e.g. with "Qgs2" prefix and
older class can be implemented using this new class. With this
approach we can do bigger enhancements in core/gui libraries without
breaking API.

What do others think about this policy?

Martin