walkero
/
pcre2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Documentation update

This commit is contained in:
Philip Hazel 2022-04-22 10:38:37 +01:00
parent f28e82602d
commit d0c7544e78
5 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/html/pcre2_compile.html
View File

@ -92,8 +92,14 @@ Additional options may be set in the compile context via the
function. function.
</P> </P>
<P> <P>
The yield of this function is a pointer to a private data structure that If either of <i>errorcode</i> or <i>erroroffset</i> is NULL, the function returns
contains the compiled pattern, or NULL if an error was detected. NULL immediately. Otherwise, the yield of this function is a pointer to a
private data structure that contains the compiled pattern, or NULL if an error
was detected. In the error case, a text error message can be obtained by
passing the value returned via the <i>errorcode</i> argument to the the
<b>pcre2_get_error_message()</b> function. The offset (in code units) where the
error was encountered is returned via the <i>erroroffset</i> argument. Both
values are set to zero for a successful return.
</P> </P>
<P> <P>
There is a complete description of the PCRE2 native API, with more detail on There is a complete description of the PCRE2 native API, with more detail on

2
doc/html/pcre2api.html
View File

@ -1383,7 +1383,7 @@ If <i>errorcode</i> or <i>erroroffset</i> is NULL, <b>pcre2_compile()</b> return
NULL immediately. Otherwise, the variables to which these point are set to an NULL immediately. Otherwise, the variables to which these point are set to an
error code and an offset (number of code units) within the pattern, error code and an offset (number of code units) within the pattern,
respectively, when <b>pcre2_compile()</b> returns NULL because a compilation respectively, when <b>pcre2_compile()</b> returns NULL because a compilation
error has occurred. The values are not defined when compilation is successful error has occurred. The values are both zero when compilation is successful
and <b>pcre2_compile()</b> returns a non-NULL value. and <b>pcre2_compile()</b> returns a non-NULL value.
</P> </P>
<P> <P>

4
doc/pcre2.txt
View File

@ -1372,8 +1372,8 @@ COMPILING A PATTERN
diately. Otherwise, the variables to which these point are set to an diately. Otherwise, the variables to which these point are set to an
error code and an offset (number of code units) within the pattern, re- error code and an offset (number of code units) within the pattern, re-
spectively, when pcre2_compile() returns NULL because a compilation er- spectively, when pcre2_compile() returns NULL because a compilation er-
ror has occurred. The values are not defined when compilation is suc- ror has occurred. The values are both zero when compilation is success-
cessful and pcre2_compile() returns a non-NULL value. ful and pcre2_compile() returns a non-NULL value.
There are nearly 100 positive error codes that pcre2_compile() may re- There are nearly 100 positive error codes that pcre2_compile() may re-
turn if it finds an error in the pattern. There are also some negative turn if it finds an error in the pattern. There are also some negative

12
doc/pcre2_compile.3
View File

@ -1,4 +1,4 @@
.TH PCRE2_COMPILE 3 "23 May 2019" "PCRE2 10.34" .TH PCRE2_COMPILE 3 "22 April 2022" "PCRE2 10.41"
.SH NAME .SH NAME
PCRE2 - Perl-compatible regular expressions (revised API) PCRE2 - Perl-compatible regular expressions (revised API)
.SH SYNOPSIS .SH SYNOPSIS
@ -80,8 +80,14 @@ Additional options may be set in the compile context via the
.\" .\"
function. function.
.P .P
The yield of this function is a pointer to a private data structure that If either of \fIerrorcode\fP or \fIerroroffset\fP is NULL, the function returns
contains the compiled pattern, or NULL if an error was detected. NULL immediately. Otherwise, the yield of this function is a pointer to a
private data structure that contains the compiled pattern, or NULL if an error
was detected. In the error case, a text error message can be obtained by
passing the value returned via the \fIerrorcode\fP argument to the the
\fBpcre2_get_error_message()\fP function. The offset (in code units) where the
error was encountered is returned via the \fIerroroffset\fP argument. Both
values are set to zero for a successful return.
.P .P
There is a complete description of the PCRE2 native API, with more detail on There is a complete description of the PCRE2 native API, with more detail on
each option, in the each option, in the

4
doc/pcre2api.3
View File

@ -1,4 +1,4 @@
.TH PCRE2API 3 "14 December 2021" "PCRE2 10.40" .TH PCRE2API 3 "22 April 2022" "PCRE2 10.41"
.SH NAME .SH NAME
PCRE2 - Perl-compatible regular expressions (revised API) PCRE2 - Perl-compatible regular expressions (revised API)
.sp .sp
@ -1323,7 +1323,7 @@ If \fIerrorcode\fP or \fIerroroffset\fP is NULL, \fBpcre2_compile()\fP returns
NULL immediately. Otherwise, the variables to which these point are set to an NULL immediately. Otherwise, the variables to which these point are set to an
error code and an offset (number of code units) within the pattern, error code and an offset (number of code units) within the pattern,
respectively, when \fBpcre2_compile()\fP returns NULL because a compilation respectively, when \fBpcre2_compile()\fP returns NULL because a compilation
error has occurred. The values are not defined when compilation is successful error has occurred. The values are both zero when compilation is successful
and \fBpcre2_compile()\fP returns a non-NULL value. and \fBpcre2_compile()\fP returns a non-NULL value.
.P .P
There are nearly 100 positive error codes that \fBpcre2_compile()\fP may return There are nearly 100 positive error codes that \fBpcre2_compile()\fP may return