Discussion:
[Clanlib-devel] CL0.9 features
Thomi Richards
2006-08-23 21:54:53 UTC
Permalink
Hi guys,

What are the main differences going to be between 0.8 and 0.9? For those of
us trying to work out how we should structure our applications this
information would be very useful.

Personally, the two biggest changes I'd like to see are:

* An improved resource system - one that allows developers to create custom
resources that contain many different ClanLib resources. At the moment the
custom resource system is very weak - it only allows you to create resources
with all new components. If you want t include a CL_Sprite as part of your
new resource, you're out of luck. (unless I'm missing something big here, in
which case I'd appreciate a heads-up).

* An improved GUI system, whereby each GUI component has a CL_Surface to
draw to, and the layout of those surfaces is andled by the GUI manager. I've
done a lot of wxWidgets development work, and one of the standout features
in that library is the system in place to allow developers to subclass
existing controls and change their appearance and / or behaivour. For
example, If i wanted to make a CL_Window with some background images, I
could subclass CL_Window, and draw images to it's builtin surface. Drawing
at 0,0 draws at the top-left corder of the widnow, not of the entire screen.

* Ok, so there's a third change... please please please use Doxygen style
comments for code documetnation. Doxygen can output to XML as well as a
number of different formats, so if you want to change the appearance and/or
organisation of your docs you can. Using a standard input format allows
others the choice of generating the docs the way they like them, rather than
being forced to use the current docs. Furthermore, it allows people like
myself to contribute missing documentation (since there's a set standard for
documentation).

Anyway, I'm more than happy to work on improving the CL code - perhaps I
could start with code documentation? If I get a green light I can start
submitting patches this week..


Thanks,
Ben Chambers
2006-08-26 02:53:40 UTC
Permalink
Post by Thomi Richards
* Ok, so there's a third change... please please please use Doxygen
style comments for code documetnation. Doxygen can output to XML as
well as a number of different formats, so if you want to change the
appearance and/or organisation of your docs you can. Using a standard
input format allows others the choice of generating the docs the way
they like them, rather than being forced to use the current docs.
Furthermore, it allows people like myself to contribute missing
documentation (since there's a set standard for documentation).
Just to clarify, ClanLib *does* use "a set standard for documentation",
and you can already contribute. The documentation is automatically
generated from tags in the ClanLib source itself.

Here's a question I don't know, however: is it possible to use both the
current documentation style, *and* Doxygen style tags? Then, we could
gradually migrate.

...Chambers
Thomi Richards
2006-08-26 05:27:04 UTC
Permalink
I take your point - there is a current standard, but (IMO) it's not a
*widely used* standard. I'd never heard of perlmod (or whatever it's
called) before looking at the CL sources.

As far as using the two together, at the moment Doxygen recognises the
comments as special comments, and extracts them. They rarely make
sense however, so while it may work, it's not going to produce nice
documentation until we go through the whole lot.

It can't be *that* much work, surely...one class at a time...
Post by Ben Chambers
Post by Thomi Richards
* Ok, so there's a third change... please please please use Doxygen
style comments for code documetnation. Doxygen can output to XML as
well as a number of different formats, so if you want to change the
appearance and/or organisation of your docs you can. Using a standard
input format allows others the choice of generating the docs the way
they like them, rather than being forced to use the current docs.
Furthermore, it allows people like myself to contribute missing
documentation (since there's a set standard for documentation).
Just to clarify, ClanLib *does* use "a set standard for documentation",
and you can already contribute. The documentation is automatically
generated from tags in the ClanLib source itself.
Here's a question I don't know, however: is it possible to use both the
current documentation style, *and* Doxygen style tags? Then, we could
gradually migrate.
...Chambers
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
clanlib-devel mailing list
https://lists.sourceforge.net/lists/listinfo/clanlib-devel
Kenneth Gangstoe
2006-08-26 10:51:36 UTC
Permalink
To clarify, ClanLib 0.9 *use* doxygen for its documentation generator. It
just doesn't use the standard output. The core developers of ClanLib
actually think the "standard" doxygen output is rather bad.

Just because the
entire linux world think Doxygen rules their world, doesn't mean it's
the most suiting format for everything.
Since we're using the Doxygen XML output, feel free to generate the exact
documentation you want. Just don't do it because
"everyone" else is doing it, do it because it would give the best
information in the best way.

- Kenneth
Post by Thomi Richards
I take your point - there is a current standard, but (IMO) it's not a
*widely used* standard. I'd never heard of perlmod (or whatever it's
called) before looking at the CL sources.
As far as using the two together, at the moment Doxygen recognises the
comments as special comments, and extracts them. They rarely make
sense however, so while it may work, it's not going to produce nice
documentation until we go through the whole lot.
It can't be *that* much work, surely...one class at a time...
Post by Ben Chambers
Post by Thomi Richards
* Ok, so there's a third change... please please please use Doxygen
style comments for code documetnation. Doxygen can output to XML as
well as a number of different formats, so if you want to change the
appearance and/or organisation of your docs you can. Using a standard
input format allows others the choice of generating the docs the way
they like them, rather than being forced to use the current docs.
Furthermore, it allows people like myself to contribute missing
documentation (since there's a set standard for documentation).
Just to clarify, ClanLib *does* use "a set standard for documentation",
and you can already contribute. The documentation is automatically
generated from tags in the ClanLib source itself.
Here's a question I don't know, however: is it possible to use both the
current documentation style, *and* Doxygen style tags? Then, we could
gradually migrate.
...Chambers
-------------------------------------------------------------------------
Post by Ben Chambers
Using Tomcat but need to do more? Need to support web services,
security?
Post by Ben Chambers
Get stuff done quickly with pre-integrated technology to make your job
easier
Post by Ben Chambers
Download IBM WebSphere Application Server v.1.0.1 based on Apache
Geronimo
Post by Ben Chambers
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
clanlib-devel mailing list
https://lists.sourceforge.net/lists/listinfo/clanlib-devel
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
clanlib-devel mailing list
https://lists.sourceforge.net/lists/listinfo/clanlib-devel
Thomi Richards
2006-08-26 19:16:56 UTC
Permalink
Oh..


My mistake.

I thought someone told me you were using the same documentation stuff
as in 0.8. Apologies all round.

In that case, may I assume that the developers are open to
documentation patches?



Thanks,
Post by Kenneth Gangstoe
To clarify, ClanLib 0.9 *use* doxygen for its documentation generator. It
just doesn't use the standard output. The core developers of ClanLib
actually think the "standard" doxygen output is rather bad.
Just because the entire linux world think Doxygen rules
their world, doesn't mean it's the most
suiting format for everything.
Since we're using the Doxygen XML output, feel free to generate the exact
documentation you want. Just don't do it because
"everyone" else is doing it, do it because it would give the best
information in the best way.
- Kenneth
I take your point - there is a current standard, but (IMO) it's not a
*widely used* standard. I'd never heard of perlmod (or whatever it's
called) before looking at the CL sources.
As far as using the two together, at the moment Doxygen recognises the
comments as special comments, and extracts them. They rarely make
sense however, so while it may work, it's not going to produce nice
documentation until we go through the whole lot.
It can't be *that* much work, surely...one class at a time...
Post by Ben Chambers
Post by Thomi Richards
* Ok, so there's a third change... please please please use Doxygen
style comments for code documetnation. Doxygen can output to XML as
well as a number of different formats, so if you want to change the
appearance and/or organisation of your docs you can. Using a standard
input format allows others the choice of generating the docs the way
they like them, rather than being forced to use the current docs.
Furthermore, it allows people like myself to contribute missing
documentation (since there's a set standard for documentation).
Just to clarify, ClanLib *does* use "a set standard for documentation",
and you can already contribute. The documentation is automatically
generated from tags in the ClanLib source itself.
Here's a question I don't know, however: is it possible to use both the
current documentation style, *and* Doxygen style tags? Then, we could
gradually migrate.
...Chambers
-------------------------------------------------------------------------
Post by Ben Chambers
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job
easier
Post by Ben Chambers
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
Post by Ben Chambers
_______________________________________________
clanlib-devel mailing list
https://lists.sourceforge.net/lists/listinfo/clanlib-devel
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
clanlib-devel mailing list
https://lists.sourceforge.net/lists/listinfo/clanlib-devel
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
clanlib-devel mailing list
https://lists.sourceforge.net/lists/listinfo/clanlib-devel
Loading...