Bug 75577 - Empty KDELib, QTLib entry in Document Tree.
Summary: Empty KDELib, QTLib entry in Document Tree.
Status: RESOLVED FIXED
Alias: None
Product: kdevelop
Classification: Applications
Component: general (show other bugs)
Version: 3.0.1
Platform: unspecified Linux
: NOR normal
Target Milestone: ---
Assignee: KDevelop Developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-02-19 05:00 UTC by Xu Jian
Modified: 2004-07-19 22:53 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Xu Jian 2004-02-19 05:00:06 UTC
Version:           3.0.1 (using KDE 3.2.0, compiled sources)
Compiler:          gcc version 2.95.4 20011002 (Debian prerelease)
OS:          Linux (i686) release 2.4.23-workstation2

The needed document tree does not appear for QTLib or
KDELib. I checked the document directory and there are
index.html, pages.html, search.html, doxygen.css, doxygen.png in the <long path to it>/kdelibs-apidocs/

viewing the index.html seems ok but can't do it in the 
ide. Nor does it work for QT library documents.

Kdevelop v3.0.1. working in IDEA mode. 
xujian@cse.unsw.edu.au
Comment 1 Amilcar do Carmo Lucas 2004-02-19 11:30:02 UTC
Have you configured KDevelop like this?
./configure --enable-debug=full --prefix=$KDEDIR --with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs


does $KDEDIR/share/doc/HTML/en/kdelibs-apidocs exist?

Comment 2 Xu Jian 2004-02-19 13:02:23 UTC
I did not specify the options at configure, but when the 
script runs, it outputs the following...

checking for Qt documentation... <directory>/common/qt/doc/html
checking for kdelibs documentation generated by Doxygen... <directory>/usr/kde32/share/doc/HTML/en/kdelibs-apidocs
checking for kdelibs documentation... NO

I think the configure has successfully located the documents.
Comment 3 Amilcar do Carmo Lucas 2004-02-19 13:23:55 UTC
> checking for kdelibs documentation... NO 
I would say that it checked in the correct place and did not find them.

Have you installed kdelibs-devel-doc ? or have you done "make apidox" in the source directory of kdelibs ?

Please read the README file:
KDE API Documentation
---------------------------
If the KDE API documentation does not exist, it can be created
as follows:

  Install doxygen and the kdelibs sources. Then

  make apidox
  make apidox-install

After that you should follow the instructions at:

http://www.kdevelop.org/index.html?filename=branches_compiling.html

to compile KDevelop
Comment 4 Xu Jian 2004-02-19 14:11:30 UTC
:) I have done it for several times. 
the directory of <directory>/usr/kde32/share/doc/HTML/en/kdelibs-apidocs/
now contains:
	doxygen.css
	doxygen.png
	index.html
	pages.html
	search.html
and a set of sub-dirs e.g. kdecore/
        html/
	kdecore.tag
	latex/
	man/
Is this the right structure kdevelop is seraching for?
BTW. There is no make apidox-install in kdelibs's Makefile. only make install-apidox is available and creates a same directory under the source
dir.

Am I doing something wrong? The html files in the directories looks good.

Comment 5 Amilcar do Carmo Lucas 2004-02-19 14:23:18 UTC
>ls $KDEDIR/share/doc/HTML/en/kdelibs-apidocs
total 35
lrwxrwxrwx    1 root     root           34 Oct 18  2002 common -> /opt/kde3/share/doc/HTML/en/common/
drwxr-xr-x    3 root     root          160 Sep  8 13:55 dcop/
-rw-r--r--    1 root     root         4103 Sep  4 01:32 doxygen.css
-rw-r--r--    1 root     root         2352 Sep  4 01:32 doxygen.png
-rw-r--r--    1 root     root         4103 Sep  4 01:32 index.html
drwxr-xr-x    3 root     root          168 Sep  8 13:55 interfaces/
drwxr-xr-x    3 root     root          160 Sep  8 13:55 kabc/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 kdecore/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 kdefx/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 kdeui/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 khtml/
drwxr-xr-x    3 root     root          160 Sep  8 13:56 kio/
drwxr-xr-x    3 root     root          160 Sep  8 13:56 kjs/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 kparts/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 kspell/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 kutils/
drwxr-xr-x    3 root     root          168 Sep  8 13:56 libkmid/
-rw-r--r--    1 root     root         1582 Sep  4 01:32 pages.html
drwxr-xr-x    2 root     root           72 Sep  8 13:56 qt/
-rw-r--r--    1 root     root         1520 Sep  4 01:32 search.html

do you have the "common" link?
Comment 6 Xu Jian 2004-02-19 14:31:01 UTC
yes. it reads.
common -> /import/ghaita/1/xujian/usr/kde32/share/doc/HTML/en/common/

contains,

-rw-r--r--    1 xujian   xujian        361 2001-05-08 21:00 10.png
-rw-r--r--    1 xujian   xujian        329 2001-05-08 21:00 1.png
-rw-r--r--    1 xujian   xujian        353 2001-05-08 21:00 2.png
-rw-r--r--    1 xujian   xujian        350 2001-05-08 21:00 3.png
-rw-r--r--    1 xujian   xujian        345 2001-05-08 21:00 4.png
-rw-r--r--    1 xujian   xujian        348 2001-05-08 21:00 5.png
-rw-r--r--    1 xujian   xujian        355 2001-05-08 21:00 6.png
-rw-r--r--    1 xujian   xujian        344 2001-05-08 21:00 7.png
-rw-r--r--    1 xujian   xujian        357 2001-05-08 21:00 8.png
-rw-r--r--    1 xujian   xujian        357 2001-05-08 21:00 9.png
-rw-r--r--    1 xujian   xujian       1771 2003-10-17 04:17 appheader.html
-rw-r--r--    1 xujian   xujian       7820 2000-11-02 23:39 
artistic-license.html
-rw-r--r--    1 xujian   xujian        168 2002-03-05 20:44 bottom1.png
-rw-r--r--    1 xujian   xujian       6979 2002-03-08 20:24 bottom2.png
-rw-r--r--    1 xujian   xujian       2069 2000-11-02 23:39 bsd-license.html
-rw-r--r--    1 xujian   xujian       9282 2002-02-22 06:39 docheadergears.png
-rw-r--r--    1 xujian   xujian        850 2001-03-26 04:55 doctop1a.png
-rw-r--r--    1 xujian   xujian       2313 2001-03-28 02:24 doctop1b.png
-rw-r--r--    1 xujian   xujian      12235 2001-03-13 09:50 doctop1.png
-rw-r--r--    1 xujian   xujian        260 2001-03-13 09:50 doctop2.png
-rw-------    1 xujian   xujian       4828 2004-02-20 00:27 doxygen.css
-rw-r--r--    1 xujian   xujian       4605 2003-09-21 18:38 doxygen.css.bak
-rw-r--r--    1 xujian   xujian      18110 2000-11-03 20:32 fdl-license
-rw-r--r--    1 xujian   xujian      18433 2000-11-10 04:43 fdl-license.html
-rw-------    1 xujian   xujian        255 2004-02-20 00:27 footer.html
-rw-r--r--    1 xujian   xujian        546 2004-01-17 23:52 footer.html.bak
-rw-r--r--    1 xujian   xujian      17984 2000-11-03 20:32 gpl-license
-rw-r--r--    1 xujian   xujian      19306 2002-04-25 21:05 gpl-license.html
-rw-r--r--    1 xujian   xujian        248 2002-02-22 07:44 grad.png
-rw-r--r--    1 xujian   xujian        493 2002-02-22 06:40 headerbg.png
-rw-------    1 xujian   xujian        243 2004-02-20 00:27 header.html
-rw-r--r--    1 xujian   xujian       1466 2003-08-21 18:45 header.html.bak
-rw-r--r--    1 xujian   xujian       1347 2000-07-04 00:22 kde-common.css
-rw-r--r--    1 xujian   xujian       7635 2003-09-21 18:38 kde-default.css
-rw-r--r--    1 xujian   xujian       1287 2000-07-04 00:22 
kde-localised.css.template
-rw-r--r--    1 xujian   xujian        199 2003-03-03 19:52 kde_logo_bg.png
-rw-r--r--    1 xujian   xujian      29911 2003-03-03 19:52 kde_logo.png
-rw-r--r--    1 xujian   xujian       6155 2003-09-21 18:38 kde-web.css
-rw-r--r--    1 xujian   xujian        845 2002-09-28 04:02 kmenu.png
-rw-r--r--    1 xujian   xujian      26428 2000-11-03 20:32 lgpl-license
-rw-r--r--    1 xujian   xujian      25817 2000-11-10 04:43 lgpl-license.html
-rw-r--r--    1 xujian   xujian        535 2004-01-17 23:52 mainfooter.html
-rw-r--r--    1 xujian   xujian        818 2002-03-16 03:53 mainheader.html
-rw-r--r--    1 xujian   xujian       6318 2000-11-02 23:39 qpl-license.html
-rw-r--r--    1 xujian   xujian        213 2001-03-13 09:50 shadow.png
-rw-r--r--    1 xujian   xujian       6762 2002-03-05 20:44 web-docbottom.png
-rw-r--r--    1 xujian   xujian      14939 2002-02-09 02:21 web-doctop.png
-rw-r--r--    1 xujian   xujian       2307 2000-11-02 23:39 x11-license.html
-rw-r--r--    1 xujian   xujian       6801 2000-03-07 04:55 xml.dcl


thanks.
On Friday 20 February 2004 00:23, Amilcar do Carmo Lucas wrote:
> ------- You are receiving this mail because: -------
> You reported the bug, or are watching the reporter.
> You are on the CC list for the bug, or are watching someone who is.
>
> http://bugs.kde.org/show_bug.cgi?id=75577
>
>
>
>
> ------- Additional Comments From a.lucas tu-bs de  2004-02-19 14:23 -------
>
> >ls $KDEDIR/share/doc/HTML/en/kdelibs-apidocs
>
> total 35
> lrwxrwxrwx    1 root     root           34 Oct 18  2002 common ->
> /opt/kde3/share/doc/HTML/en/common/ drwxr-xr-x    3 root     root         
> 160 Sep  8 13:55 dcop/
> -rw-r--r--    1 root     root         4103 Sep  4 01:32 doxygen.css
> -rw-r--r--    1 root     root         2352 Sep  4 01:32 doxygen.png
> -rw-r--r--    1 root     root         4103 Sep  4 01:32 index.html
> drwxr-xr-x    3 root     root          168 Sep  8 13:55 interfaces/
> drwxr-xr-x    3 root     root          160 Sep  8 13:55 kabc/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 kdecore/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 kdefx/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 kdeui/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 khtml/
> drwxr-xr-x    3 root     root          160 Sep  8 13:56 kio/
> drwxr-xr-x    3 root     root          160 Sep  8 13:56 kjs/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 kparts/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 kspell/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 kutils/
> drwxr-xr-x    3 root     root          168 Sep  8 13:56 libkmid/
> -rw-r--r--    1 root     root         1582 Sep  4 01:32 pages.html
> drwxr-xr-x    2 root     root           72 Sep  8 13:56 qt/
> -rw-r--r--    1 root     root         1520 Sep  4 01:32 search.html
>
> do you have the "common" link?

Comment 7 Amilcar do Carmo Lucas 2004-02-19 14:50:06 UTC
cd <kdevelopsourcedirectory>
make -f Makefile.cvs
./configure --enable-debug=full --prefix=/import/ghaita/1/xujian/usr/kde32 --with-kdelibsdoxy-dir=/import/ghaita/1/xujian/usr/kde32/share/doc/HTML/en/kdelibs-apidocs
make
su
make install

:)
Comment 8 Xu Jian 2004-02-20 01:04:36 UTC
Hi,
 I don't think it will work :) actually there is no Makefile.cvs in the
source directory and neither do I have root privilege to run "su"

 I had a look at config.log, it reads,

configure:36652: checking for Qt documentation
configure: 36679: /import/ghaita/1/xujian/common/qt/html/classes.html
configure: 36679: /import/ghaita/1/xujian/common/qt/doc/html/classes.html
taking that
configure:36685: result: /import/ghaita/1/xujian/common/qt/doc/html
configure:36697: checking for kdelibs documentation generated by Doxygen
configure: 
36728: /import/ghaita/1/xujian/usr/kde32/share/doc/HTML/en/kdelibs-apidocs/kdecore/html/classKApplication.html
taking that
configure:36734: 
result: /import/ghaita/1/xujian/usr/kde32/share/doc/HTML/en/kdelibs-apidocs
configure:36746: checking for kdelibs documentation
configure: 36781: /usr/doc/kdelibs-doc/html/kdecore/index.html
configure: 
36781: /import/ghaita/1/xujian/usr/kde32/share/doc/HTML/default/kdelibs/kdecore/index.html
configure: 
36781: /import/ghaita/1/xujian/usr/kde32/share/doc/HTML/en/kdelibs/kdecore/index.html
configure:36787: result: NO

Does it mean I really have doxgen-document installed but no kdelibs 
documentation. What's the difference? I can have either to work
don't I? And it seems the QT library documents IS located.

regards,
Xu Jian
On Friday 20 February 2004 00:50, Amilcar do Carmo Lucas wrote:
> ------- You are receiving this mail because: -------
> You reported the bug, or are watching the reporter.
> You are on the CC list for the bug, or are watching someone who is.
>
> http://bugs.kde.org/show_bug.cgi?id=75577
>
>
>
>
> ------- Additional Comments From a.lucas tu-bs de  2004-02-19 14:50 -------
> cd <kdevelopsourcedirectory>
> make -f Makefile.cvs
> ./configure --enable-debug=full --prefix=/import/ghaita/1/xujian/usr/kde32
> --with-kdelibsdoxy-dir=/import/ghaita/1/xujian/usr/kde32/share/doc/HTML/en/
>kdelibs-apidocs make
> su
> make install
>
> :)

Comment 9 Xu Jian 2004-02-20 01:21:24 UTC
Get some new clues about this problem.
The branch of KDELibs-doc(doxgen) IS there and works. But if I 
call out the "document configuration dialog" and simply press "OK"
the document tree refreshes and this branch can never expand.

The QT documents still don't work.
I have already ticked the documents in the project settings.
Comment 10 Amilcar do Carmo Lucas 2004-02-20 09:53:03 UTC
> Does it mean I really have doxgen-document installed but no kdelibs
documentation.
KDE libs _API_ documentation IS doxygen generated.

>What's the difference?
No difference for KDE >= 3.1

> And it seems the QT library documents IS located.
Yeap, looks so.

> this branch can never expand
Can not reproduce

> The QT documents still don't work
Can not reproduce
Comment 11 Friedrich W. H. Kossebau 2004-02-21 23:00:53 UTC
From KConfigBase::writePathEntry API dox:
  It is checked whether the path is located under $HOME.
  If so the path is written out with the user's home-directory
  replaced with $HOME. The path should be read back with readPathEntry()

But the readPathEntry() calls got commented out and it was switched to using a 
map (for performance reasons?) to read the config vars in. And QDir as used 
in DocTreeViewTool::readLibraryDocs() does not know about $HOME. So api dox 
install paths living under $HOME will not be found again on next kdevelop 
start. 

Untested quick and dirty patch:
Put all "it.data()" into a "URLUtil::envExpand()".


culprit code in doctreeviewwidget.cpp:
    
e.g. in DocTreeViewWidget constructor:

    KConfig *config = DocTreeViewFactory::instance()->config();
    if (config)
    {
        config->setGroup("General KDoc");
        QMap<QString, QString> dmap = config->entryMap("General KDoc");
        QString kdocdir(KDELIBS_DOCDIR);
        kdocdir = URLUtil::envExpand(kdocdir);
        if (dmap.empty() && (!kdocdir.isEmpty()))
        {
            config->writePathEntry("KDE Libraries (KDoc)", kdocdir);
            dmap["KDE Libraries (KDoc)"] = kdocdir;
        }

        QMap<QString, QString>::Iterator it;
        for (it = dmap.begin(); it != dmap.end(); ++it)
        {
            DocTreeKDELibsFolder *kdf = new DocTreeKDELibsFolder(it.data(), 
it.key(), docView, "ctx_kdelibs");
            kdf->refresh();
            folder_kdoc.append(kdf);
        }
    }



Comment 12 Alexander Dymo 2004-05-11 00:41:31 UTC
Please check if this bug applies to new documentation plugin in HEAD. It is most likely fixed there.
Comment 13 Amilcar do Carmo Lucas 2004-07-19 22:53:39 UTC
No reply for two months now. assuming fixed