[DOC-CVS] [doc-en] master: simdjson : fix XML by converting para to simpara tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-25T15:18:11Z
Commit: https://github.com/php/doc-en/commit/78cc29837ed269491a4fc330797c7184eca7ed2f
Raw diff: https://github.com/php/doc-en/commit/78cc29837ed269491a4fc330797c7184eca7ed2f.diff
simdjson : fix XML by converting para to simpara tags via script
Changed paths:
M reference/simdjson/book.xml
M reference/simdjson/functions/simdjson-decode.xml
M reference/simdjson/functions/simdjson-is-valid.xml
M reference/simdjson/functions/simdjson-key-count.xml
M reference/simdjson/functions/simdjson-key-exists.xml
M reference/simdjson/functions/simdjson-key-value.xml
M reference/simdjson/setup.xml
M reference/simdjson/simdjsonexception.xml
M reference/simdjson/simdjsonvalueerror.xml
Diff:
diff --git a/reference/simdjson/book.xml b/reference/simdjson/book.xml
index fbb2c2f5a1d8..2c0025954886 100644
--- a/reference/simdjson/book.xml
+++ b/reference/simdjson/book.xml
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
-<book xml:id="book.simdjson" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.simdjson">
<?phpdoc extension-membership="pecl" ?>
<title>Simdjson</title>
<titleabbrev>Simdjson</titleabbrev>
<preface xml:id="intro.simdjson">
&reftitle.intro;
- <para>
+ <simpara>
Provides faster JSON decoding through simdjson bindings for PHP (Single Instruction, Multiple Data)
- </para>
+ </simpara>
</preface>
&reference.simdjson.setup;
diff --git a/reference/simdjson/functions/simdjson-decode.xml b/reference/simdjson/functions/simdjson-decode.xml
index 5b08af41316a..4c232a53a223 100644
--- a/reference/simdjson/functions/simdjson-decode.xml
+++ b/reference/simdjson/functions/simdjson-decode.xml
@@ -13,11 +13,11 @@
<methodparam choice="opt"><type>bool</type><parameter>associative</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Takes a JSON encoded string and converts it into a PHP value.
This uses a faster Simultaneous Instruction, Multiple Data implementation
than <function>json_decode</function> when it is supported by the computer architecture.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,32 +26,32 @@
<varlistentry>
<term><parameter>json</parameter></term>
<listitem>
- <para>
+ <simpara>
The <parameter>json</parameter> <type>string</type> being decoded.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function only works with UTF-8 encoded strings.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function parses valid inputs which
<function>json_decode</function> can decode,
provided that they are less than 4 GiB long.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>associative</parameter></term>
<listitem>
- <para>
+ <simpara>
When &true;, JSON objects will be returned as
associative &array;s; when &false;, JSON objects will be returned as &object;s.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
- <para>
+ <simpara>
Maximum nesting depth of the structure being decoded.
The value must be greater than <literal>0</literal>,
and less than or equal to <literal>2147483647</literal>.
@@ -59,7 +59,7 @@
Callers should use reasonably small values,
because larger depths require more buffer space and will
increase the recursion depth, unlike the current <function>json_decode</function> implementation.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -67,25 +67,25 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the value encoded in <parameter>json</parameter> in appropriate
PHP type. Values <literal>true</literal>, <literal>false</literal> and
<literal>null</literal> are returned as &true;, &false; and &null;
respectively.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
+ <simpara>
If <parameter>json</parameter> is invalid, a <classname>SimdJsonException</classname> is thrown as of PECL simdjson 2.1.0,
while previously, a <classname>RuntimeException</classname> was thrown.
- </para>
- <para>
+ </simpara>
+ <simpara>
If <parameter>depth</parameter> is outside the allowed range,
a <classname>SimdJsonValueError</classname> is thrown as of PECL simdjson 3.0.0,
while previously, an error of level <constant>E_WARNING</constant> was raised.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -257,18 +257,18 @@ object(stdClass)#1 (1) {
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
The JSON spec is not JavaScript, but a subset of JavaScript.
- </para>
+ </simpara>
</note>
<note>
- <para>
+ <simpara>
In the event of a failure to decode,
a <classname>SimdJsonException</classname> is thrown
and <methodname>SimdJsonException::getCode</methodname> and
<methodname>SimdJsonException::getMessage</methodname> can be used
to determine the exact nature of the error.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/simdjson/functions/simdjson-is-valid.xml b/reference/simdjson/functions/simdjson-is-valid.xml
index 467b78162a2b..e7eff39b35b2 100644
--- a/reference/simdjson/functions/simdjson-is-valid.xml
+++ b/reference/simdjson/functions/simdjson-is-valid.xml
@@ -12,9 +12,9 @@
<methodparam><type>string</type><parameter>json</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Takes a JSON encoded string and returns true if it is valid.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,23 +23,23 @@
<varlistentry>
<term><parameter>json</parameter></term>
<listitem>
- <para>
+ <simpara>
The <parameter>json</parameter> <type>string</type> being validated.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function only works with UTF-8 encoded strings.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function validates inputs which
<function>json_decode</function> can decode,
provided that they are less than 4 GiB long.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
- <para>
+ <simpara>
Maximum nesting depth of the structure being validated.
The value must be greater than <literal>0</literal>,
and less than or equal to <literal>2147483647</literal>.
@@ -47,7 +47,7 @@
Callers should use reasonably small values,
because larger depths require more buffer space and will
increase the recursion depth, unlike the current <function>json_decode</function> implementation.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -55,23 +55,23 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if <parameter>json</parameter> is a valid JSON
string, &false; otherwise.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
+ <simpara>
If <parameter>json</parameter> is longer than 4 GiB, a <classname>SimdJsonException</classname> is thrown as of PECL simdjson 2.1.0,
while previously, a <classname>RuntimeException</classname> was thrown.
- </para>
- <para>
+ </simpara>
+ <simpara>
If <parameter>depth</parameter> is outside the allowed range,
a <classname>SimdJsonValueError</classname> is thrown as of PECL simdjson 3.0.0,
while previously, an error of level <constant>E_WARNING</constant> was raised.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -141,18 +141,18 @@ bool(false)
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
The JSON spec is not JavaScript, but a subset of JavaScript.
- </para>
+ </simpara>
</note>
<note>
- <para>
+ <simpara>
In the event of a failure to decode,
a <classname>SimdJsonException</classname> is thrown
and <methodname>SimdJsonException::getCode</methodname> and
<methodname>SimdJsonException::getMessage</methodname> can be used
to determine the exact nature of the error.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/simdjson/functions/simdjson-key-count.xml b/reference/simdjson/functions/simdjson-key-count.xml
index f0e50c223d45..997d77030031 100644
--- a/reference/simdjson/functions/simdjson-key-count.xml
+++ b/reference/simdjson/functions/simdjson-key-count.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<refentry xml:id="function.simdjson-key-count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.simdjson-key-count">
<refnamediv>
<refname>simdjson_key_count</refname>
<refpurpose>Returns the value at a JSON pointer.</refpurpose>
@@ -14,9 +14,9 @@
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>throw_if_uncountable</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Count the number of elements of the object/array found at the requested JSON pointer.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,23 +25,23 @@
<varlistentry>
<term><parameter>json</parameter></term>
<listitem>
- <para>
+ <simpara>
The <parameter>json</parameter> <type>string</type> being queried.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The JSON pointer <type>string</type>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
- <para>
+ <simpara>
Maximum nesting depth of the structure being validated.
The value must be greater than <literal>0</literal>,
and less than or equal to <literal>2147483647</literal>.
@@ -49,17 +49,17 @@
Callers should use reasonably small values,
because larger depths require more buffer space and will
increase the recursion depth, unlike the current <function>json_decode</function> implementation.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>throw_if_uncountable</parameter></term>
<listitem>
- <para>
+ <simpara>
When true, a <classname>SimdJsonException</classname> will be thrown
instead of returning 0 when the value the JSON pointer points to
is neither an object nor an array.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -67,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an &integer; with the number of elements of the value at the given JSON pointer.
- </para>
+ </simpara>
</refsect1>
diff --git a/reference/simdjson/functions/simdjson-key-exists.xml b/reference/simdjson/functions/simdjson-key-exists.xml
index 2c4bb87a7198..e46e1c227371 100644
--- a/reference/simdjson/functions/simdjson-key-exists.xml
+++ b/reference/simdjson/functions/simdjson-key-exists.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<refentry xml:id="function.simdjson-key-exists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.simdjson-key-exists">
<refnamediv>
<refname>simdjson_key_exists</refname>
<refpurpose>Check if the JSON contains the value referred to by a JSON pointer.</refpurpose>
@@ -13,9 +13,9 @@
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>depth</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Count the number of elements of the object/array found at the requested JSON pointer.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,23 +24,23 @@
<varlistentry>
<term><parameter>json</parameter></term>
<listitem>
- <para>
+ <simpara>
The <parameter>json</parameter> <type>string</type> being queried.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The JSON pointer <type>string</type>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
- <para>
+ <simpara>
Maximum nesting depth of the structure being validated.
The value must be greater than <literal>0</literal>,
and less than or equal to <literal>2147483647</literal>.
@@ -48,17 +48,17 @@
Callers should use reasonably small values,
because larger depths require more buffer space and will
increase the recursion depth, unlike the current <function>json_decode</function> implementation.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>throw_if_uncountable</parameter></term>
<listitem>
- <para>
+ <simpara>
When true, a <classname>SimdJsonException</classname> will be thrown
instead of returning 0 when the value the JSON pointer points to
is neither an object nor an array.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -66,10 +66,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if the JSON pointer is valid and refers to a value found within a valid JSON string.
Returns &false; if the JSON is valid but does not contain the JSON pointer.
- </para>
+ </simpara>
</refsect1>
diff --git a/reference/simdjson/functions/simdjson-key-value.xml b/reference/simdjson/functions/simdjson-key-value.xml
index 0dbafe7ac2e8..7d736da450d0 100644
--- a/reference/simdjson/functions/simdjson-key-value.xml
+++ b/reference/simdjson/functions/simdjson-key-value.xml
@@ -14,9 +14,9 @@
<methodparam choice="opt"><type>bool</type><parameter>associative</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>depth</parameter><initializer>512</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Decodes and returns the value found at the requested JSON pointer.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,40 +25,40 @@
<varlistentry>
<term><parameter>json</parameter></term>
<listitem>
- <para>
+ <simpara>
The <parameter>json</parameter> <type>string</type> being queried and decoded.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function only works with UTF-8 encoded strings.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function parses valid inputs which
<function>json_decode</function> can decode,
provided that they are less than 4 GiB long.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
- <para>
+ <simpara>
The JSON pointer <type>string</type>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>associative</parameter></term>
<listitem>
- <para>
+ <simpara>
When &true;, JSON objects will be returned as
associative &array;s; when &false;, JSON objects will be returned as &object;s.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>depth</parameter></term>
<listitem>
- <para>
+ <simpara>
Maximum nesting depth of the structure being decoded.
The value must be greater than <literal>0</literal>,
and less than or equal to <literal>2147483647</literal>.
@@ -66,7 +66,7 @@
Callers should use reasonably small values,
because larger depths require more buffer space and will
increase the recursion depth, unlike the current <function>json_decode</function> implementation.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -74,27 +74,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the part of the value encoded in <parameter>json</parameter>
that <parameter>key</parameter> refers to in appropriate
PHP type. Values <literal>true</literal>, <literal>false</literal> and
<literal>null</literal> are returned as &true;, &false; and &null;
respectively.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
+ <simpara>
If <parameter>json</parameter> or <parameter>key</parameter> is invalid,
or <parameter>key</parameter> could not be found within <parameter>json</parameter>,
a <classname>SimdJsonException</classname> is thrown as of PECL simdjson 2.1.0,
while previously, a <classname>RuntimeException</classname> was thrown.
- </para>
- <para>
+ </simpara>
+ <simpara>
If <parameter>depth</parameter> is outside the allowed range,
a <classname>SimdJsonValueError</classname> is thrown as of PECL simdjson 3.0.0,
while previously, an error of level <constant>E_WARNING</constant> was raised.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
diff --git a/reference/simdjson/setup.xml b/reference/simdjson/setup.xml
index f003d39a1fde..ff85d8adffe9 100644
--- a/reference/simdjson/setup.xml
+++ b/reference/simdjson/setup.xml
@@ -1,19 +1,19 @@
<?xml version="1.0" encoding="utf-8"?>
-<chapter xml:id="simdjson.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="simdjson.setup">
&reftitle.setup;
<section xml:id="simdjson.installation">
&reftitle.install;
- <para>
+ <simpara>
&pecl.moved;
- </para>
- <para>
+ </simpara>
+ <simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;simdjson">&url.pecl.package;simdjson</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
&pecl.windows.download.avail;
- </para>
+ </simpara>
</section>
</chapter>
<!-- Keep this comment at the end of the file
diff --git a/reference/simdjson/simdjsonexception.xml b/reference/simdjson/simdjsonexception.xml
index 0ba6fda14b50..e76b7bc91b32 100644
--- a/reference/simdjson/simdjsonexception.xml
+++ b/reference/simdjson/simdjsonexception.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<reference xml:id="class.simdjsonexception" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.simdjsonexception" role="class">
<title>The SimdJsonException class</title>
<titleabbrev>SimdJsonException</titleabbrev>
@@ -8,14 +8,14 @@
<!-- {{{ SimdJsonException intro -->
<section xml:id="simdjsonexception.intro">
&reftitle.intro;
- <para>
+ <simpara>
Exception thrown if <function>simdjson_decode</function>,
<function>simdjson_key_count</function>,
<function>simdjson_key_exists</function>,
or <function>simdjson_key_value</function>.
For possible values see the <link linkend="simdjson.constants">simdjson error codes</link> constants.
- </para>
+ </simpara>
</section>
<!-- }}} -->
diff --git a/reference/simdjson/simdjsonvalueerror.xml b/reference/simdjson/simdjsonvalueerror.xml
index 136d492095c3..5dc46796e2c3 100644
--- a/reference/simdjson/simdjsonvalueerror.xml
+++ b/reference/simdjson/simdjsonvalueerror.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
-<reference xml:id="class.simdjsonvalueerror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.simdjsonvalueerror" role="class">
<title>The SimdJsonValueError class</title>
<titleabbrev>SimdJsonValueError</titleabbrev>
@@ -8,12 +8,12 @@
<!-- {{{ SimdJsonValueError intro -->
<section xml:id="simdjsonvalueerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
A <classname>SimdJsonValueError</classname> is thrown when the
type of an argument to a function from simdjson is correct but the value
of it is incorrect.
E.g. when the JSON decoding <varname>$depth</varname> is not positive or the <varname>$depth</varname> is too large.
- </para>
+ </simpara>
</section>
<!-- }}} -->