Bug 79798 - Various glib documentation patches
Summary: Various glib documentation patches
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: 2014-06-08 14:24 UTC by Hib Eris
Modified: 2015-12-03 10:03 UTC (History)
1 user (show)

See Also:
i915 platform:
i915 features:


Attachments
[glib] doc: Move PopplerColor documentation to it's own section (2.60 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Move poppler_get_{version, backend} documentation to features section (1.42 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Move PopplerError to PopplerDocument section (1.56 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Move PopplerPrintFlags to PopplerPage section (1.61 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Move PopplerFindFlags to PopplerPage section (1.45 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Add poppler_annot_set_flags() to documentation (774 bytes, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Fix typo (839 bytes, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Add missing POPPLER_TYPE_POINT (1.55 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Add PopplerBackend documentation (939 bytes, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Use <emphasis> instead of <em> (1.17 KB, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Document PopplerFindFlags:POPPLER_FIND_DEFAULT (925 bytes, patch)
2014-06-08 14:24 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Move PopplerError to PopplerDocument section (1.63 KB, patch)
2014-06-08 15:12 UTC, Hib Eris
Details | Splinter Review
[glib] doc: Move poppler_date_parse to utility functions section (1.54 KB, patch)
2014-06-08 15:16 UTC, Hib Eris
Details | Splinter Review
For download convenience, all patches in one file (16.45 KB, patch)
2014-06-08 15:23 UTC, Hib Eris
Details | Splinter Review

Description Hib Eris 2014-06-08 14:24:19 UTC

    
Comment 1 Hib Eris 2014-06-08 14:24:23 UTC
Created attachment 100661 [details] [review]
[glib] doc: Move PopplerColor documentation to it's own section
Comment 2 Hib Eris 2014-06-08 14:24:27 UTC
Created attachment 100662 [details] [review]
[glib] doc: Move poppler_get_{version, backend} documentation to features section
Comment 3 Hib Eris 2014-06-08 14:24:30 UTC
Created attachment 100663 [details] [review]
[glib] doc: Move PopplerError to PopplerDocument section
Comment 4 Hib Eris 2014-06-08 14:24:33 UTC
Created attachment 100664 [details] [review]
[glib] doc: Move PopplerPrintFlags to PopplerPage section
Comment 5 Hib Eris 2014-06-08 14:24:36 UTC
Created attachment 100665 [details] [review]
[glib] doc: Move PopplerFindFlags to PopplerPage section

And also add the missing POPPLER_TYPE_FIND_FLAGS and poppler_find_flags_get_type.
Comment 6 Hib Eris 2014-06-08 14:24:39 UTC
Created attachment 100666 [details] [review]
[glib] doc: Add poppler_annot_set_flags() to documentation
Comment 7 Hib Eris 2014-06-08 14:24:42 UTC
Created attachment 100667 [details] [review]
[glib] doc: Fix typo
Comment 8 Hib Eris 2014-06-08 14:24:45 UTC
Created attachment 100668 [details] [review]
[glib] doc: Add missing POPPLER_TYPE_POINT

And while we are here, also move poppler_point_get_type() and
poppler_quadrilateral_get_type() to private subsection.
Comment 9 Hib Eris 2014-06-08 14:24:47 UTC
Created attachment 100669 [details] [review]
[glib] doc: Add PopplerBackend documentation
Comment 10 Hib Eris 2014-06-08 14:24:50 UTC
Created attachment 100670 [details] [review]
[glib] doc: Use <emphasis> instead of <em>

Fixes:
  DOC   Building HTML
Element em in namespace '' encountered in para, but no template matches.
Comment 11 Hib Eris 2014-06-08 14:24:54 UTC
Created attachment 100671 [details] [review]
[glib] doc: Document PopplerFindFlags:POPPLER_FIND_DEFAULT

Fixes warning:
  DOC   Building XML
../../glib/poppler.h:157: warning: Value description for
PopplerFindFlags::POPPLER_FIND_DEFAULT is missing in source code comment
block.
Comment 12 Hib Eris 2014-06-08 15:12:52 UTC
Created attachment 100675 [details] [review]
[glib] doc: Move PopplerError to PopplerDocument section
Comment 13 Hib Eris 2014-06-08 15:16:47 UTC
Created attachment 100676 [details] [review]
[glib] doc: Move poppler_date_parse to utility functions section
Comment 14 Hib Eris 2014-06-08 15:23:11 UTC
Created attachment 100677 [details] [review]
For download convenience, all patches in one file

For applying with 'git am'.
Comment 15 Hib Eris 2014-06-09 11:39:38 UTC
You can fetch these patches from my public git repository with:

git fetch git@gitorious.org:hiberis/poppler.git bfo-79798 && git checkout -b bfo-79798 FETCH_HEAD
Comment 16 Hib Eris 2014-06-09 11:45:35 UTC
(In reply to comment #15)
> You can fetch these patches from my public git repository with:
> 
> git fetch git@gitorious.org:hiberis/poppler.git bfo-79798 && git checkout -b
> bfo-79798 FETCH_HEAD

Whoops, that should be:

git fetch git://gitorious.org/hiberis/poppler.git bfo-79798 && git checkout -b bfo-79798 FETCH_HEAD
Comment 17 Carlos Garcia Campos 2014-06-09 13:15:31 UTC
Comment on attachment 100675 [details] [review]
[glib] doc: Move PopplerError to PopplerDocument section

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

I'm not sure about this one, while it's tru that it's only used for document related errors, it's still PopplerError and not PopplerDocumentError, it might be expanded in the future for other errors. I've pushed all other patches to git master. Thanks!
Comment 18 Hib Eris 2014-06-09 15:30:56 UTC
(In reply to comment #17)
> Comment on attachment 100675 [details] [review] [review]
> [glib] doc: Move PopplerError to PopplerDocument section
> 
> Review of attachment 100675 [details] [review] [review]:
> -----------------------------------------------------------------
> 
> I'm not sure about this one, while it's tru that it's only used for document
> related errors, it's still PopplerError and not PopplerDocumentError, it
> might be expanded in the future for other errors. I've pushed all other
> patches to git master. Thanks!

How about moving it to it's own section then? I've provided a patch to do that in 
#79837 .
Comment 19 Hib Eris 2014-06-09 15:31:31 UTC
How about moving it to it's own section then? I've provided a patch to do that in 
bug 79837.
Comment 20 Carlos Garcia Campos 2015-12-03 10:03:08 UTC
I pushed all the patches in bug #79837, if there's anything pending, please reopen the bug.


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.