php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

openal: fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-26 15:26:35 +00:00
parent b9519690aa
commit c55b13c1a5
26 changed files with 125 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
reference/openal/book.xml
View File

@@ -1,27 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.openal" 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.openal">
<?phpdoc extension-membership="pecl" ?>
<title>OpenAL Audio Bindings</title>
<titleabbrev>OpenAL</titleabbrev>
<!-- {{{ preface -->
<preface xml:id="intro.openal">
&reftitle.intro;
<para>
<simpara>
Platform independent audio bindings.
Requires the <link xlink:href="&url.openal;">OpenAL library</link>.
</para>
</simpara>
</preface>
<!-- }}} -->
&reference.openal.setup;
&reference.openal.constants;
&reference.openal.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -42,4 +40,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

14
reference/openal/configure.xml
View File

@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="openal.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="openal.installation">
&reftitle.install;
<para>
<simpara>
&pecl.moved;
</para>
<para>
</simpara>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;openal">&url.pecl.package;openal</link>.
</para>
<para>
</simpara>
<simpara>
&pecl.windows.download;
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:

4
reference/openal/functions/openal-buffer-create.xml
View File

@@ -22,10 +22,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an <link linkend="openal.resources">Open AL(Buffer)</link> resource on success or
&false; on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

20
reference/openal/functions/openal-buffer-data.xml
View File

@@ -23,48 +23,48 @@
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<simpara>
Format of <parameter>data</parameter>, one of:
<constant>AL_FORMAT_MONO8</constant>,
<constant>AL_FORMAT_MONO16</constant>,
<constant>AL_FORMAT_STEREO8</constant>&listendand;
<constant>AL_FORMAT_STEREO16</constant>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Block of binary audio data in the <parameter>format</parameter> and
<parameter>freq</parameter> specified.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>freq</parameter></term>
<listitem>
<para>
<simpara>
Frequency of <parameter>data</parameter> given in Hz.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-buffer-destroy.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/openal/functions/openal-buffer-get.xml
View File

@@ -21,22 +21,22 @@
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
<simpara>
Specific property, one of:
<constant>AL_FREQUENCY</constant>,
<constant>AL_BITS</constant>,
<constant>AL_CHANNELS</constant>&listendand;
<constant>AL_SIZE</constant>.
</para>
</simpara>
</listitem>
</varlistentry>
@@ -44,10 +44,10 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an integer value appropriate to the <parameter>property</parameter>
requested&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/openal/functions/openal-buffer-loadwav.xml
View File

@@ -21,28 +21,28 @@
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Buffer)</link> resource
(previously created by <function>openal_buffer_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wavfile</parameter></term>
<listitem>
<para>
<simpara>
Path to <filename>.wav</filename> file on
<emphasis>local</emphasis> file system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-context-create.xml
View File

@@ -20,20 +20,20 @@
<varlistentry>
<term><parameter>device</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Device)</link> resource
(previously created by <function>openal_device_open</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an <link linkend="openal.resources">Open AL(Context)</link> resource on success or
&false; on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-context-current.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-context-destroy.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-context-process.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-context-suspend.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Context)</link> resource
(previously created by <function>openal_context_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-device-close.xml
View File

@@ -20,20 +20,20 @@
<varlistentry>
<term><parameter>device</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Device)</link> resource
(previously created by <function>openal_device_open</function>)
to be closed.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-device-open.xml
View File

@@ -20,21 +20,21 @@
<varlistentry>
<term><parameter>device_desc</parameter></term>
<listitem>
<para>
<simpara>
Open an audio device optionally specified by <parameter>device_desc</parameter>.
If <parameter>device_desc</parameter> is not specified the first available audio
device will be used.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an <link linkend="openal.resources">Open AL(Device)</link> resource on success or
&false; on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-listener-get.xml
View File

@@ -20,22 +20,22 @@
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
<simpara>
Property to retrieve, one of:
<constant>AL_GAIN</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float))&listendand;
<constant>AL_ORIENTATION</constant> (array(float,float,float)).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a float or array of floats (as appropriate)&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/openal/functions/openal-listener-set.xml
View File

@@ -21,30 +21,30 @@
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
<simpara>
Property to set, one of:
<constant>AL_GAIN</constant> (float),
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float))&listendand;
<constant>AL_ORIENTATION</constant> (array(float,float,float)).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
<simpara>
Value to set, either float, or an array of floats as appropriate.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

4
reference/openal/functions/openal-source-create.xml
View File

@@ -22,10 +22,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an <link linkend="openal.resources">Open AL(Source)</link> resource on success or
&false; on failure.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-source-destroy.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

12
reference/openal/functions/openal-source-get.xml
View File

@@ -21,16 +21,16 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
<simpara>
Property to get, one of:
<constant>AL_SOURCE_RELATIVE</constant> (int),
<constant>AL_SOURCE_STATE</constant> (int),
@@ -47,17 +47,17 @@
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float)),
<constant>AL_DIRECTION</constant> (array(float,float,float)).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the type associated with the property being retrieved
&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-source-pause.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-source-play.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-source-rewind.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

16
reference/openal/functions/openal-source-set.xml
View File

@@ -22,16 +22,16 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
<para>
<simpara>
Property to set, one of:
<constant>AL_BUFFER</constant> (OpenAL(Source)),
<constant>AL_LOOPING</constant> (bool),
@@ -50,26 +50,26 @@
<constant>AL_POSITION</constant> (array(float,float,float)),
<constant>AL_VELOCITY</constant> (array(float,float,float)),
<constant>AL_DIRECTION</constant> (array(float,float,float)).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>setting</parameter></term>
<listitem>
<para>
<simpara>
Value to assign to specified <parameter>property</parameter>.
Refer to the description of <parameter>property</parameter>
for a description of the value(s) expected.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

8
reference/openal/functions/openal-source-stop.xml
View File

@@ -20,19 +20,19 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

16
reference/openal/functions/openal-stream.xml
View File

@@ -22,39 +22,39 @@
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
An <link linkend="openal.resources">Open AL(Source)</link> resource
(previously created by <function>openal_source_create</function>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<simpara>
Format of <parameter>data</parameter>, one of:
<constant>AL_FORMAT_MONO8</constant>,
<constant>AL_FORMAT_MONO16</constant>,
<constant>AL_FORMAT_STEREO8</constant>&listendand;
<constant>AL_FORMAT_STEREO16</constant>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>rate</parameter></term>
<listitem>
<para>
<simpara>
Frequency of data to stream given in Hz.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns a stream resource on success&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

6
reference/openal/resources.xml
View File

@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="openal.resources" xmlns="http://docbook.org/ns/docbook">
<section xmlns="http://docbook.org/ns/docbook" xml:id="openal.resources">
&reftitle.resources;
<para>
<simpara>
This extension defines four resource types:
<emphasis>Open AL(Device)</emphasis> - Returned by <function>openal_device_open</function>,
<emphasis>Open AL(Context)</emphasis> - Returned by <function>openal_context_create</function>,
<emphasis>Open AL(Buffer)</emphasis> - Returned by <function>openal_buffer_create</function>,
and <emphasis>Open AL(Source)</emphasis> - Returned by <function>openal_source_create</function>.
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file