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 704250 - Doc: various fixes
Doc: various fixes
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.37.x
Other Linux
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2013-07-15 13:45 UTC by Sébastien Wilmet
Modified: 2013-07-20 09:11 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Improve documentation (2.84 KB, patch)
2013-07-15 13:45 UTC, Sébastien Wilmet
committed Details | Review
GRegex: update documentation for partial matching (2.26 KB, patch)
2013-07-15 13:45 UTC, Sébastien Wilmet
committed Details | Review

Description Sébastien Wilmet 2013-07-15 13:45:07 UTC
Various fixes to the API documentation.
Comment 1 Sébastien Wilmet 2013-07-15 13:45:39 UTC
Created attachment 249199 [details] [review]
Improve documentation

- Mention G_SOURCE_CONTINUE and G_SOURCE_REMOVE in the GSourceFunc doc;
- Mention G_PARAM_READWRITE and G_PARAM_STATIC_STRINGS in the
  GParamFlags doc;
- Fix "Since:" version for G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE;
- Fix typo.
Comment 2 Sébastien Wilmet 2013-07-15 13:45:43 UTC
Created attachment 249200 [details] [review]
GRegex: update documentation for partial matching

The restrictions on partial matching no longer apply with PCRE >= 8.00.

The pcrepartial manpage contains the "FORMERLY RESTRICTED PATTERNS"
section:

"For  releases  of PCRE prior to 8.00, because of the way certain
internal optimizations were implemented in the pcre_exec() function, the
PCRE_PARTIAL option (predecessor of PCRE_PARTIAL_SOFT) could not be used
with all patterns. From release 8.00 onwards, the restrictions no
longer  apply,  and  partial  matching  with  can  be requested for any
pattern."
Comment 3 Matthias Clasen 2013-07-19 23:27:17 UTC
Review of attachment 249199 [details] [review]:

Looks good

::: glib/gmain.h
@@ +151,3 @@
  *
+ * Returns: %FALSE if the source should be removed. #G_SOURCE_CONTINUE and
+ * #G_SOURCE_REMOVE are more meaningful names for the return value.

Maybe 'memorable' would be a better term here ?
Comment 4 Matthias Clasen 2013-07-19 23:28:50 UTC
Review of attachment 249200 [details] [review]:

sure
Comment 5 Sébastien Wilmet 2013-07-20 09:11:39 UTC
Thanks for the review. I've changed meaningful -> memorable.