Re: creating a doc from several lib

[Vincent Torri <torri math u-strasbg fr>]

On 11 Feb 2004, Damon Chaplin wrote:

> On Tue, 2004-02-10 at 20:04, Vincent Torri wrote:
> > hello
> > 
> > i am using gtkdoc to create an api doc of several lib (say lib1 and
> > lib1). The source code of these libs are resp. in top/lib1/src and
> > /top/lib2/src.
> > 
> > with gtkdoc, what i can make is two different docs (exactly as the gtk gdk
> > and gkpixbuf (in the gtk source code), where three docs are created in
> > each subdirectories of gtk+-2.2.4/docs/referecence). I have already
> > created them.
> > 
> > That is not exactly what i want: I want one doc with two chapters (for
> > example), coresponding to the doc of lib1 and lib2.
> > 
> > My questions are : 
> > 
> > Is it possible to parse the two subdirectories /lib1/src and lib2/src in
> > order to create this single doc ??
> 
> You can create a single doc, just by setting DOC_SOURCE_DIR to the root
> directory of the project, i.e. 'top' in your case. It will then scan the
> entire directory hierarchy beneath that.
> 
> Backup your current docs first though, in case it messes them up.
> 
> Damon

Thanks ! it works this way.
I have also find another solution, which corresponds to my pb : i have
more than two lib (~10) and i want to document some of them. I can ignore
.h files with IGNORE_HFILES, but it is a pain, with so much headers... 

I describe what i have done because i have one more question/problem :)

i have created the following directory structure:

api-doc/doc/reference/lib1
                      lib2
and I have created Makefile.am in the lib1 and lib2 subdirectory. These
Makefile parse the top/lib1/src and top/lib2/src (resp)

I have created another Makefile.am in the api-doc/doc/reference directory
which parse nothing and I have added in this directory a sgml file (say
api-doc.sgml) which calls lib1/xml/lib1.xml and lib2/xml/lib2.xml

everything works fine except the following:

in api-doc.sgml, i "call" a function of lib1, so:
  1) I added in the Makefile.am of api-doc/doc/reference the line
        FIXXREF_OPTIONS=--extra-dir=lib1/html
  2) in api-doc.sgml, i have added
        <link linkend="my_function">my_function()</link>

but gtk-doc does not create the link to this function (which exists in the
doc of lib1, of course...)

Where am I wrong ? In FIXXREF ?? Do I have forgotten something ?

I also have a remark : the css style of gtk-doc is not given in a .css
file, but in one of its configuration files (don't remember which one). I
think it should be a good idea to provide a .css file and change a bit
gtk-doc (instead of added the style in the index.html, load the .css
file). The api would be more themeable.

Thanks a lot !

Vincent TORRI