Bug 45549 - poppler-glib API documentation improvements
Summary: poppler-glib API documentation improvements
Status: RESOLVED FIXED
Alias: None
Product: poppler
Classification: Unclassified
Component: glib frontend (show other bugs)
Version: unspecified
Hardware: All All
: medium normal
Assignee: poppler-bugs
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-02-02 07:52 UTC by Hib Eris
Modified: 2012-02-04 03:06 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments
0001-gtk-doc-Fix-typo-s.patch (6.18 KB, patch)
2012-02-02 07:53 UTC, Hib Eris
Details | Splinter Review
0002-gtk-doc-do-not-build-doc-for-glib-demo.patch (756 bytes, patch)
2012-02-02 07:54 UTC, Hib Eris
Details | Splinter Review
0003-gtk-doc-remove-references-to-removed-pixbuf-function.patch (2.14 KB, patch)
2012-02-02 07:54 UTC, Hib Eris
Details | Splinter Review
0004-gtk-doc-Add-more-glib-API-documentation-for-poppler-.patch (2.85 KB, patch)
2012-02-02 07:55 UTC, Hib Eris
Details | Splinter Review
0005-NOT-SURE-ABOUT-THIS-gtk-doc-Fix-API-documentation-fo.patch (870 bytes, patch)
2012-02-02 07:55 UTC, Hib Eris
Details | Splinter Review
0006-ALSO-NOT-SURE-ABOUT-THIS-ONE-gtk-doc-Fix-API-documen.patch (1.04 KB, patch)
2012-02-02 07:56 UTC, Hib Eris
Details | Splinter Review
0007-gtk-doc-Fix-build-when-builddir-srcdir.patch (1.21 KB, patch)
2012-02-02 07:56 UTC, Hib Eris
Details | Splinter Review
0008-glib-Add-POPPLER_DISABLE_DEPRECATED-guards-around-de.patch (3.09 KB, patch)
2012-02-02 07:57 UTC, Hib Eris
Details | Splinter Review

Description Hib Eris 2012-02-02 07:52:51 UTC
Hi,

I have some patches to improve the poppler-glib API docs.
Comment 1 Hib Eris 2012-02-02 07:53:46 UTC
Created attachment 56523 [details] [review]
0001-gtk-doc-Fix-typo-s.patch
Comment 2 Hib Eris 2012-02-02 07:54:12 UTC
Created attachment 56524 [details] [review]
0002-gtk-doc-do-not-build-doc-for-glib-demo.patch
Comment 3 Hib Eris 2012-02-02 07:54:49 UTC
Created attachment 56525 [details] [review]
0003-gtk-doc-remove-references-to-removed-pixbuf-function.patch
Comment 4 Hib Eris 2012-02-02 07:55:13 UTC
Created attachment 56526 [details] [review]
0004-gtk-doc-Add-more-glib-API-documentation-for-poppler-.patch
Comment 5 Hib Eris 2012-02-02 07:55:42 UTC
Created attachment 56527 [details] [review]
0005-NOT-SURE-ABOUT-THIS-gtk-doc-Fix-API-documentation-fo.patch
Comment 6 Hib Eris 2012-02-02 07:56:11 UTC
Created attachment 56528 [details] [review]
0006-ALSO-NOT-SURE-ABOUT-THIS-ONE-gtk-doc-Fix-API-documen.patch
Comment 7 Hib Eris 2012-02-02 07:56:42 UTC
Created attachment 56530 [details] [review]
0007-gtk-doc-Fix-build-when-builddir-srcdir.patch
Comment 8 Hib Eris 2012-02-02 07:57:05 UTC
Created attachment 56531 [details] [review]
0008-glib-Add-POPPLER_DISABLE_DEPRECATED-guards-around-de.patch
Comment 9 Carlos Garcia Campos 2012-02-04 02:52:28 UTC
Comment on attachment 56527 [details] [review]
0005-NOT-SURE-ABOUT-THIS-gtk-doc-Fix-API-documentation-fo.patch

Review of attachment 56527 [details] [review]:
-----------------------------------------------------------------

::: glib/poppler-document.cc
@@ +2359,4 @@
>   * @iter: a #PopplerLayersIter
>   * 
>   * Returns the #PopplerLayer associated with @iter.  It must be freed with
> + * g_object_unref().

Yes, this is correct. Return value has the transfer full annotation and it says it returns a new #PopplerLayer, which is a GObject, so I think it's obvious you have to use g_object_unref(), so I've simply removed the whole sentence.
Comment 10 Carlos Garcia Campos 2012-02-04 02:57:10 UTC
Comment on attachment 56528 [details] [review]
0006-ALSO-NOT-SURE-ABOUT-THIS-ONE-gtk-doc-Fix-API-documen.patch

Review of attachment 56528 [details] [review]:
-----------------------------------------------------------------

This is correct
Comment 11 Carlos Garcia Campos 2012-02-04 03:02:25 UTC
Comment on attachment 56531 [details] [review]
0008-glib-Add-POPPLER_DISABLE_DEPRECATED-guards-around-de.patch

Review of attachment 56531 [details] [review]:
-----------------------------------------------------------------

I prefer to follow glib/gtk approach of using compile warnings, gtk-doc warnings about deprecation guards are harmless anyway.
Comment 12 Carlos Garcia Campos 2012-02-04 03:06:26 UTC
Pushed everything except the deprecation guards patch. Thank you very much!


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.