[Geany-devel] Adding a list of filetypes into devel documentation?
frank at xxxxx
Wed Aug 17 06:26:14 UTC 2011
On Tue, 16 Aug 2011 22:53:23 +0200
Colomban Wendling <lists.ban at herbesfolles.org> wrote:
> Le 16/08/2011 10:05, Lex Trotman a écrit :
> > On 16 August 2011 12:19, Matthew Brush <mbrush at codebrainz.ca> wrote:
> >> On 08/15/2011 03:45 PM, Lex Trotman wrote:
> >>>> If I get some time, I could try and do this. Is anybody opposed
> >>>> to putting
> >>>> the API docs in reStructuredText files and generating the API
> >>>> docs using Sphinx? I've been using this for the Python bindings
> >>>> and it's quite nice and easy, and there's support for C domain
> >>>> as well.
> >>> I personally don't care, but being cautious, can you provide a C
> >>> example?
> >> Sure thing:
> >> http://codebrainz.github.com/geany-sphinx/
> > Nice, so I read the Sphinx doco (havn't looked at it for a while)
> > but IIUC either you have to repeat the C declarations that appear
> > in the documentation or use doxygen and breathe to extract it.
> > 1. The repeat option is unacceptable.
> > 2. Although the output is nice I don't see enough is gained by the
> > second option to justify having to use two tools (sphinx and
> > breathe) on top of the current one (doxygen).
> > So at the moment I don't see that this justifies the change.
> +1 here, but I'd be fine to be proven wrong. But anyway copying the
> function signature or any other information that could be
> automatically found by Doxygen, GtkDoc or whatever
> source-comment-and-analysis-based documentation tool is not an
> option. This kind of thing would be the easiest way to have
> documentation and code out-of-sync.
I agree. Documentation and Code shall not be split. Not sure whether
Sphinx can do this for C.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Size: 836 bytes
Desc: not available
More information about the Devel