[Github-comments] [geany] Proxy plugins (#629)

[elextr]

> +
> +	plugin->proxy_funcs->probe  = demoproxy_probe;
> +	plugin->proxy_funcs->load   = demoproxy_load;
> +	plugin->proxy_funcs->unload = demoproxy_unload;
> +
> +	return geany_plugin_register_proxy(plugin, extensions);
> +}
> +
> + at endcode
> +
> +The callback functions deserve a closer look.
> +
> +As already mentioned the file format includes a magic first line which must be present.
> +GeanyProxyFuncs::probe() verifies that it's present and avoids showing the sub-plugin in the
> +Plugin Manager if not.
> +

As a general comment, I got confused which functionalities are part of Geany, and which are part of the proxy because the language says a function "does something" making it sound like it exists and so is part of Geany, rather than "must do something" which states a requirement for the proxy.  So the above sentence should read:

"GeanyProxyFuncs::probe() should verify that the correct identification is present and return `false` so Geany avoids showing the sub-plugin in the Plugin Manager."

That way its clear what the callback function does and what Geany does.

This applies in other places as well.


---
Reply to this email directly or view it on GitHub:
https://github.com/geany/geany/pull/629/files#r40382165
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.geany.org/pipermail/github-comments/attachments/20150924/5ca41876/attachment.html>