[gst-devel] API reference updating for 0.9 -- your help needed!
Stefan Kost
ensonic at hora-obscura.de
Mon Oct 31 04:55:58 CET 2005
Hi Andy,
> Hey all,
>
-- snip --
> * Anyone else with CVS commit access but who does not feel
> comfortable reviewing content can help out greatly by making the
> existing docs more consistent. For example, change this:
> * @pad: the #GstPad to stop the task of
> to:
> * @pad: a #GstPad
> and the other guidelines listed in [1].
I missed that discussion. Whats the rationale behint. Imagine a function
gst_foo_copy(GstFoo *src, GstFoo *dst)
then docs saying
* @src: a #GstFoo
* @dst: a #GstFoo
are imho not very useful, as GtkDoc adds links to the type docs (GstFoo) inside
the prototye avove anyway.
Stefan
More information about the gstreamer-devel
mailing list