perlapi: Add some S<>

so that these constructs appear on a single output line for reader
convenience.

diff --git a/av.c b/av.c
index 07a509e..cb99ceb 100644 (file)
--- a/av.c
+++ b/av.c
@@ -649,7 +649,7 @@ Unshift the given number of C<undef> values onto the beginning of the
 array.  The array will grow automatically to accommodate the addition.  You
 must then use C<av_store> to assign values to these new elements.
 
-Perl equivalent: C<unshift @myarray, ( (undef) x $n );>
+Perl equivalent: S<C<unshift @myarray, ( (undef) x $n );>>
 
 =cut
 */
@@ -752,7 +752,7 @@ Perl_av_shift(pTHX_ AV *av)
 =for apidoc av_top_index
 
 Returns the highest index in the array.  The number of elements in the
-array is C<av_top_index(av) + 1>.  Returns -1 if the array is empty.
+array is S<C<av_top_index(av) + 1>>.  Returns -1 if the array is empty.
 
 The Perl equivalent for this is C<$#myarray>.
 
@@ -780,12 +780,12 @@ Perl_av_len(pTHX_ AV *av)
 =for apidoc av_fill
 
 Set the highest index in the array to the given number, equivalent to
-Perl's C<$#array = $fill;>.
+Perl's S<C<$#array = $fill;>>.
 
-The number of elements in the array will be C<fill + 1> after
+The number of elements in the array will be S<C<fill + 1>> after
 C<av_fill()> returns.  If the array was previously shorter, then the
 additional elements appended are set to NULL.  If the array
-was longer, then the excess elements are freed.  C<av_fill(av, -1)> is
+was longer, then the excess elements are freed.  S<C<av_fill(av, -1)>> is
 the same as C<av_clear(av)>.
 
 =cut
@@ -835,8 +835,8 @@ Perl_av_fill(pTHX_ AV *av, SSize_t fill)
 
 Deletes the element indexed by C<key> from the array, makes the element mortal,
 and returns it.  If C<flags> equals C<G_DISCARD>, the element is freed and null
-is returned.  Perl equivalent: C<my $elem = delete($myarray[$idx]);> for the
-non-C<G_DISCARD> version and a void-context C<delete($myarray[$idx]);> for the
+is returned.  Perl equivalent: S<C<my $elem = delete($myarray[$idx]);>> for the
+non-C<G_DISCARD> version and a void-context S<C<delete($myarray[$idx]);>> for the
 C<G_DISCARD> version.
 
 =cut

diff --git a/mg.c b/mg.c
index 7e7b112..1859391 100644 (file)
--- a/mg.c
+++ b/mg.c
@@ -491,7 +491,7 @@ gets copied, value magic doesn't (eg
 C<taint>, C<pos>).
 
 If C<setmagic> is false then no set magic will be called on the new (empty) SV.
-This typically means that assignment will soon follow (e.g. C<'local $x = $y'>),
+This typically means that assignment will soon follow (e.g. S<C<'local $x = $y'>>),
 and that will handle the magic.
 
 =cut

diff --git a/op.c b/op.c
index 08788ce..72c6809 100644 (file)
--- a/op.c
+++ b/op.c
@@ -8800,7 +8800,7 @@ Perl_newCONSTSUB(pTHX_ HV *stash, const char *name, SV *sv)
 /*
 =for apidoc newCONSTSUB_flags
 
-Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
+Creates a constant sub equivalent to Perl S<C<sub FOO () { 123 }>> which is
 eligible for inlining at compile-time.
 
 Currently, the only useful value for C<flags> is C<SVf_UTF8>.
@@ -8808,7 +8808,7 @@ Currently, the only useful value for C<flags> is C<SVf_UTF8>.
 The newly created subroutine takes ownership of a reference to the passed in
 SV.
 
-Passing C<NULL> for SV creates a constant sub equivalent to C<sub BAR () {}>,
+Passing C<NULL> for SV creates a constant sub equivalent to S<C<sub BAR () {}>>,
 which won't be called if used as a destructor, but will suppress the overhead
 of a call to C<AUTOLOAD>.  (This form, however, isn't eligible for inlining at
 compile time.)

diff --git a/pad.c b/pad.c
index e34faec..9bb8cfe 100644 (file)
--- a/pad.c
+++ b/pad.c
@@ -64,7 +64,7 @@ have C<&PL_padname_const> "names" (see C<L</pad_alloc>>).  That
 C<&PL_padname_undef>
 and C<&PL_padname_const> are used is an implementation detail subject to
 change.  To test for them, use C<!PadnamePV(name)> and
-C<PadnamePV(name) && !PadnameLEN(name)>, respectively.
+S<C<PadnamePV(name) && !PadnameLEN(name)>>, respectively.
 
 Only C<my>/C<our> variable slots get valid names.
 The rest are op targets/GVs/constants which are statically allocated

diff --git a/sv.c b/sv.c
index bcb031a..f2908e0 100644 (file)
--- a/sv.c
+++ b/sv.c
@@ -4983,8 +4983,8 @@ so that pointer should not be freed or used by the programmer after
 giving it to C<sv_usepvn>, and neither should any pointers from "behind"
 that pointer (e.g. ptr + 1) be used.
 
-If C<flags & SV_SMAGIC> is true, will call C<SvSETMAGIC>.  If
-C<flags & SV_HAS_TRAILING_NUL> is true, then C<ptr[len]> must be C<NUL>,
+If S<C<flags & SV_SMAGIC>> is true, will call C<SvSETMAGIC>.  If
+S<C<flags> & SV_HAS_TRAILING_NUL>> is true, then C<ptr[len]> must be C<NUL>,
 and the realloc
 will be skipped (i.e. the buffer is actually at least 1 byte longer than
 C<len>, and already meets the requirements for storing in C<SvPVX>).
@@ -7630,7 +7630,7 @@ S_assert_uft8_cache_coherent(pTHX_ const char *const func, STRLEN from_cache,
 =for apidoc sv_eq
 
 Returns a boolean indicating whether the strings in the two SVs are
-identical.  Is UTF-8 and C<'use bytes'> aware, handles get magic, and will
+identical.  Is UTF-8 and S<C<'use bytes'>> aware, handles get magic, and will
 coerce its args to strings if necessary.
 
 =for apidoc sv_eq_flags

diff --git a/utf8.h b/utf8.h
index 8355d0a..2e1aa02 100644 (file)
--- a/utf8.h
+++ b/utf8.h
@@ -697,9 +697,9 @@ case any call to string overloading updates the internal UTF-8 encoding flag.
 =for apidoc Am|STRLEN|isUTF8_CHAR|const U8 *s|const U8 *e
 
 Returns the number of bytes beginning at C<s> which form a legal UTF-8 (or
-UTF-EBCDIC) encoded character, looking no further than C<e - s> bytes into
-C<s>.  Returns 0 if the sequence starting at C<s> through C<e - 1> is not
-well-formed UTF-8
+UTF-EBCDIC) encoded character, looking no further than S<C<e - s>> bytes into
+C<s>.  Returns 0 if the sequence starting at C<s> through S<C<e - 1>> is not
+well-formed UTF-8.
 
 Note that an INVARIANT character (i.e. ASCII on non-EBCDIC
 machines) is a valid UTF-8 character.

diff --git a/util.h b/util.h
index 0d41ebc..3310b11 100644 (file)
--- a/util.h
+++ b/util.h
@@ -43,11 +43,11 @@
 
 =for apidoc ibcmp
 
-This is a synonym for (! foldEQ())
+This is a synonym for S<C<(! foldEQ())>>
 
 =for apidoc ibcmp_locale
 
-This is a synonym for (! foldEQ_locale())
+This is a synonym for S<C<(! foldEQ_locale())>>
 
 =cut
 */