Rename imageDescriptor -> cl_image_desc
This makes it more consistent with cl_image_format and makes the
resulting man page named like the struct, making it easier to find.
diff --git a/sdk/1.2/docs/man/clCreateImage.xml b/sdk/1.2/docs/man/clCreateImage.xml
index 4778f3b..56320a4 100644
--- a/sdk/1.2/docs/man/clCreateImage.xml
+++ b/sdk/1.2/docs/man/clCreateImage.xml
@@ -55,7 +55,7 @@
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_mem_flags">cl_mem_flags</link><parameter>flags</parameter></paramdef>
<paramdef>const <link xlink:href="cl_image_format.html">cl_image_format</link><parameter>*image_format</parameter></paramdef>
- <paramdef>const <link xlink:href="imageDescriptor.html">cl_image_desc</link><parameter>*image_desc</parameter></paramdef>
+ <paramdef>const <link xlink:href="cl_image_desc.html">cl_image_desc</link><parameter>*image_desc</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">void</link><parameter>*host_ptr</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_int</link><parameter>*errcode_ret</parameter></paramdef>
@@ -138,7 +138,7 @@
<para>
<!-- parameter description --> A pointer to a structure that
describes type and dimensions of the image to be allocated. See
- <citerefentry><refentrytitle>imageDescriptor</refentrytitle></citerefentry>
+ <citerefentry><refentrytitle>cl_image_desc</refentrytitle></citerefentry>
for more information.
</para>
</listitem>
@@ -378,7 +378,7 @@
<refsect1 id="seealso"><title>Also see</title>
<para>
- <citerefentry href="imageDescriptor"><refentrytitle>cl_image_desc</refentrytitle></citerefentry>,
+ <citerefentry><refentrytitle>cl_image_desc</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>cl_image_format</refentrytitle></citerefentry>,
<citerefentry href="classDiagram"><refentrytitle>Cardinality Diagram</refentrytitle></citerefentry>
</para>
diff --git a/sdk/1.2/docs/man/imageDescriptor.xml b/sdk/1.2/docs/man/cl_image_desc.xml
similarity index 97%
rename from sdk/1.2/docs/man/imageDescriptor.xml
rename to sdk/1.2/docs/man/cl_image_desc.xml
index f6ea467..3d90869 100644
--- a/sdk/1.2/docs/man/imageDescriptor.xml
+++ b/sdk/1.2/docs/man/cl_image_desc.xml
@@ -5,12 +5,12 @@
<refentry>
<refentryinfo>
<keywordset>
- <keyword>imageDescriptor</keyword>
+ <keyword>cl_image_desc</keyword>
</keywordset>
</refentryinfo>
<refmeta>
- <refentrytitle>imageDescriptor</refentrytitle>
+ <refentrytitle>cl_image_desc</refentrytitle>
<refmiscinfo>
<copyright>
@@ -32,7 +32,7 @@
<!-- ================================ SYNOPSIS -->
<refnamediv id="cl_image_desc">
- <refname>imageDescriptor</refname>
+ <refname>cl_image_desc</refname>
<refpurpose>
The image descriptor structure describes the type and dimensions of the image or image array and is defined as:
@@ -251,7 +251,7 @@
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<!-- Links to the 'Image Format Descriptor' sec of spec -->
- <olink uri="imageDescriptor">OpenCL Specification</olink>
+ <olink uri="cl_image_desc">OpenCL Specification</olink>
</para>
</refsect1>
diff --git a/sdk/1.2/docs/man/cl_image_format.xml b/sdk/1.2/docs/man/cl_image_format.xml
index 07abf85..26400cf 100644
--- a/sdk/1.2/docs/man/cl_image_format.xml
+++ b/sdk/1.2/docs/man/cl_image_format.xml
@@ -327,7 +327,7 @@
<refsect1 id="seealso"><title>Also see</title>
<para>
- <citerefentry href="imageDescriptor"><refentrytitle>cl_image_desc Image Descriptor</refentrytitle></citerefentry>,
+ <citerefentry><refentrytitle>cl_image_desc</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>EXTENSION</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clGetSupportedImageFormats</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateImage</refentrytitle></citerefentry>
diff --git a/sdk/1.2/docs/man/xhtml/Makefile b/sdk/1.2/docs/man/xhtml/Makefile
index 82a7d18..bc02acf 100644
--- a/sdk/1.2/docs/man/xhtml/Makefile
+++ b/sdk/1.2/docs/man/xhtml/Makefile
@@ -157,6 +157,7 @@
clGetSupportedImageFormats.html \
clIcdGetPlatformIDsKHR.html \
cl_image_format.html \
+ cl_image_desc.html \
cl_khr_3d_image_writes.html \
cl_khr_dx9_media_sharing.html \
cl_khr_d3d10_sharing.html \
@@ -245,7 +246,6 @@
hadd.html \
hypot.html \
ilogb.html \
- imageDescriptor.html \
imageFunctions.html \
integerClamp.html \
integerFunctions.html \
diff --git a/sdk/1.2/docs/man/xhtml/pageNumberLookup.rb b/sdk/1.2/docs/man/xhtml/pageNumberLookup.rb
index 930924e..7ca3e0f 100755
--- a/sdk/1.2/docs/man/xhtml/pageNumberLookup.rb
+++ b/sdk/1.2/docs/man/xhtml/pageNumberLookup.rb
@@ -84,7 +84,7 @@
"clEnqueueMapBuffer" => [Core, 86], # 5.2.3 - Mapping Buffer Objects
"clCreateImage" => [Core, 90], # 5.3.1 - Creating Image Objects
"cl_image_format" => [Core, 92], # 5.3.1.1 - Image Format Descriptor
- "imageDescriptor" => [Core, 95], # 5.3.1.2 - Image Descriptor
+ "cl_image_desc" => [Core, 95], # 5.3.1.2 - Image Descriptor
"clGetSupportedImageFormats" => [Core, 96], # 5.3.2 - Querying List of Supported Image Formats
"supportedImageFormats" => [Core, 97], # 5.3.2.1 - Supported Image Formats
"clEnqueueReadImage" => [Core, 98], # 5.3.3 - Reading, Writing and Copying Image Objects
diff --git a/sdk/2.0/docs/man/cl_image_desc.xml b/sdk/2.0/docs/man/cl_image_desc.xml
index 66c94a1..4bd212e 100644
--- a/sdk/2.0/docs/man/cl_image_desc.xml
+++ b/sdk/2.0/docs/man/cl_image_desc.xml
@@ -5,12 +5,12 @@
<refentry>
<refentryinfo>
<keywordset>
- <keyword>imageDescriptor</keyword>
+ <keyword>cl_image_desc</keyword>
</keywordset>
</refentryinfo>
<refmeta>
- <refentrytitle>imageDescriptor</refentrytitle>
+ <refentrytitle>cl_image_desc</refentrytitle>
<refmiscinfo>
<copyright>
@@ -32,7 +32,7 @@
<!-- ================================ SYNOPSIS -->
<refnamediv id="cl_image_desc">
- <refname>imageDescriptor</refname>
+ <refname>cl_image_desc</refname>
<refpurpose>
The image descriptor structure describes the type and dimensions of the image or image array and is defined as:
diff --git a/sdk/2.1/docs/man/clCreateImage.xml b/sdk/2.1/docs/man/clCreateImage.xml
index 9a21fab..40adaa0 100644
--- a/sdk/2.1/docs/man/clCreateImage.xml
+++ b/sdk/2.1/docs/man/clCreateImage.xml
@@ -141,7 +141,7 @@
<para>
<!-- parameter description --> A pointer to a structure that
describes type and dimensions of the image to be allocated. See
- <citerefentry href="cl_image_desc"><refentrytitle>imageDescriptor</refentrytitle></citerefentry>
+ <citerefentry><refentrytitle>cl_image_desc</refentrytitle></citerefentry>
for more information.
</para>
</listitem>
diff --git a/sdk/2.1/docs/man/cl_image_desc.xml b/sdk/2.1/docs/man/cl_image_desc.xml
index 66c94a1..4bd212e 100644
--- a/sdk/2.1/docs/man/cl_image_desc.xml
+++ b/sdk/2.1/docs/man/cl_image_desc.xml
@@ -5,12 +5,12 @@
<refentry>
<refentryinfo>
<keywordset>
- <keyword>imageDescriptor</keyword>
+ <keyword>cl_image_desc</keyword>
</keywordset>
</refentryinfo>
<refmeta>
- <refentrytitle>imageDescriptor</refentrytitle>
+ <refentrytitle>cl_image_desc</refentrytitle>
<refmiscinfo>
<copyright>
@@ -32,7 +32,7 @@
<!-- ================================ SYNOPSIS -->
<refnamediv id="cl_image_desc">
- <refname>imageDescriptor</refname>
+ <refname>cl_image_desc</refname>
<refpurpose>
The image descriptor structure describes the type and dimensions of the image or image array and is defined as: