[Geany-devel] Improving plugin API @since information?

[Colomban Wendling]

Le 17/04/2011 16:01, Enrico Tröger a écrit :
> On Thu, 14 Apr 2011 00:19:24 +0200, Colomban wrote:
> 
>> Hi all,
>>
>> I'm thinking about adding an extra information to "since" tag of the
>> plugin API documentation.
>> It currently only gives the Geany version the symbol appeared on, but
>> generally the developer also need to know the plugin API version in
>> which it was introduced, e.g. in order to get the API requirement
>> right.
>>
>> So, I'm suggesting to add this information whenever we add a new plugin
>> API function (and why not update the current doc when we can), e.g.:
>>
>>  @since 0.21 (API 206)
>>
>> or whatever format we prefer.
> 
> I'd say why not.
> It doesn't hurt. I don't find it totally necessary as plugin developers
> always should depend on the latest available API version of the current
> development version of Geany if they use any new features. Still, it's
> only a bit more information and so why not.

My thought was that some plugin authors may want their plugin to work
with the oldest Geany version that provides the API they actually use.
And to do this, they need to *know* what API version they actually use,
so in which one a function or another was introduced.

> About the format:
> I'd say:
> 
>  * @since 0.21 (GEANY_API_VERSION 209)
> 
> I used this for now in SVN r5727.

Why not, it at least is very clear :)

Cheers,
Colomban