[prev in list] [next in list] [prev in thread] [next in thread] 

List:       koffice-devel
Subject:    Re: API documentation
From:       Raphael Langerhorst <raphael-langerhorst () gmx ! at>
Date:       2005-03-21 11:39:44
Message-ID: 200503211239.46272.raphael-langerhorst () gmx ! at
[Download RAW message or body]

On Monday 21 March 2005 10:18, David Faure wrote:
> On Saturday 19 March 2005 16:52, Raphael Langerhorst wrote:
> > Hi everyone,
> >
> > I guess we have some kind of API documentation generation, so how
> > does it currently work? And would it be good to migrate the
> > current setup to the things in doc/api ?
>
> For the website, it currently works with a script (on the
> webserver) which copies koffice/Doxyfile.temp into each subdir and
> runs doxygen there.... I'd be happy with a cleaner solution. But I
> can't use "make apidox" since this requires to configure koffice
> first, which isn't possible on the webserver. The kdepim solution,
> instead, looks clean.
> Does koffice/doc/api generate docu correctly for all of koffice, or
> does it require Makefile.am changes like the one in kdgantt?

Well, AFAIK at least make -f Makefile.cvs must be possible to use the 
doxygen setup. We have to include $(top_srcdir)/doc/api/Doxyfile.am 
for every Makefile.am like it is done at the moment for kdgantt. Some 
Makefile.am include koffice/admin/Doxyfile.am  ... is this supposed 
to work for everything(?). I ran a little test with kchart, included 
the doc/api/Doxyfile.am in the Makefile.am and run make apidox, which 
resulted in usable output in koffice/apidocs/kchart/html. Still the 
process failed at one point when trying to access 
koffice/apidocs/subdirs, not sure yet what this should be (we could 
ask the kdepim people). The output included all kchart files already, 
only the actual class descriptions were missing (which are created in 
the postprocessing step).

All in all I conclude that the setup in doc/api is quite usable, we 
should probably migrate to that (as I said, it must be possible to 
process the Makefile.am to generate valid makefiles for the actual 
api doc generation). Some minor (IMO) issues have to be as well. At 
least with this it would be possible for everyone that downloads the 
source to build his/her own API documentation (for all of koffice).

Regards,
Raphael
_______________________________________________
koffice-devel mailing list
koffice-devel@kde.org
https://mail.kde.org/mailman/listinfo/koffice-devel
[prev in list] [next in list] [prev in thread] [next in thread]