Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Nick Treleaven
On 26/05/2014 01:23, Lex Trotman wrote: If we moved to having public headers that just included actual public symbols, I think it would be advantageous to have those headers totally commented/documented rather than requiring the user to download Geany's source code and cross-reference functions

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Matthew Brush
On 14-05-29 05:56 AM, Nick Treleaven wrote: On 26/05/2014 01:23, Lex Trotman wrote: If we moved to having public headers that just included actual public symbols, I think it would be advantageous to have those headers totally commented/documented rather than requiring the user to download

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Lex Trotman
On 30 May 2014 00:46, Matthew Brush mbr...@codebrainz.ca wrote: On 14-05-29 05:56 AM, Nick Treleaven wrote: On 26/05/2014 01:23, Lex Trotman wrote: If we moved to having public headers that just included actual public symbols, I think it would be advantageous to have those headers totally

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Matthew Brush
On 14-05-29 08:01 AM, Lex Trotman wrote: On 30 May 2014 00:46, Matthew Brush mbr...@codebrainz.ca wrote: On 14-05-29 05:56 AM, Nick Treleaven wrote: On 26/05/2014 01:23, Lex Trotman wrote: If we moved to having public headers that just included actual public symbols, I think it would be

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Matthew Brush
On 14-05-29 11:58 AM, Thomas Martitz wrote: Am 26.05.2014 01:50, schrieb Matthew Brush: Hi, As part of working on cleaning up the exposed API to plugins I got to thinking about where our comments are located. While it's nice to keep the API-documentation-comments right at the definitions of

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Thomas Martitz
Am 29.05.2014 21:21, schrieb Matthew Brush: On 14-05-29 11:58 AM, Thomas Martitz wrote: Am 26.05.2014 01:50, schrieb Matthew Brush: Hi, As part of working on cleaning up the exposed API to plugins I got to thinking about where our comments are located. While it's nice to keep the

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Lex Trotman
[...] Ok, not super technical, but more compelling than I'm too lazy to open the header file/update the documentation if it's not directly above one place I edit (instead of the other place I most likely have to edit) :) Different people have different workflows, some open everything, some

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-29 Thread Matthew Brush
On 14-05-29 04:37 PM, Lex Trotman wrote: [...] Ok, not super technical, but more compelling than I'm too lazy to open the header file/update the documentation if it's not directly above one place I edit (instead of the other place I most likely have to edit) :) Different people have different

[Geany-Devel] [RFC]: Public API comments in headers

2014-05-25 Thread Matthew Brush
Hi, As part of working on cleaning up the exposed API to plugins I got to thinking about where our comments are located. While it's nice to keep the API-documentation-comments right at the definitions of the functions in their respective .c source files, since we only install the headers as

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-25 Thread Lex Trotman
On 26 May 2014 09:50, Matthew Brush mbr...@codebrainz.ca wrote: Hi, As part of working on cleaning up the exposed API to plugins I got to thinking about where our comments are located. While it's nice to keep the API-documentation-comments right at the definitions of the functions in their

Re: [Geany-Devel] [RFC]: Public API comments in headers

2014-05-25 Thread Matthew Brush
On 14-05-25 05:23 PM, Lex Trotman wrote: On 26 May 2014 09:50, Matthew Brush mbr...@codebrainz.ca wrote: [snip] If we moved to having public headers that just included actual public symbols, I think it would be advantageous to have those headers totally commented/documented rather than