Skip to main content

lg3d doc

10 replies [Last post]
dwarfy
Offline
Joined: 2004-12-16
Points: 0

Hi everybody,

In my effort to understand the lg3d architecture, I've generated, using doxygen(1), a test documentation that I find pretty cool.

I did this during my work time,
so it is based on the 0.8.0 sources that I've found here(2) , I couldn't make a CVS checkout at my work, because of their dumb proxy (grr)...

If someone could take a look and tell me if it is interesting ? I will eventually regenerate the doc based on the latest CVS version when I'll find time to do the CVS checkout at home ..

here is a link to the doc : (removed see next messages)

and here a link to a zip file containing the whole documentation :
(removed see next messages)

Let me know what you think about it and if it should be updated ?

Mathieu aka Dwarfy

--
(1)http://www.stack.nl/~dimitri/doxygen/
(2)https://lg3d-core.dev.java.net/servlets/ProjectDocumentList?folderID=5319&expandFolder=5319&folderID=4306

Message was edited by: dwarfy

Reply viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
Krishna Gadepalli

Hi Mathieu

Since this doc is of most interest to developers, one option might be
for you to add a new target to build.xml to generate javadocs using
doxygen. If there is enough demand, we could let the nightly builds
generate them and upload them to the lg3d website

-krishna

lg3d@javadesktop.org said the following on 07/24/2006 03:49 PM:
> Hi Krishna!
> Nice to talk to the new lg3d owner ..
>
> Shouldn't it be unpacked on a server somewhere ? (the problem is that because of the great number of files and the big size of some class diagrams images it takes a looong time to upload on the webserver somebody )
>
> We could maybe change the header and footer of the page in order to make it more official?
>
> We could put the compressed doc too to make a kind of offline manual.
>
> Tell me what you think about it ?
>
> cheers
> Mathieu
>
> ps
> I don't think there are problems with the licence of doxygen but I'm not a lawyer :)
> [Message sent by forum member 'dwarfy' (dwarfy)]
>
> http://forums.java.net/jive/thread.jspa?messageID=135960
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: interest-unsubscribe@lg3d.dev.java.net
> For additional commands, e-mail: interest-help@lg3d.dev.java.net
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: interest-unsubscribe@lg3d.dev.java.net
For additional commands, e-mail: interest-help@lg3d.dev.java.net

dwarfy
Offline
Joined: 2004-12-16
Points: 0

Hi krishna

>Since this doc is of most interest to developers, one
>option might be for you to add a new target to build.xml
>to generate javadocs using doxygen.

I'm not sure to understand it right ?
Do you want to give the possibility to build the doc via a command like 'ant doc' ? we could do something like that but the problem is that we should then include the doxygen binaries in the cvs (its about 5 MB) so that's not much but it would be platform dependant. (there are binaries for linux/windows/macos/solaris on doxygen's website.)

Or maybe we should require doxygen to be installed on the developper's machine ?

Another problem is that building the docs take a certain amount of time (about 15 minutes on my machine at least) and I don't know if every developper would like to build it himself ?

I think maybe the best way would be to create a script that checkout everything from cvs and then create the docs and then upload them on some server and to run that script once a week or so on one of your servers...?

But as you said :

>If there is enough demand, we could let the nightly
>builds generate them and upload them to the lg3d website

We have to see if it interest somebody or not ... (or just me ;)

What do you think ?

Mathieu

dwarfy
Offline
Joined: 2004-12-16
Points: 0

Hi again !

about the licence, here is what is written on doxygen's website :

Doxygen license

Copyright © 1997-2006 by Dimitri van Heesch.

Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. See the GNU General Public License for more details.

Documents produced by doxygen are derivative works derived from the input used in their production; they are not affected by this license.

So I think it's ok ?

Mathieu

paulby
Offline
Joined: 2003-06-13
Points: 0

Lets assume that developers have doxygen installed rather than including the binary in the core cvs.

dwarfy
Offline
Joined: 2004-12-16
Points: 0

Hi again everybody.

I finally checked out lg3d-core and lg3d-demo-apps from CVS.
I rebuild the doc based on theses sources and changed some options (like including the whole source code in the docs).

And I tarbz2'ed it and posted it on my server here : http://dwarfy.bephp.com/lg3d/testdoc.tar.bz2
(16.7 MB)

I did not post all the files individualy in order to make it viewable directly online because the upload of the 4000+ files on my ftp is toooooooooo slow/buggy

Cheers
Dwarfy

Message was edited by: dwarfy

dwarfy
Offline
Joined: 2004-12-16
Points: 0

Hi all!
Nobody seems to have looked at my doc , sniff.
Well I think you should all download these 16 MB , it is worth it ! Their are heritage and collaboration diagrams for all the classes and it is definitively better than javadocs.

Doxygen is really a powerfull tool !

Mathieu

Krishna Gadepalli

Hi Mathieu
I did take a look at it last week - sorry for not replying.
I think the generated docs are pretty cool - especially the class
inheritance/collaboration diagrams.
I do think it is worthwhile putting up a link to it from the lg3d site.
-krishna

lg3d@javadesktop.org said the following on 07/21/2006 04:00 AM:
> Hi all!
> Nobody seems to have looked at my doc , sniff.
> Well I think you should all download these 16 MB , it is worth it ! Their are heritage and collaboration diagrams for all the classes and it is definitively better than javadocs.
>
> Doxygen is really a powerfull tool !
>
> Mathieu
> [Message sent by forum member 'dwarfy' (dwarfy)]
>
> http://forums.java.net/jive/thread.jspa?messageID=135062
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: interest-unsubscribe@lg3d.dev.java.net
> For additional commands, e-mail: interest-help@lg3d.dev.java.net
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: interest-unsubscribe@lg3d.dev.java.net
For additional commands, e-mail: interest-help@lg3d.dev.java.net

dwarfy
Offline
Joined: 2004-12-16
Points: 0

Hi Krishna!
Nice to talk to the new lg3d owner ..

Shouldn't it be unpacked on a server somewhere ? (the problem is that because of the great number of files and the big size of some class diagrams images it takes a looong time to upload on the webserver somebody )

We could maybe change the header and footer of the page in order to make it more official?

We could put the compressed doc too to make a kind of offline manual.

Tell me what you think about it ?

cheers
Mathieu

ps
I don't think there are problems with the licence of doxygen but I'm not a lawyer :)

dwarfy
Offline
Joined: 2004-12-16
Points: 0

pps:

>I think the generated docs are pretty cool - especially the >class inheritance/collaboration diagrams.

I like it too !
Thanks the doxygen tool.

:)
Dwarfy

dwarfy
Offline
Joined: 2004-12-16
Points: 0

I know it is certainly incomplete and incoherent
but it is just a test.

Maybe I've documented too much or not enough classes.
I've only generated doc for :
lg3d-core/src/classes/org/jdesktop/lg3d/*

If somebody has suggestion on adding class from some other places (lg3d-incubator, lg3d-x11 or else), let me know.

Mathieu