[Geany-devel] Minor problems with plugin API docs

Matthew Brush mbrush at xxxxx
Sat Aug 27 23:29:02 UTC 2011


There's some stuff in the plugin API docs that are documented but 
provide no functionality.  There's also some stuff that's used by 
plugins, which is not documented.

One example is support.h.  This shows up in the plugin API, yet there is 
nothing available in it.

Another example is GeanyFilePrefs, where the struct is documented in the 
API, but no members are documented.  There are some plugins using 
members of this, despite them not being documented (ex. 
ao_blanklines.c:67), so maybe we should put them into the documented API.

IMO, if a file has no "public" functions or a struct has no "public" 
members, these should not show up in the API docs *at all*, otherwise 
it's a little confusing what's available and what's just not documented 

Any thoughts?

Matthew Brush

More information about the Devel mailing list