[x264-devel] Re: Doxygen and x264 ?

[Hautbois Jean-Michel]

I have generated the Doxygen documentation file.
There is a callgraph per function, that allows a better comprehension of
the mechanisms.
But I could not find any description of the x264_t structure ?
Some of the names are easy to understand, like *nal*, but I can't find
what means sps or pps, for example.
Is it possible to have a comment in this structure for future versions
of the library ?
It would really help me, and maybe others :).

Cheers.
_____________________
JM Hautbois
Thomson TSC Rennes
FRANCE

-----Original Message-----
From: x264-devel-bounce at videolan.org
[mailto:x264-devel-bounce at videolan.org] On Behalf Of Alex Izvorski
Sent: mardi 13 juin 2006 10:33
To: x264-devel at videolan.org
Subject: [x264-devel] Re: Doxygen and x264 ?

Hello,

On Tue, 2006-06-13 at 09:47 +0200, Hautbois Jean-Michel wrote:
> Hi there,
> I am currently reading the lib x264 code, in order to create an MPEG-2
> to H.264 transcoder.
> To help me in my researches, I wondered if it is possible/exists a
> doxygen documentation of this lib ?

You can generate documentation with doxygen, just using doxygen's mode
of documenting functions without special doxygen-style comments.  I have
done this and it works quite well.  Adding proper doxygen comments is
something I've always wanted to do but never had time for ;)

> Is there a callgraph ?

This may be interesting:

http://www.geocities.com/x264hack/x264-callgraph.png

This is a dynamic call-graph from an old version (approximately r285, I
think).  I used __cyg_profile_func_enter() and graphviz.  I need to dig
up all the tools I used to do this and produce a more up-to-date graph.

Generating a good static call graph would be quite difficult,
considering how many things are in stored in function pointers.

Regards,

Alex

> If it doesn't exist, I think I will do it.
> 
> Thx in advance !
> 
> _____________________
> JM Hautbois
> Thomson TSC Rennes
> FRANCE
> 

-- 
This is the x264-devel mailing-list
To unsubscribe, go to: http://developers.videolan.org/lists.html



-- 
This is the x264-devel mailing-list
To unsubscribe, go to: http://developers.videolan.org/lists.html



-- 
This is the x264-devel mailing-list
To unsubscribe, go to: http://developers.videolan.org/lists.html