GtkDoc infrastructure set in place

"Victor Mierla" <[email protected]> Sun, 26 Oct 2008 21:15:42 +0200
Newsgroups gmane.comp.scigraphica.gtkextra
Message-ID <[email protected]>
Adrian

After a considerable hackathon , the infrastructure for GtkDoc reference and 
Docbook tutorials is set in place.

This is status for porting docs to GtkDoc - my part as we agreed.
- GtkBorderCombo : 100%
- GtkCharSel : 100%
- GtkCheckItem : 100%
- GtkComboBox : 100%
- GtkFileList : 100%
- GtkFontCombo : 100%
- GtkIconFileSelection : 100%
- GtkIconList : 100%
- GtkPSFont : 100%
- GtkToggleCombo : 100%

The GtkSheet tutorial was also ported to DocBook SGML.

This porting implied quite extensive modifications of source code and 
configure.in , Makefile.am files and directory structures.
So i suggest you rm -rf your local gtkextra-3 and cvs checkout it freshly 
from CVS.

I also added initial support for Tiny C Compiler (tcc). Tcc is a little speed 
daemon compared to gcc , i got bored waiting for gcc to finish compiling 
GtkExtra and that's why i modified some .c files to compile under it.
Modifications are marked with /* Tiny C Compiler support*/
With tcc GtkExtra is compiling  2.5xtimes faster than gcc.

There are a couple of FIXME's in source code + there gtk_psfont_unref() twice.
I commented the second one to allow gtkpsfont.c to compile.
It would be nice if you could fix those.

TODO list:

TUTORIAL:
- GtkSheet tutorial : implement gtkstyle.css . The standard style coming with 
docbook-utils package is pretty boring. I still have to find out how to 
integrate CSS style definition in gtkextra-tutorial.sgml  file.
For example C code snippets must have a different background color and there 
must be support for underline.
- GtkPlot tutorial : For now it's STUB. Someone has to write it.

REFERENCE:
- GtkPlot* GtkDoc definitions in source code. I thought that Dan Gruhn would 
do it , but he didn't, so i will start working on it.

SOURCE CODE:
- finalise Tiny C Compiler support: This implies figuring out how to make 
libtool not pass --export-dynamic and --rpath to tcc.There is also a bug in 
tcc linker which complains about 2 identical symbols, but this can be 
resolved by using GNU LD. For now if you want to play with tcc, you must 
export CC=/usr/bin/tcc and editing libtool file and remove --export-dynamic 
and --rpath entries.
- Not so near future: We need a new GtkSheet that is comparable with modern 
sheets (API and functionality). The new GtkSheet must support properties , 
multi-line and other stuff. This new GtkSheet will not be API-compatible with 
the old one . The new GtkSheet will start as a "fork" of the old one.

SO if anyone wants to see how the docs looks now in the new format just do 
like this:

cvs -d:pserver:[email protected]:/cvsroot/gtkextra login 
cvs -z3 -d:pserver:[email protected]:/cvsroot/gtkextra 
co -P gtkextra-3
autoreconf -i -f
./autogen.sh --enable-gtk-doc
make

and go to docs/reference/html and docs/tutorial.
Be sure that you have docbook, gtk-doc and all dependencies installed(see 
README files for details)

I will post another mail after i finished with GtkPlot* definitions in source 
code so Adrian can look at them so we could finalise the docs.


Victor



--------------------------------------------------

Flash.ro - Best free webmail service hosted by Idilis
.........................................................
Idilis - Internet Provider :: www.idilis.net
Inchiriem conexiuni radio si in zone neracordate la coloana - Broadband Wireless Idilis -




-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/