mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-06-15 08:10:17 +02:00
(scm_regexp_exec): Expand docstring to briefly
describe `regexp/notbol' and `regexp/noteol' execution flags.
This commit is contained in:
parent
826e91f350
commit
94bb46ab57
1 changed files with 24 additions and 10 deletions
|
@ -1,4 +1,4 @@
|
||||||
/* Copyright (C) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
|
/* Copyright (C) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
|
||||||
*
|
*
|
||||||
* This program is free software; you can redistribute it and/or modify
|
* This program is free software; you can redistribute it and/or modify
|
||||||
* it under the terms of the GNU General Public License as published by
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
@ -229,7 +229,21 @@ SCM_DEFINE (scm_regexp_exec, "regexp-exec", 2, 2, 0,
|
||||||
"@code{str}. If the optional integer @var{start} argument is\n"
|
"@code{str}. If the optional integer @var{start} argument is\n"
|
||||||
"provided, begin matching from that position in the string.\n"
|
"provided, begin matching from that position in the string.\n"
|
||||||
"Return a match structure describing the results of the match,\n"
|
"Return a match structure describing the results of the match,\n"
|
||||||
"or @code{#f} if no match could be found.")
|
"or @code{#f} if no match could be found.\n"
|
||||||
|
"\n"
|
||||||
|
"The @var{flags} arguments change the matching behavior.\n"
|
||||||
|
"The following flags may be supplied:\n"
|
||||||
|
"\n"
|
||||||
|
"@table @code\n"
|
||||||
|
"@item regexp/notbol\n"
|
||||||
|
"Operator @samp{^} always fails (unless @code{regexp/newline}\n"
|
||||||
|
"is used). Use this when the beginning of the string should\n"
|
||||||
|
"not be considered the beginning of a line.\n"
|
||||||
|
"@item regexp/noteol\n"
|
||||||
|
"Operator @samp{$} always fails (unless @code{regexp/newline}\n"
|
||||||
|
"is used). Use this when the end of the string should not be\n"
|
||||||
|
"considered the end of a line.\n"
|
||||||
|
"@end table")
|
||||||
#define FUNC_NAME s_scm_regexp_exec
|
#define FUNC_NAME s_scm_regexp_exec
|
||||||
{
|
{
|
||||||
int status, nmatches, offset;
|
int status, nmatches, offset;
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue