After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 764314 - docs: generate vaapijpegdec documentation
docs: generate vaapijpegdec documentation
Status: RESOLVED FIXED
Product: GStreamer
Classification: Platform
Component: gstreamer-vaapi
unspecified
Other All
: Normal normal
: 1.9.1
Assigned To: GStreamer Maintainers
GStreamer Maintainers
Depends on:
Blocks:
 
 
Reported: 2016-03-29 15:36 UTC by Víctor Manuel Jáquez Leal
Modified: 2016-04-29 08:41 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
docs: generate vaapijpegdec documentation (2.99 KB, patch)
2016-03-29 15:36 UTC, Víctor Manuel Jáquez Leal 		committed Details | Review

Description Víctor Manuel Jáquez Leal 2016-03-29 15:36:09 UTC 
Because of the split of vaapijpegdec from vaapidecode the gtk-doc element page
was missing. This patch enables the documentation autogeneration.
Comment 1 Víctor Manuel Jáquez Leal 2016-03-29 15:36:13 UTC 
Created attachment 324946 [details] [review]
docs: generate vaapijpegdec documentation
Comment 2 Tim-Philipp Müller 2016-03-29 17:06:23 UTC 
Comment on attachment 324946 [details] [review]
docs: generate vaapijpegdec documentation

Looks good to me, any reason you didn't just push it?
Comment 3 Víctor Manuel Jáquez Leal 2016-03-30 08:02:44 UTC 
(In reply to Tim-Philipp Müller from comment #2)
> Comment on attachment 324946 [details] [review] [review]
> docs: generate vaapijpegdec documentation
> 
> Looks good to me, any reason you didn't just push it?

Actually, yes, thanks for asking. I don't feel right to document each split element from GstVaapiDecode in gstvaapidecode.c

I was wondering, but I didn't dig on it, if it is possible to write that documentation in another file.
Comment 4 Víctor Manuel Jáquez Leal 2016-03-30 14:24:21 UTC 
after experimenting a bit, I guess this patch is the simplest solution. I'll push it now.
Comment 5 Víctor Manuel Jáquez Leal 2016-03-30 14:25:36 UTC 
Attachment 324946 [details] pushed as aac0f50 - docs: generate vaapijpegdec documentation
Comment 6 Tim-Philipp Müller 2016-03-30 17:19:17 UTC 
I think gtk-doc doesn't care where it picks up the docs blurbs from, you could just make a separate .c file for the docs or one for each decoder if you wanted to. Just have to tell gtk-doc to scan it.