kdelibs documentation directories question

Hello,

I am having some trouble with KDevelop's handling of
kdelibs  
documentation on Debian, and am wondering whether someone
could  
explain to me the difference between the two following
"configure"  
options?

   --with-kdelibsdoxy-dir=DIR         where the kdelibs
documentation  
is installed
   --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation  
is installed

I understand the first option, which looks for  
"kdecore/html/classKApplication.html". I pass   
--with-kdelibsdoxy-dir=/usr/share/doc/kde/HTML/en/kdelibs-ap
idocs and  
the test succeeds.

However, I don't understand the second option which looks
for  
"kdecore/index.html"..

Many thanks in advance!

Jeremy

-- 
http://www.jerryweb.org/
            : JerryWeb.org
http://sailcut.source
forge.net/      : Sailcut CAD
http://opensourc
e.polytechnique.org/ : Polytechnique.org Free Software


_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 18:26, Jeremy Laine wrote:
> Hello,
>
> I am having some trouble with KDevelop's handling of
kdelibs
> documentation on Debian, and am wondering whether
someone could
> explain to me the difference between the two following
"configure"
> options?
>
>    --with-kdelibsdoxy-dir=DIR         where the kdelibs
documentation
> is installed
>    --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation
> is installed
>
> I understand the first option, which looks for
> "kdecore/html/classKApplication.html". I
pass
>
--with-kdelibsdoxy-dir=/usr/share/doc/kde/HTML/en/kdelibs-ap
idocs and
> the test succeeds.
>
> However, I don't understand the second option which
looks for
> "kdecore/index.html"..

This is just a guess, but that might have been for the
pre-doxygen era.  Does 
it work without specifying it?

Cheers,
Hamish.
_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 18:26, Jeremy Laine wrote:
> Hello,
>
> I am having some trouble with KDevelop's handling of
kdelibs
> documentation on Debian, and am wondering whether
someone could
> explain to me the difference between the two following
"configure"
> options?
>
>    --with-kdelibsdoxy-dir=DIR         where the kdelibs
documentation
> is installed
>    --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation
> is installed
>
> I understand the first option, which looks for
> "kdecore/html/classKApplication.html". I
pass
>
--with-kdelibsdoxy-dir=/usr/share/doc/kde/HTML/en/kdelibs-ap
idocs and
> the test succeeds.
>
> However, I don't understand the second option which
looks for
> "kdecore/index.html"..

This is just a guess, but that might have been for the
pre-doxygen era.  Does 
it work without specifying it?

Cheers,
Hamish.
_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 18:26, Jeremy Laine wrote:
> Hello,
>
> I am having some trouble with KDevelop's handling of
kdelibs
> documentation on Debian, and am wondering whether
someone could
> explain to me the difference between the two following
"configure"
> options?
>
>    --with-kdelibsdoxy-dir=DIR         where the kdelibs
documentation
> is installed
>    --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation
> is installed
>
> I understand the first option, which looks for
> "kdecore/html/classKApplication.html". I
pass
>
--with-kdelibsdoxy-dir=/usr/share/doc/kde/HTML/en/kdelibs-ap
idocs and
> the test succeeds.
>
> However, I don't understand the second option which
looks for
> "kdecore/index.html"..

This is just a guess, but that might have been for the
pre-doxygen era.  Does 
it work without specifying it?

Cheers,
Hamish.
_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 11:26, Jeremy Laine wrote:
> I am having some trouble with KDevelop's handling of
kdelibs
> documentation on Debian, and am wondering whether
someone could
> explain to me the difference between the two following
"configure"
> options?
>
>    --with-kdelibsdoxy-dir=DIR         where the kdelibs
documentation
> is installed
>    --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation
> is installed
Just ignore this option, it was used to find KDoc- generated
docs.
Starting from 3.1 KDevelop neither understands KDoc gocs nor
uses them.

Doxygen (--with-kdelibsdoxy-dir) is understood by the
documentation plugin now

_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 11:26, Jeremy Laine wrote:
> I am having some trouble with KDevelop's handling of
kdelibs
> documentation on Debian, and am wondering whether
someone could
> explain to me the difference between the two following
"configure"
> options?
>
>    --with-kdelibsdoxy-dir=DIR         where the kdelibs
documentation
> is installed
>    --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation
> is installed
Just ignore this option, it was used to find KDoc- generated
docs.
Starting from 3.1 KDevelop neither understands KDoc gocs nor
uses them.

Doxygen (--with-kdelibsdoxy-dir) is understood by the
documentation plugin now

_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 11:42, Hamish Rodda wrote:
> On Monday 21 August 2006 18:26, Jeremy Laine wrote:
> > Hello,
> >
> > I am having some trouble with KDevelop's handling
of kdelibs
> > documentation on Debian, and am wondering whether
someone could
> > explain to me the difference between the two
following "configure"
> > options?
> >
> >    --with-kdelibsdoxy-dir=DIR         where the
kdelibs
> > documentation is installed
> >    --with-kdelibsdoc-dir=DIR         where the
kdelibs
> > documentation is installed
> >
> > I understand the first option, which looks for
> > "kdecore/html/classKApplication.html".
I pass
> >
--with-kdelibsdoxy-dir=/usr/share/doc/kde/HTML/en/kdelibs-ap
idocs
> > and the test succeeds.
> >
> > However, I don't understand the second option
which looks for
> > "kdecore/index.html"..
>
> This is just a guess, but that might have been for the
pre-doxygen
> era.  Does it work without specifying it?

Yeah, I think those switches can be removed. I don't use
them and 
documentation viewing works without a problem.

Andras

-- 
Quanta Plus developer - http://quanta.kdewebdev.o
rg
K Desktop Environment - http://www.kde.org
_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

> > This is just a guess, but that might have been for
the pre-doxygen
> > era.  Does it work without specifying it?
>
> Yeah, I think those switches can be removed. 
Well, we still need --with-kdelibsdoxy-dir for those people
who install
apidox in some strange places in the filesystem.

> I don't use them and 
> documentation viewing works without a problem.
Hehe, that's because I search all known common places for
docs ;)

_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

>    --with-kdelibsdoc-dir=DIR         where the kdelibs
documentation
> is installed

After looking around some more, this option set
KDELIBS_DOCDIR, which  
is not used anywhere:

$ grep KDELIBS_DOCDIR * -R
acinclude.m4:AC_DEFINE_UNQUOTED(KDELIBS_DOCDIR,
"$kdelibs_docdir",  
[where KDE documentation is installed])
config.h.in:#undef KDELIBS_DOCDIR
configure:#define KDELIBS_DOCDIR
"$kdelibs_docdir"
kdevelop.m4.in:AC_DEFINE_UNQUOTED(KDELIBS_DOCDIR,
"$kdelibs_docdir",  
[where KDE documentation is installed])

Maybe this option should be removed altogether?

Cheers,
Jeremy

-- 
http://www.jerryweb.org/
            : JerryWeb.org
http://sailcut.source
forge.net/      : Sailcut CAD
http://opensourc
e.polytechnique.org/ : Polytechnique.org Free Software


_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel

On Monday 21 August 2006 15:12, Alexander Dymo wrote:
> > > This is just a guess, but that might have
been for the
> > > pre-doxygen era.  Does it work without
specifying it?
> >
> > Yeah, I think those switches can be removed.
>
> Well, we still need --with-kdelibsdoxy-dir for those
people who
> install apidox in some strange places in the
filesystem.
>
> > I don't use them and
> > documentation viewing works without a problem.
>
> Hehe, that's because I search all known common places
for docs ;)

Is /opt/kde4 a common place? Isn't the apidocs used from
where you 
specify in the config dialog?

Andras
-- 
Quanta Plus developer - http://quanta.kdewebdev.o
rg
K Desktop Environment - http://www.kde.org
_______________________________________________
KDevelop-devel mailing list
KDevelop-develbarney.cs.uni-potsdam.de
http://barney.cs.uni-potsdam.de/mailman/listinfo/
kdevelop-devel