Reorganizing the kdevplatform structure

Hi,

apparently the new way of generating apidocs doesn't work
that well with
our current layout. Specifically the apidocs contain the src
entry and
the various libraries under that. This doesn't look nice and
(more
important) it triggers a bug (or missing feature, however
you want to
put it) in KDevelop3's documentation part (the various
classes and libs
are not accesible at all).

Now I can somewhat fix the bug by removing the Mainpage.dox
from the
various lib-subdirs inside src (i.e. remove src/interfaces
Mainpage.dox)
and merge the information into src/Mainpage.dox. The
downside of this is
that we#d then have all classes inside the src-module
apidoc-wise (i.e.
the navigation sidebar has only src and all classes are in
that list). I
don't think thats really useful either.

So I propose to remove src and put the various libraries
directly into
the module, i.e. mv kdevplatform/src/interfaces
kdevplatform/interfaces.
Thats the same as kdelibs does and provides nicer apidoc
pages and you
don't need to patch kdevelop3's documentation plugin to work
with this.

Objections?

Andreas

-- 
You get along very well with everyone except animals and
people.

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On Tuesday 12 June 2007, Andreas Pakulat wrote:
> So I propose to remove src and put the various
libraries directly
> into the module, i.e. mv kdevplatform/src/interfaces
> kdevplatform/interfaces.

I agree and think that the module layout would look also
nicer.

Andras

-- 
Quanta Plus developer - http://quanta.kdewebdev.o
rg
K Desktop Environment - http://www.kde.org

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On 6/12/07, Andras Mantia <amantiakde.org> wrote:
> On Tuesday 12 June 2007, Andreas Pakulat wrote:
> > So I propose to remove src and put the various
libraries directly
> > into the module, i.e. mv
kdevplatform/src/interfaces
> > kdevplatform/interfaces.
>
> I agree and think that the module layout would look
also nicer.

I second that

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On Jun 12, 2007, at 5:06 AM, Andreas Pakulat wrote:

> Hi,
>
> apparently the new way of generating apidocs doesn't
work that well  
> with
> our current layout. Specifically the apidocs contain
the src entry and
> the various libraries under that. This doesn't look
nice and (more
> important) it triggers a bug (or missing feature,
however you want to
> put it) in KDevelop3's documentation part (the various
classes and  
> libs
> are not accesible at all).
>
> Now I can somewhat fix the bug by removing the
Mainpage.dox from the
> various lib-subdirs inside src (i.e. remove
src/interfaces  
> Mainpage.dox)
> and merge the information into src/Mainpage.dox. The
downside of  
> this is
> that we#d then have all classes inside the src-module
apidoc-wise  
> (i.e.
> the navigation sidebar has only src and all classes are
in that  
> list). I
> don't think thats really useful either.
>
> So I propose to remove src and put the various
libraries directly into
> the module, i.e. mv kdevplatform/src/interfaces
kdevplatform/ 
> interfaces.
> Thats the same as kdelibs does and provides nicer
apidoc pages and you
> don't need to patch kdevelop3's documentation plugin to
work with  
> this.
>
> Objections?
>
> Andreas


Sounds fine. Please do it ASAP.
--
Matt



_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On 12.06.07 18:23:04, Matt Rogers wrote:
> Sounds fine. Please do it ASAP.

Done, hope that was soon enough for you ;) Although I don't
think
ebn-docs will be up-to-date before tomorrow.

Andreas

-- 
Don't look now, but there is a multi-legged creature on your
shoulder.

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On Tuesday 12 June 2007 12:06:33 Andreas Pakulat wrote:
> Hi,
> Now I can somewhat fix the bug by removing the
Mainpage.dox from the
> various lib-subdirs inside src (i.e. remove
src/interfaces Mainpage.dox)
> and merge the information into src/Mainpage.dox.
I think that it is a very bad idea to have several
mainpage.dox
Especially because we only have one kdevplatform, so why
have multiple 
Mainpage.dox ?
It makes no sense to me.
If the page is about VCS why sould it be called
src/vcs/Mainpage.dox instead 
of vcs/vcspage.dox ?

> So I propose to remove src and put the various
libraries directly into
> the module, i.e. mv kdevplatform/src/interfaces
kdevplatform/interfaces.
Yes I agree with that.

I'm plaing to update the webserver and to start providing
API documentation 
updated every 3 hours, and I also plan to move the
documentation on the wiki
to the API, so that it is all concentrated in one location.

-- 
Amilcar Lucas
Webmaster
The KDevelop project

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On 14.06.07 12:34:53, Amilcar do Carmo Lucas wrote:
> On Tuesday 12 June 2007 12:06:33 Andreas Pakulat
wrote:
> > Hi,
> > Now I can somewhat fix the bug by removing the
Mainpage.dox from the
> > various lib-subdirs inside src (i.e. remove
src/interfaces Mainpage.dox)
> > and merge the information into src/Mainpage.dox.
> I think that it is a very bad idea to have several
mainpage.dox
> Especially because we only have one kdevplatform, so
why have multiple 
> Mainpage.dox ?
> It makes no sense to me.
> If the page is about VCS why sould it be called
src/vcs/Mainpage.dox instead 
> of vcs/vcspage.dox ?

Mainpage.dox is the description of each submodule of the KDE
module. I
don't think vcspage.dox makes any sense here. 

Also if we don't have Mainpage.dox the subdirs are not
parsed by the
doxygen.sh script and thus no apidox are generated. If you
want that to
be changed I suggest to talk to whoever set doxygen.sh up.

> > So I propose to remove src and put the various
libraries directly into
> > the module, i.e. mv kdevplatform/src/interfaces
kdevplatform/interfaces.
> Yes I agree with that.
> 
> I'm plaing to update the webserver and to start
providing API documentation 
> updated every 3 hours, and I also plan to move the
documentation on the wiki
> to the API, so that it is all concentrated in one
location.

Well, the important bits are already in the apidox, see the
Architecture.dox file. The only drawback here is that for
some reason
the ref's in that page doesn't create links.

Apart from that: Why do you want to generate the
documentation? Its
already generated on api.kde.org, so please just link to
that.

Andreas

-- 
Your present plans will be successful.

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On Thursday 14 June 2007 15:09:17 Andreas Pakulat wrote:
> Mainpage.dox is the description of each submodule of
the KDE module. I
> don't think vcspage.dox makes any sense here.
Isn't the submodule kdevplatform ?
Why is kdevplatform further subdivided ?

> Well, the important bits are already in the apidox, see
the
> Architecture.dox file. The only drawback here is that
for some reason
> the ref's in that page doesn't create links.
Maybe because of the excessive module subdivision ?

> Apart from that: Why do you want to generate the
documentation? Its
> already generated on api.kde.org, so please just link
to that.
Well, if it is correctly generated there, then we do not
need to redo it.

-- 
Amilcar Lucas
Webmaster
The KDevelop project

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel

On 14.06.07 15:32:47, Amilcar do Carmo Lucas wrote:
> On Thursday 14 June 2007 15:09:17 Andreas Pakulat
wrote:
> > Mainpage.dox is the description of each submodule
of the KDE module. I
> > don't think vcspage.dox makes any sense here.
> Isn't the submodule kdevplatform ?
> Why is kdevplatform further subdivided ?

No, kdevplatform is a top-level-KDE Module. 

KDevPlatform is subdivided because it contains multiple
libraries.

> > Well, the important bits are already in the
apidox, see the
> > Architecture.dox file. The only drawback here is
that for some reason
> > the ref's in that page doesn't create links.
> Maybe because of the excessive module subdivision ?

I don't think so, it was divided the same way when its was
still
kdevelop/lib/* and there Architecure.dox did cotain
cross-refs.

> > Apart from that: Why do you want to generate the
documentation? Its
> > already generated on api.kde.org, so please just
link to that.
> Well, if it is correctly generated there, then we do
not need to redo it.

It is, thats why I changed the kdevplatform apidoc stuff, so
it is
properly generated on the ebn (which is what api.kde.org
presents).

Andreas

-- 
It's a very *__UN*lucky week in which to be took dead.
		-- Churchy La Femme

_______________________________________________
KDevelop-devel mailing list
KDevelop-develkdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinf
o/kdevelop-devel