[XviD-devel] Documentation of xvidcore...

[Edouard Gomez]

Christoph Lampert (chl at math.uni-bonn.de) wrote:
> Have you ever though of making the Doc a Wiki, so everybody can contribute
> when he has a spare minute ?

A wiki isn't appropriate for docbook writing :-)

> Hm, yes, maybe there should be a separate section for the listings, or 
> even a separate page.

At the moment the xvid_global reference is nearl ystandalone
in the document, just pointed at by the decoder init page, but
the plan was to have a kinda tutorial approach in decoder and
encoder chapters, and the APU functions reference would have
been like a man page (i use the docbook tags aimed at manpages
for that, so...)

So in my plan, the decoder and encoder chapters would have
been more verbose, would have develop a bit further the
parameter description seen as a library user, and the API
reference would just have been a quick ref (just like man
printf is, it tells evrything, but it's quite short in
additional explainations)

> For this xvid_global, it's not too much of a  problem,
> you can skip the parts if you don't want them, but in general 
> and for the structure with many entries, it might be better.

Dunno if it's good to dispatch information on too numerous
pages.

> A raw download link to the examples would be nice as well, so
> one doesn't  have to copy-paste.

I don't think docbook allows that as all the content is
inlined. So unless i keep a copy of the inlined examples in
separates files, i doubt this is possible.

-- 
Edouard Gomez