luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-05-04 13:06:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move GRegex SECTION

Browse Source 
Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 08:38:44 -04:00 committed by Philip Withnall
parent 45f6f43fc6
commit a47bdb2638
2 changed files with 16 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
glib/gregex.c
View File

@ -40,14 +40,12 @@
#include "gthread.h" #include "gthread.h"
/** /**
* SECTION:gregex * GRegex:
* @title: Perl-compatible regular expressions
* @short_description: matches strings against regular expressions
* @see_also: [Regular expression syntax][glib-regex-syntax]
* *
* The g_regex_*() functions implement regular * A `GRegex` is the "compiled" form of a regular expression pattern.
* expression pattern matching using syntax and semantics similar to *
* Perl regular expression. * `GRegex` implements regular expression pattern matching using syntax and
* semantics similar to Perl regular expression.
* *
* Some functions accept a @start_position argument, setting it differs * Some functions accept a @start_position argument, setting it differs
* from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL * from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL
@ -81,23 +79,23 @@
* The behaviour of the dot, circumflex, and dollar metacharacters are * The behaviour of the dot, circumflex, and dollar metacharacters are
* affected by newline characters, the default is to recognize any newline * affected by newline characters, the default is to recognize any newline
* character (the same characters recognized by "\R"). This can be changed * character (the same characters recognized by "\R"). This can be changed
* with %G_REGEX_NEWLINE_CR, %G_REGEX_NEWLINE_LF and %G_REGEX_NEWLINE_CRLF * with `G_REGEX_NEWLINE_CR`, `G_REGEX_NEWLINE_LF` and `G_REGEX_NEWLINE_CRLF`
* compile options, and with %G_REGEX_MATCH_NEWLINE_ANY, * compile options, and with `G_REGEX_MATCH_NEWLINE_ANY`,
* %G_REGEX_MATCH_NEWLINE_CR, %G_REGEX_MATCH_NEWLINE_LF and * `G_REGEX_MATCH_NEWLINE_CR`, `G_REGEX_MATCH_NEWLINE_LF` and
* %G_REGEX_MATCH_NEWLINE_CRLF match options. These settings are also * `G_REGEX_MATCH_NEWLINE_CRLF` match options. These settings are also
* relevant when compiling a pattern if %G_REGEX_EXTENDED is set, and an * relevant when compiling a pattern if `G_REGEX_EXTENDED` is set, and an
* unescaped "#" outside a character class is encountered. This indicates * unescaped "#" outside a character class is encountered. This indicates
* a comment that lasts until after the next newline. * a comment that lasts until after the next newline.
* *
* Creating and manipulating the same #GRegex structure from different * Creating and manipulating the same `GRegex` structure from different
* threads is not a problem as #GRegex does not modify its internal * threads is not a problem as `GRegex` does not modify its internal
* state between creation and destruction, on the other hand #GMatchInfo * state between creation and destruction, on the other hand `GMatchInfo`
* is not threadsafe. * is not threadsafe.
* *
* The regular expressions low-level functionalities are obtained through * The regular expressions low-level functionalities are obtained through
* the excellent * the excellent [PCRE](http://www.pcre.org/) library written by Philip Hazel.
* [PCRE](http://www.pcre.org/) *
* library written by Philip Hazel. * Since: 2.14
*/ */
#define G_REGEX_PCRE_GENERIC_MASK (PCRE2_ANCHORED | \ #define G_REGEX_PCRE_GENERIC_MASK (PCRE2_ANCHORED | \

8
glib/gregex.h
View File

@ -413,14 +413,6 @@ typedef enum
G_REGEX_MATCH_NOTEMPTY_ATSTART = 1 << 28 G_REGEX_MATCH_NOTEMPTY_ATSTART = 1 << 28
} GRegexMatchFlags; } GRegexMatchFlags;
/**
* GRegex:
*
* A GRegex is the "compiled" form of a regular expression pattern.
* This structure is opaque and its fields cannot be accessed directly.
*
* Since: 2.14
*/
typedef struct _GRegex GRegex; typedef struct _GRegex GRegex;