> It is confusing the way function pointers that are members of struct > PluginExtension are referred to as eg "_perform() function". They are not > functions, they are function pointers with specific member names that end in > _perform and _provided, the functions they point to are in the plugin and can > have any name. You know what you mean and after some confusion I think I now > know what you mean, so it would be best to fix it to use proper terminology > so future readers don't go through the same confusion.
That's technically right but it depends on what level of abstraction you use when describing this interface. If we used e.g. Java, `PluginExtension` would be an interface and the extensions themselves classes (or objects of these classes) that implement this interface. The fact that we are using C requires certain implementation details but I'm not sure if we have to describe all that. I think everyone wanting to implement this interface will understand it and I don't think that instead of "function" saying something like "pointer inside the structure which is assigned a function" everywhere will contribute to better understanding of the interface. > IIUC when it says "_provided() function" it should be "the function pointed > to by the XXXX_provided member". Yes its longer but one global replace should > get most of them. I'll have a look at the places this is mentioned, if there's not too many of them, I'll just add "ending with" before them. -- Reply to this email directly or view it on GitHub: https://github.com/geany/geany/pull/3849#issuecomment-2186789261 You are receiving this because you are subscribed to this thread. Message ID: <geany/geany/pull/3849/[email protected]>
