How to make newly added header be parsed by gtk-doc

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

How to make newly added header be parsed by gtk-doc

Alexey Chernov
Hello,

I'm adding some functionality to v4l2 plugin in gst-plugins-good (radio
element to be more exact, it was previously discussed here).  The task is near
the end, but I can't add my header (it is sys/v4l2/gstv4l2radio.h) to be
parsed by gtk-doc when --enable-gtk-doc option is on. It seem to be simply
ignored but I can't understand where it should be added to be parsed - in
docs/ directory many files seem to be generated automatically.

Could someone please give me any reference where I should add this header
file's path or something to make it be parsed by gtk-doc?

Thanks in advance.

------------------------------------------------------------------------------
Protect Your Site and Customers from Malware Attacks
Learn about various malware tactics and how to avoid them. Understand
malware threats, the impact they can have on your business, and how you
can protect your company and customers by using code signing.
http://p.sf.net/sfu/oracle-sfdevnl
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel
Reply | Threaded
Open this post in threaded view
|

Re: How to make newly added header be parsed by gtk-doc

Tim-Philipp Müller-2
On Thu, 2011-01-20 at 00:17 +0300, Alexey Chernov wrote:

> I'm adding some functionality to v4l2 plugin in gst-plugins-good (radio
> element to be more exact, it was previously discussed here).  The task is near
> the end, but I can't add my header (it is sys/v4l2/gstv4l2radio.h) to be
> parsed by gtk-doc when --enable-gtk-doc option is on. It seem to be simply
> ignored but I can't understand where it should be added to be parsed - in
> docs/ directory many files seem to be generated automatically.
>
> Could someone please give me any reference where I should add this header
> file's path or something to make it be parsed by gtk-doc?

Maybe doc/plugins/Makefile.am, but it shouldn't really be necessary
(might make the private element struct show up though).

Cheers
 -Tim


------------------------------------------------------------------------------
Protect Your Site and Customers from Malware Attacks
Learn about various malware tactics and how to avoid them. Understand
malware threats, the impact they can have on your business, and how you
can protect your company and customers by using code signing.
http://p.sf.net/sfu/oracle-sfdevnl
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel
Reply | Threaded
Open this post in threaded view
|

Re: How to make newly added header be parsed by gtk-doc

Alexey Chernov
Thanks, Tim,

I finally found the right files, don't really sure if it is necessary to include
adding of documentation to build in the patch. For any case, the files are the
following (in docs/plugins):

<module>-plugins-section.txt - one should add separate <SECTION> to make xml
be built;
<module>-plugins-docs.sgml - one should add xi:include here to keep a
reference to xml;
inspect/plugin-<plugin-name>.xml - one should add separate <element> section
for each element with documentation to generate, the section contains brief
description and some details.

On Thursday 20 January 2011 22:54:49 you wrote:

> On Thu, 2011-01-20 at 00:17 +0300, Alexey Chernov wrote:
> > I'm adding some functionality to v4l2 plugin in gst-plugins-good (radio
> > element to be more exact, it was previously discussed here).  The task is
> > near the end, but I can't add my header (it is sys/v4l2/gstv4l2radio.h)
> > to be parsed by gtk-doc when --enable-gtk-doc option is on. It seem to
> > be simply ignored but I can't understand where it should be added to be
> > parsed - in docs/ directory many files seem to be generated
> > automatically.
> >
> > Could someone please give me any reference where I should add this header
> > file's path or something to make it be parsed by gtk-doc?
>
> Maybe doc/plugins/Makefile.am, but it shouldn't really be necessary
> (might make the private element struct show up though).
>
> Cheers
>  -Tim

------------------------------------------------------------------------------
Special Offer-- Download ArcSight Logger for FREE (a $49 USD value)!
Finally, a world-class log management solution at an even better price-free!
Download using promo code Free_Logger_4_Dev2Dev. Offer expires
February 28th, so secure your free ArcSight Logger TODAY!
http://p.sf.net/sfu/arcsight-sfd2d
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel