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

Nick Treleaven nick.treleaven at xxxxx
Thu Apr 21 13:14:14 UTC 2011


On Thu, 14 Apr 2011 00:19:24 +0200
Colomban Wendling <lists.ban at herbesfolles.org> wrote:

> 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.
> 
> Why I am starting this discussion is to know what the core developers
> think of it (Nick, Enrico?), and whether the plugin developers thinks
> it's useful for them or not.
> So all, what do you think?

I think it duplicates information too much. There could be a lookup
table for Geany version -> API number instead.

Regards,
Nick



More information about the Devel mailing list