From b1ebbda5908ec402ffa2efdc0c3531853ed5561f Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 6 Feb 2005 02:47:15 +0000 Subject: [PATCH] Add roles for refsect1 sections and fix see also structure git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@178980 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../openal/functions/openal-buffer-create.xml | 25 ++++++------ .../openal/functions/openal-buffer-data.xml | 38 ++++++++++--------- .../functions/openal-buffer-destroy.xml | 24 ++++++------ .../openal/functions/openal-buffer-get.xml | 32 ++++++++-------- .../functions/openal-buffer-loadwav.xml | 30 ++++++++------- .../functions/openal-context-create.xml | 31 +++++++-------- .../functions/openal-context-current.xml | 24 ++++++------ .../functions/openal-context-destroy.xml | 24 ++++++------ .../functions/openal-context-process.xml | 28 +++++++------- .../functions/openal-context-suspend.xml | 28 +++++++------- .../openal/functions/openal-device-close.xml | 24 ++++++------ .../openal/functions/openal-device-open.xml | 30 ++++++++------- .../openal/functions/openal-listener-get.xml | 28 +++++++------- .../openal/functions/openal-listener-set.xml | 28 +++++++------- .../openal/functions/openal-source-create.xml | 26 +++++++------ .../functions/openal-source-destroy.xml | 24 ++++++------ .../openal/functions/openal-source-get.xml | 36 +++++++++--------- .../openal/functions/openal-source-pause.xml | 28 +++++++------- .../openal/functions/openal-source-play.xml | 28 +++++++------- .../openal/functions/openal-source-rewind.xml | 28 +++++++------- .../openal/functions/openal-source-set.xml | 36 +++++++++--------- .../openal/functions/openal-source-stop.xml | 28 +++++++------- reference/openal/functions/openal-stream.xml | 38 ++++++++++--------- 23 files changed, 355 insertions(+), 311 deletions(-) diff --git a/reference/openal/functions/openal-buffer-create.xml b/reference/openal/functions/openal-buffer-create.xml index bc7b838c11..4f3ac7b2c9 100644 --- a/reference/openal/functions/openal-buffer-create.xml +++ b/reference/openal/functions/openal-buffer-create.xml @@ -1,5 +1,5 @@ - + openal_buffer_create @@ -7,28 +7,29 @@ Generate OpenAL buffer - - Description + + &reftitle.description; resourceopenal_buffer_create - + &reftitle.returnvalues; - + Returns an Open AL(Buffer) resource on success or &false; on failure. - + - + &reftitle.seealso; - - openal_buffer_loadwav&listendand; - openal_buffer_data - + + + openal_buffer_loadwav + openal_buffer_data + + - + openal_buffer_data @@ -7,8 +7,8 @@ Load a buffer with data - - Description + + &reftitle.description; boolopenal_buffer_data resourcebuffer @@ -17,61 +17,63 @@ intfreq - + &reftitle.parameters; buffer - + An Open AL(Buffer) resource (previously created by openal_buffer_create). - + format - + Format of data, one of: AL_FORMAT_MONO8, AL_FORMAT_MONO16, AL_FORMAT_STEREO8&listendand; AL_FORMAT_STEREO16 - + data - + Block of binary audio data in the format and freq specified. - + frew - + Frequency of data given in Hz. - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_buffer_loadwav&listendand; - openal_stream - + + + openal_buffer_loadwav + openal_stream + + diff --git a/reference/openal/functions/openal-buffer-destroy.xml b/reference/openal/functions/openal-buffer-destroy.xml index ecdb0fa967..7f2d5822e7 100644 --- a/reference/openal/functions/openal-buffer-destroy.xml +++ b/reference/openal/functions/openal-buffer-destroy.xml @@ -1,5 +1,5 @@ - + openal_buffer_destroy @@ -7,38 +7,40 @@ Destroys an OpenAL buffer - - Description + + &reftitle.description; boolopenal_buffer_destroy resourcebuffer - + &reftitle.parameters; buffer - + An Open AL(Buffer) resource (previously created by openal_buffer_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_buffer_create - + + + openal_buffer_create + + diff --git a/reference/openal/functions/openal-buffer-get.xml b/reference/openal/functions/openal-buffer-get.xml index e2b4d9228d..02d16a7ee7 100644 --- a/reference/openal/functions/openal-buffer-get.xml +++ b/reference/openal/functions/openal-buffer-get.xml @@ -1,5 +1,5 @@ - + openal_buffer_get @@ -7,53 +7,55 @@ Retrieve an OpenAL buffer property - - Description + + &reftitle.description; intopenal_buffer_get resourcebuffer intproperty - + &reftitle.parameters; buffer - + An Open AL(Buffer) resource (previously created by openal_buffer_create). - + property - + Specific property, one of: AL_FREQUENCY, AL_BITS, AL_CHANNELS&listendand; AL_SIZE. - + - + &reftitle.returnvalues; - + Returns an integer value appropriate to the property requested or &false; on failure. - + - + &reftitle.seealso; - - openal_buffer_create - + + + openal_buffer_create + + diff --git a/reference/openal/functions/openal-buffer-loadwav.xml b/reference/openal/functions/openal-buffer-loadwav.xml index 265bf95073..9600cd5fe0 100644 --- a/reference/openal/functions/openal-buffer-loadwav.xml +++ b/reference/openal/functions/openal-buffer-loadwav.xml @@ -1,5 +1,5 @@ - + openal_buffer_loadwav @@ -7,48 +7,50 @@ Load a .wav file into a buffer - - Description + + &reftitle.description; boolopenal_buffer_loadwav resourcebuffer stringwavfile - + &reftitle.parameters; buffer - + An Open AL(Buffer) resource (previously created by openal_buffer_create). - + wavfile - + Path to .WAV file on local file system. - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_buffer_data&listendand; - openal_stream - + + + openal_buffer_data + openal_stream + + diff --git a/reference/openal/functions/openal-context-create.xml b/reference/openal/functions/openal-context-create.xml index 64e88b76ed..71ad9561fb 100644 --- a/reference/openal/functions/openal-context-create.xml +++ b/reference/openal/functions/openal-context-create.xml @@ -1,5 +1,5 @@ - + openal_context_create @@ -7,42 +7,43 @@ Create an audio processing context - - Description + + &reftitle.description; resourceopenal_context_create resourcedevice - + &reftitle.parameters; device - + An Open AL(Device) resource (previously created by openal_device_open). - + - + &reftitle.returnvalues; - + Returns an Open AL(Context) resource on success or &false; on failure. - + - + &reftitle.seealso; - - openal_device_open&listendand; - openal_context_destroy - + + + openal_device_open + openal_context_destroy + + - + openal_context_current @@ -7,38 +7,40 @@ Make the specified context current - - Description + + &reftitle.description; boolopenal_context_current resourcecontext - + &reftitle.parameters; context - + An Open AL(Context) resource (previously created by openal_context_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_context_create - + + + openal_context_create + + diff --git a/reference/openal/functions/openal-context-destroy.xml b/reference/openal/functions/openal-context-destroy.xml index f30c4d5264..73cb4abea2 100644 --- a/reference/openal/functions/openal-context-destroy.xml +++ b/reference/openal/functions/openal-context-destroy.xml @@ -1,5 +1,5 @@ - + openal_context_destroy @@ -7,38 +7,40 @@ Destroys a context - - Description + + &reftitle.description; boolopenal_context_destroy resourcecontext - + &reftitle.parameters; context - + An Open AL(Context) resource (previously created by openal_context_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_context_create - + + + openal_context_create + + diff --git a/reference/openal/functions/openal-context-process.xml b/reference/openal/functions/openal-context-process.xml index 93ba081ab5..58381a6d70 100644 --- a/reference/openal/functions/openal-context-process.xml +++ b/reference/openal/functions/openal-context-process.xml @@ -1,5 +1,5 @@ - + openal_context_process @@ -7,40 +7,42 @@ Process the specified context - - Description + + &reftitle.description; boolopenal_context_process resourcecontext - + &reftitle.parameters; context - + An Open AL(Context) resource (previously created by openal_context_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_context_create, - openal_context_current&listendand; - openal_context_suspend - + + + openal_context_create + openal_context_current + openal_context_suspend + + diff --git a/reference/openal/functions/openal-context-suspend.xml b/reference/openal/functions/openal-context-suspend.xml index 61562716e7..2c8bfe42b5 100644 --- a/reference/openal/functions/openal-context-suspend.xml +++ b/reference/openal/functions/openal-context-suspend.xml @@ -1,5 +1,5 @@ - + openal_context_suspend @@ -7,40 +7,42 @@ Suspend the specified context - - Description + + &reftitle.description; boolopenal_context_suspend resourcecontext - + &reftitle.parameters; context - + An Open AL(Context) resource (previously created by openal_context_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_context_create, - openal_context_current&listendand; - openal_context_process - + + + openal_context_create + openal_context_current + openal_context_process + + diff --git a/reference/openal/functions/openal-device-close.xml b/reference/openal/functions/openal-device-close.xml index 4dd0bbdce0..72850ce243 100644 --- a/reference/openal/functions/openal-device-close.xml +++ b/reference/openal/functions/openal-device-close.xml @@ -1,5 +1,5 @@ - + openal_device_close @@ -7,39 +7,41 @@ Close an OpenAL device - - Description + + &reftitle.description; boolopenal_device_close resourcedevice - + &reftitle.parameters; device - + An Open AL(Device) resource (previously created by openal_device_open) to be closed. - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_device_open - + + + openal_device_open + + diff --git a/reference/openal/functions/openal-device-open.xml b/reference/openal/functions/openal-device-open.xml index 0b1332bcfd..20253f6ba4 100644 --- a/reference/openal/functions/openal-device-open.xml +++ b/reference/openal/functions/openal-device-open.xml @@ -1,5 +1,5 @@ - + openal_device_open @@ -7,41 +7,43 @@ Initialize the OpenAL audio layer - - Description + + &reftitle.description; resourceopenal_device_open stringdevice_desc - + &reftitle.parameters; device_desc - + Open an audio device optionally specified by device_desc. If device_desc is not specified the first available audio device will be used. - + - + &reftitle.returnvalues; - + Returns an Open AL(Device) resource on success or &false; on failure. - + - + &reftitle.seealso; - - openal_device_close&listendand; - openal_context_create - + + + openal_device_close + openal_context_create + + diff --git a/reference/openal/functions/openal-listener-get.xml b/reference/openal/functions/openal-listener-get.xml index 325994adc0..929d5121d8 100644 --- a/reference/openal/functions/openal-listener-get.xml +++ b/reference/openal/functions/openal-listener-get.xml @@ -1,5 +1,5 @@ - + openal_listener_get @@ -7,41 +7,43 @@ Retrieve a listener property - - Description + + &reftitle.description; mixedopenal_listener_get intproperty - + &reftitle.parameters; property - + Property to retreive, one of: AL_GAIN (float), AL_POSITION (array(float,float,float)), AL_VELOCITY (array(float,float,float))&listendand; AL_ORIENTATION (array(float,float,float)). - + - + &reftitle.returnvalues; - + Returns a float or array of floats (as appropriate), or &false; on failure. - + - + &reftitle.seealso; - - openal_listener_set - + + + openal_listener_set + + diff --git a/reference/openal/functions/openal-listener-set.xml b/reference/openal/functions/openal-listener-set.xml index edebe08e7a..9d022ce710 100644 --- a/reference/openal/functions/openal-listener-set.xml +++ b/reference/openal/functions/openal-listener-set.xml @@ -1,5 +1,5 @@ - + openal_listener_set @@ -7,50 +7,52 @@ Set a listener property - - Description + + &reftitle.description; boolopenal_listener_set intproperty mixedsetting - + &reftitle.parameters; property - + Property to set, one of: AL_GAIN (float), AL_POSITION (array(float,float,float)), AL_VELOCITY (array(float,float,float))&listendand; AL_ORIENTATION (array(float,float,float)). - + setting - + Value to set, either float, or an array of floats as appropriate. - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_listener_get - + + + openal_listener_get + + diff --git a/reference/openal/functions/openal-source-create.xml b/reference/openal/functions/openal-source-create.xml index b3fd2b8325..b6b69ba973 100644 --- a/reference/openal/functions/openal-source-create.xml +++ b/reference/openal/functions/openal-source-create.xml @@ -1,5 +1,5 @@ - + openal_source_create @@ -7,27 +7,29 @@ Generate a source resource - - Description + + &reftitle.description; resourceopenal_source_create - + &reftitle.returnvalues; - + Returns an Open AL(Source) resource on success or &false; on failure. - + - + &reftitle.seealso; - - openal_source_set, - openal_source_play&listendand; - openal_source_destroy - + + + openal_source_set + openal_source_play + openal_source_destroy + + diff --git a/reference/openal/functions/openal-source-destroy.xml b/reference/openal/functions/openal-source-destroy.xml index b2c56ae075..cb10de235a 100644 --- a/reference/openal/functions/openal-source-destroy.xml +++ b/reference/openal/functions/openal-source-destroy.xml @@ -1,5 +1,5 @@ - + openal_source_destroy @@ -7,38 +7,40 @@ Destroy a source resource - - Description + + &reftitle.description; resourceopenal_source_destroy resourcesource - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_source_create - + + + openal_source_create + + diff --git a/reference/openal/functions/openal-source-get.xml b/reference/openal/functions/openal-source-get.xml index 07e34f0a63..0325225852 100644 --- a/reference/openal/functions/openal-source-get.xml +++ b/reference/openal/functions/openal-source-get.xml @@ -1,5 +1,5 @@ - + openal_source_get @@ -7,30 +7,30 @@ Retrieve an OpenAL source property - - Description + + &reftitle.description; mixedopenal_source_get resourcesource intproperty - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + property - + Property to get, one of: AL_SOURCE_RELATIVE (int), AL_SOURCE_STATE (int), @@ -47,25 +47,27 @@ AL_POSITION (array(float,float,float)), AL_VELOCITY (array(float,float,float)), AL_DIRECTION (array(float,float,float)). - + - + &reftitle.returnvalues; - + Returns the type associated with the property being retreived or &false; on failure. - + - + &reftitle.seealso; - - openal_source_create, - openal_source_set&listendand; - openal_source_play - + + + openal_source_create + openal_source_set + openal_source_play + + diff --git a/reference/openal/functions/openal-source-pause.xml b/reference/openal/functions/openal-source-pause.xml index ba70af56b4..c37f84a104 100644 --- a/reference/openal/functions/openal-source-pause.xml +++ b/reference/openal/functions/openal-source-pause.xml @@ -1,5 +1,5 @@ - + openal_source_pause @@ -7,40 +7,42 @@ Pause the source - - Description + + &reftitle.description; boolopenal_source_pause resourcesource - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_source_stop, - openal_source_play&listendand; - openal_source_rewind - + + + openal_source_stop + openal_source_play + openal_source_rewind + + diff --git a/reference/openal/functions/openal-source-play.xml b/reference/openal/functions/openal-source-play.xml index 923173b89c..8cebb08ce5 100644 --- a/reference/openal/functions/openal-source-play.xml +++ b/reference/openal/functions/openal-source-play.xml @@ -1,5 +1,5 @@ - + openal_source_play @@ -7,40 +7,42 @@ Start playing the source - - Description + + &reftitle.description; boolopenal_source_play resourcesource - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_source_stop, - openal_source_pause&listendand; - openal_source_rewind - + + + openal_source_stop + openal_source_pause + openal_source_rewind + + diff --git a/reference/openal/functions/openal-source-rewind.xml b/reference/openal/functions/openal-source-rewind.xml index 4b1bc353b1..a6f0e8c2e8 100644 --- a/reference/openal/functions/openal-source-rewind.xml +++ b/reference/openal/functions/openal-source-rewind.xml @@ -1,5 +1,5 @@ - + openal_source_rewind @@ -7,40 +7,42 @@ Rewind the source - - Description + + &reftitle.description; boolopenal_source_rewind resourcesource - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_source_stop, - openal_source_pause&listendand; - openal_source_play - + + + openal_source_stop + openal_source_pause + openal_source_play + + diff --git a/reference/openal/functions/openal-source-set.xml b/reference/openal/functions/openal-source-set.xml index 9411b437e0..2c49d35409 100644 --- a/reference/openal/functions/openal-source-set.xml +++ b/reference/openal/functions/openal-source-set.xml @@ -1,5 +1,5 @@ - + openal_source_set @@ -7,8 +7,8 @@ Set source property - - Description + + &reftitle.description; boolopenal_source_set resourcesource @@ -16,22 +16,22 @@ mixedsetting - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + property - + Property to set, one of: AL_BUFFER (OpenAL(Source)), AL_LOOPING (bool), @@ -50,34 +50,36 @@ AL_POSITION (array(float,float,float)), AL_VELOCITY (array(float,float,float)), AL_DIRECTION (array(float,float,float)). - + setting - + Value to assign to specified property. Refer to the description of property for a description of the value(s) expected. - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_source_create, - openal_source_get&listendand; - openal_source_play - + + + openal_source_create + openal_source_get + openal_source_play + + diff --git a/reference/openal/functions/openal-source-stop.xml b/reference/openal/functions/openal-source-stop.xml index 2efc1cc73a..153f15c74f 100644 --- a/reference/openal/functions/openal-source-stop.xml +++ b/reference/openal/functions/openal-source-stop.xml @@ -1,5 +1,5 @@ - + openal_source_stop @@ -7,40 +7,42 @@ Stop playing the source - - Description + + &reftitle.description; boolopenal_source_stop resourcesource - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + - + &reftitle.returnvalues; &return.success; - + &reftitle.seealso; - - openal_source_play, - openal_source_pause&listendand; - openal_source_rewind - + + + openal_source_play + openal_source_pause + openal_source_rewind + + diff --git a/reference/openal/functions/openal-stream.xml b/reference/openal/functions/openal-stream.xml index 5fcb99527d..e190d21849 100644 --- a/reference/openal/functions/openal-stream.xml +++ b/reference/openal/functions/openal-stream.xml @@ -1,5 +1,5 @@ - + openal_stream @@ -7,8 +7,8 @@ Begin streaming on a source - - Description + + &reftitle.description; resourceopenal_stream resourcesource @@ -16,52 +16,54 @@ intrate - + &reftitle.parameters; source - + An Open AL(Source) resource (previously created by openal_source_create). - + format - + Format of data, one of: AL_FORMAT_MONO8, AL_FORMAT_MONO16, AL_FORMAT_STEREO8&listendand; AL_FORMAT_STEREO16 - + rate - + Frequency of data to stream given in Hz. - + - + &reftitle.returnvalues; - + Returns a stream resource on success, or &false; on failure. - + - + &reftitle.seealso; - - openal_source_create&listendand; - fwrite - + + + openal_source_create + fwrite + +