Re: [Libvisual-devel] Technical documentation

[Dennis S. <sy...@yo...>]

Moin, I think we should start up a documentation and information
strategy. We're getting lack of information complaints more often
recently. Some people manage very well, but these often have
extraordinary experience with programming and the concepts of topic.
So for them an API reference is anough.

I think we have to do the following:
1. Explain the API reference with more information, and include a start
page within that explains the basic setup.

2. Create docbooks that are written in tutorial style, for application
development, and plugin development.

3. Start up an online WIKI (using mediawiki software) so we can share
thoughts, documents, howtos, and todos over there. (When one will
come I plan to only allow edits for people who subscribe, since
wiki vandalism is completely cool nowadays)

On the object_destroy, it's true but it's best to exclusively
always use: visual_object_unref (VISUAL_OBJECT (object)); Only
use _destroy if you REALLY know what you're doing :)

Cheers,
Dennis



On Sat, 2005-02-26 at 12:20 -0500, Duilio J. Protti wrote:
> Is true, the examples are really out of date, but that's because they
> are not included on the distro, and libvisual is under heavy
> development, so API changes occur very often.
> 
> visual_bin_destroy() was deprecated when libvisual moves to his new
> object-model. Now almost every datatype is whithin an object, so
> destruction is made on a generic fashion through visual_object_destroy
> ().
> 
> To compile a program which's is using libvisual, just pass the result of
> `pkg-config libvisual --cflags` to you compiler, and for to link against
> libvisual, pass the result of `pkg-config libvisual --libs` to the
> linker.
> 
> And you are right, we need a tutorial and probably a FAQ too!
> 
> 
> Bye,
> Duilio.