[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Feature request: generate documentation from C files
From: |
Alper Ersoy |
Subject: |
Re: Feature request: generate documentation from C files |
Date: |
Sat, 25 Oct 2003 09:14:05 +0300 |
User-agent: |
Mutt/1.4.1i |
Hi!
Simon Josefsson:
> One question: do you have any markup language to use within the
> GTK-DOC comments, to create, e.g., lists, links, indentation? Can you
> use texinfo commands?
I have to admit that I'm not very familiar with GTK-DOC tools. In
fact, I have never used them yet, so I don't really know if it has
such functionalities. Also regarding Texinfo commands, since the
Texinfo command prefix clashes with the param type, you can't use them
directly. GTK-DOC seems to be a very minimal markup format :\
IIRC our scanner in BEAST/BSE allows one to use @*, but that's special
cased and last time we checked Tim Janik was uncomfortable with
further breaking the compatibility with the original tools. However,
he's very approachable, and you may try checking with him too before
making your final decision. So I'm adding him to the CC list.
> so I might spend time on writing a doxygen2gtkdoc.
I suppose this will be a lossy conversion.
> As for generating texinfo manual, adding a texinfo output backend to
> doxygen seem to be one option.
This would be beneficial to many more people also. Though seems to be
the harder option.
> Using your already existing texinfo generator, and split the output
> to one file per function is another option (probably easier
> approach).
Splitting the output in node boundaries is in my TODO list for
Texitheque. So we only need to add @node and @menu commands to the
appropriate places during the scanning. However, I plan to do it
after I clean the stuff up so to add room for further development.
This means it will take some time, at least no progress until Texinfo
4.7 is released. Also you will have to settle for the lesser markup.
Bye,
--
Alper Ersoy
- Feature request: generate documentation from C files, Simon Josefsson, 2003/10/23
- Re: Feature request: generate documentation from C files, Karl Berry, 2003/10/23
- Re: Feature request: generate documentation from C files, Akim Demaille, 2003/10/23
- Re: Feature request: generate documentation from C files, Simon Josefsson, 2003/10/23
- Re: Feature request: generate documentation from C files, Akim Demaille, 2003/10/23
- Re: Feature request: generate documentation from C files, Alper Ersoy, 2003/10/23
- Re: Feature request: generate documentation from C files, Simon Josefsson, 2003/10/24
- Re: Feature request: generate documentation from C files,
Alper Ersoy <=
- Re: Feature request: generate documentation from C files, Tim Janik, 2003/10/25
- Re: Feature request: generate documentation from C files, Simon Josefsson, 2003/10/25
Re: Feature request: generate documentation from C files, Simon Josefsson, 2003/10/23