Partly broken make apidox

Amilcar do Carmo Lucas amilcar at ida.ing.tu-bs.de
Wed Jul 26 07:55:03 UTC 2006


On Tuesday 25 July 2006 18:52, Bernd Pol wrote:
> Andreas Pakulat schrieb am 25.07.2006 01:49:
> > while at a first glance it looks like all the information is there when
> > running make apidox there are some problems:
> >
> > 1. certain replacements are not done, the first page says %API
> > %Documenation, this looks wrong
> >
> > 2. All references to "API Reference" are broken, because they all
> > contain href="@topdir@".
> >
> > 3. The class picker is empty and there's no class lists available on the
> > pages, I always have to click on the (classes) link on the front page
> >
> > 4. The pages on the classes don't look really well (see attached
> > screenshot for an example).
> >
> > 5. make install-apidox installs something into
> > kdevelop-dir/share/doc/HTML/en/kdevelop-apidocs, but the links on the
> > index.html in there are totally broken, for example the index.html
> > references kdevbtwidgets/html/index.html for the Buildtool Widget, but
> > there's no kdevbtwidget dir.
> >
> > That's all I could see for now.
>
> Hi Andreas,
>
> I had a short look at it. Obviously apidox generation in 3.4 is severely
> outdated. I got something more useful in these steps:
>
> 1) Replace Doxyfile.am in the top sourcedir with admin/Doxyfile.am
> 2) Clean apidocs subdirectory
> 3) Export DOXDATA=<kde installation directory>/share/doc/HTML/en/common
> 4) Issue
> 	admin/doxygen.sh --recurse --no-modulename <kdevelop top source
> directory> .
>     (the final dot is necessary, otherwise doxygen.sh will not recurse)
>
> The result is in apidocs/index.html as usual. It is not perfect but
> seems usable.
>
> Somebody (amilcar???) should have a look at all this before release. I
> could give it a try but not before weekend.
I will take a look at it.

Amilcar




More information about the KDevelop-devel mailing list