summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Dew <marcoz@osource.org>2011-05-25 23:49:37 -0600
committerMatt Dew <marcoz@osource.org>2011-06-04 09:58:44 -0600
commitacc529ed1f1cff6c79d3b6f711ff64da97bb864c (patch)
tree81591f07e3a70135dc69a7f54a4e386ef5d7d36f
parent8451664d228852f7b57eb11a35be3328b6fff13a (diff)
add id attributes to funcsynopsis to allow other docs to olink to them.
Signed-off-by: Matt Dew <marcoz@osource.org> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
-rw-r--r--specs/dbelib.xml16
-rw-r--r--specs/dpmslib.xml18
-rw-r--r--specs/shapelib.xml22
-rw-r--r--specs/synclib.xml64
4 files changed, 60 insertions, 60 deletions
diff --git a/specs/dbelib.xml b/specs/dbelib.xml
index a1010c8..5a969a2 100644
--- a/specs/dbelib.xml
+++ b/specs/dbelib.xml
@@ -473,7 +473,7 @@ start of the function name with DBE. All functions that have return type
zero for failure.
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbequeryextension'>
<funcprototype>
<funcdef>Status <function>XdbeQueryExtension</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -494,7 +494,7 @@ violates this rule, the effects of all subsequent Xdbe calls that it makes
are undefined.
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbegetvisualinfo'>
<funcprototype>
<funcdef>XdbeScreenVisualInfo *<function>XdbeGetVisualInfo</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -555,7 +555,7 @@ int perflevel performance level of visual
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbeallocatebackbuffername'>
<funcprototype>
<funcdef>XdbeBackBuffer <function>XdbeAllocateBackBufferName</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -575,7 +575,7 @@ the same as the swap_action passed to this function, though clients are
encouraged to provide accurate information whenever possible.
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbedeallocatebackbuffername'>
<funcprototype>
<funcdef>Status <function>XdbeDeallocateBackBufferName</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -591,7 +591,7 @@ name for the back buffer of a window, or an
<function>XdbeBadBuffer</function> error results.
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbeswapbuffers'>
<funcprototype>
<funcdef>Status <function>XdbeSwapBuffers</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -616,7 +616,7 @@ Window swap_window window for which to swap buffers
XdbeSwapAction swap_action swap action to use for this swap window
</literallayout>
-<funcsynopsis>
+<funcsynopsis id='xdbebeginidiom'>
<funcprototype>
<funcdef>Status <function>XdbeBeginIdiom</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -631,7 +631,7 @@ sequence. See
for a complete discussion of idioms.
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbeendidiom'>
<funcprototype>
<funcdef>Status <function>XdbeEndIdiom</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -642,7 +642,7 @@ for a complete discussion of idioms.
<function>XdbeEndIdiom</function> marks the end of an idiom sequence.
</para>
-<funcsynopsis>
+<funcsynopsis id='xdbegetbackbufferattributes'>
<funcprototype>
<funcdef>XdbeBackBufferAttributes *<function>XdbeGetBackBufferAttributes</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
diff --git a/specs/dpmslib.xml b/specs/dpmslib.xml
index 15f54e8..1fe81d2 100644
--- a/specs/dpmslib.xml
+++ b/specs/dpmslib.xml
@@ -85,7 +85,7 @@ These are mapped onto the X DPMS Extension like this:
<title>DPMS Functions</title>
-<funcsynopsis>
+<funcsynopsis id='dpmsqueryextention'>
<funcprototype>
<funcdef>Bool <function>DPMSQueryExtention</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -120,7 +120,7 @@ return value is FALSE, and the values of
<emphasis remap='I'>error_base</emphasis> are undefined.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmsgetversion'>
<funcprototype>
<funcdef>Status <function>DPMSGetVersion</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -156,7 +156,7 @@ incompatible changes, and the minor version will be incremented for small,
upwardly compatible changes.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmscapable'>
<funcprototype>
<funcdef>Bool <function>DPMSCapable</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -179,7 +179,7 @@ is capable of DPMS on one head, and incapable on another, the truth value of
this function is defined by the X server implementation.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmssettimeouts'>
<funcprototype>
<funcdef>Status <function>DPMSSetTimeouts</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -255,7 +255,7 @@ or equal to the timeout values of earlier modes. If inconsistent values
are supplied, a BadValue error will result.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmsgettimeouts'>
<funcprototype>
<funcdef>Status <function>DPMSGetTimeouts</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -307,7 +307,7 @@ inactivity in seconds before the third and final level of power savings is
invoked. A value of zero indicates that this mode has been disabled.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmsenable'>
<funcprototype>
<funcdef>Status <function>DPMSEnable</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -331,7 +331,7 @@ error is returned. If DPMSEnable is invoked on a display without
support for DPMS, no change is made and no error is returned.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmsdisable'>
<funcprototype>
<funcdef>Status <function>DPMSDisable</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -353,7 +353,7 @@ and no error is returned. If DPMSDisable is invoked on a display
without support for DPMS, no change is made and no error is returned.
</para>
-<funcsynopsis>
+<funcsynopsis id='dpmsforcelevel'>
<funcprototype>
<funcdef>Status <function>DPMSForceLevel</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -382,7 +382,7 @@ is disabled on the display, a BadMatch protocol error will result.
<para>Status DPMSInfo(<emphasis remap='I'>display, power_level, state</emphasis>)</para>
-<funcsynopsis>
+<funcsynopsis id='dpmsinfo'>
<funcprototype>
<funcdef>Status <function>DPMSInfo</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
diff --git a/specs/shapelib.xml b/specs/shapelib.xml
index a06cd23..a357da4 100644
--- a/specs/shapelib.xml
+++ b/specs/shapelib.xml
@@ -253,7 +253,7 @@ The defined region operations are
and
<function>ShapeInvert</function>.</para>
-<funcsynopsis>
+<funcsynopsis id='xshapequeryextension'>
<funcprototype>
<funcdef>Bool<function> XShapeQueryExtension</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -275,7 +275,7 @@ this extension. Because no errors are defined for this version of
the extension, the value returned here is not defined (nor useful).
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapequeryversion'>
<funcprototype>
<funcdef>Status<function> XShapeQueryVersion</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -292,7 +292,7 @@ extension supported by the display and returns a nonzero value.
Otherwise, the arguments are not set and zero is returned.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapecombineregion'>
<funcprototype>
<funcdef><function>XShapeCombineRegion</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -312,7 +312,7 @@ converts the specified region into a list of rectangles and calls
<function>XShapeCombineRectangles</function>
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapecombinerectangles'>
<funcprototype>
<funcdef><function>XShapeCombineRectangles</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -335,7 +335,7 @@ performs a
operation; otherwise, the request is ignored.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapecombinemask'>
<funcprototype>
<funcdef><function>XShapeCombineMask</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -356,7 +356,7 @@ performs a
operation; otherwise, the request is ignored.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapecombineshape'>
<funcprototype>
<funcdef><function>XShapeCombineShape</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -378,7 +378,7 @@ performs a
operation; otherwise, the request is ignored.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapeoffsetshape'>
<funcprototype>
<funcdef><function>XShapeOffsetShape</function></funcdef>
<paramdef><parameter>display</parameter></paramdef>
@@ -397,7 +397,7 @@ performs a
operation; otherwise, the request is ignored.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapequeryextents'>
<funcprototype>
<funcdef>Status <function>XShapeQueryExtents</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -429,7 +429,7 @@ If the extension is supported, a nonzero value is returned; otherwise,
zero is returned.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapeselectinput'>
<funcprototype>
<funcdef><function>XShapeSelectInput</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -464,7 +464,7 @@ typedef struct {
} XShapeEvent;
</literallayout>
-<funcsynopsis>
+<funcsynopsis id='xshapeinputselected'>
<funcprototype>
<funcdef>unsigned long <function>XShapeInputSelected</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
@@ -483,7 +483,7 @@ otherwise, it returns zero.
If the extension is not supported, it returns zero.
</para>
-<funcsynopsis>
+<funcsynopsis id='xshapegetrectangles'>
<funcprototype>
<funcdef>XRectangle<function> *XShapeGetRectangles</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
diff --git a/specs/synclib.xml b/specs/synclib.xml
index 36b77d8..36c7162 100644
--- a/specs/synclib.xml
+++ b/specs/synclib.xml
@@ -188,7 +188,7 @@ capitalization.
Most of the following functions generate SYNC protocol requests.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncqueryextension'>
<funcprototype>
<funcdef>Status <function>XSyncQueryExtension</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -205,7 +205,7 @@ sets *error_base_return to the error number for the first SYNC error. If dpy
does not support the SYNC extension, it returns False.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncinitialize'>
<funcprototype>
<funcdef>Status <function>XSyncInitialize</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -227,7 +227,7 @@ XSyncQueryExtension. If a client violates this rule, the effects of all XSync
calls that it makes are undefined.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsynclistsystemcounters'>
<funcprototype>
<funcdef>XSyncSystemCounter *<function>XSyncListSystemCounters</function></funcdef>
<paramdef>Display <parameter> *dpy</parameter></paramdef>
@@ -255,7 +255,7 @@ XSyncCounter counter; /* counter id of this system counter */
XSyncValue resolution; /* resolution of this system counter */
</literallayout>
-<funcsynopsis>
+<funcsynopsis id='xsyncfreesystemcounterlist'>
<funcprototype>
<funcdef>void <function>XSyncFreeSystemCounterList</function></funcdef>
<paramdef>XSyncSystemCounter <parameter> *list</parameter></paramdef>
@@ -268,7 +268,7 @@ associated with the system counter list returned by
<function>XSyncListSystemCounters</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsynccreatecounter'>
<funcprototype>
<funcdef>XSyncCounter <function>XSyncCreateCounter</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -282,7 +282,7 @@ with the given initial value and returns the counter ID. It returns
<function>None</function> if dpy does not support the SYNC extension.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncsetcounter'>
<funcprototype>
<funcdef>Status <function>XSyncSetCounter</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -298,7 +298,7 @@ with the given initial value and returns the counter ID. It returns
support the SYNC extension; otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncchangecounter'>
<funcprototype>
<funcdef>Status <function>XSyncChangeCounter</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -313,7 +313,7 @@ support the SYNC extension; otherwise, it returns <function>True</function>.
otherwise, it returns
<function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncdestroycounter'>
<funcprototype>
<funcdef>Status <function>XSyncDestroyCounter</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -327,7 +327,7 @@ otherwise, it returns
otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncquerycounter'>
<funcprototype>
<funcdef>Status <function>XSyncQueryCounter</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -343,7 +343,7 @@ error during communication with the server or if dpy does not support the
SYNC extension; otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncawait'>
<funcprototype>
<funcdef>Status <function>XSyncAwait</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -385,7 +385,7 @@ XSyncValue event_threshold; /*send event if past threshold */
<function>XSyncNegativeComparison</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsynccreatealarm'>
<funcprototype>
<funcdef>XSyncAlarm <function>XSyncCreateAlarm</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -421,7 +421,7 @@ Bool events; XSyncCAEvents
XSyncAlarmState state; client cannot set this
</literallayout>
-<funcsynopsis>
+<funcsynopsis id='xsyncdestroyalarm'>
<funcprototype>
<funcdef>Status <function>XSyncDestroyAlarm</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -435,7 +435,7 @@ XSyncAlarmState state; client cannot set this
the SYNC extension; otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncqueryalarm'>
<funcprototype>
<funcdef>Status <function>XSyncQueryAlarm</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -452,7 +452,7 @@ during communication with the server or if dpy does not support the
SYNC extension; otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncchangealarm'>
<funcprototype>
<funcdef>Status <function>XSyncChangeAlarm</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -470,7 +470,7 @@ attributes to change are specified as in
the SYNC extension; otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncsetpriority'>
<funcprototype>
<funcdef>Status <function>XSyncSetPriority</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -487,7 +487,7 @@ sets the caller’s priority. It returns
otherwise, it returns <function>True</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncgetpriority'>
<funcprototype>
<funcdef>Status <function>XSyncGetPriority</function></funcdef>
<paramdef>Display<parameter> *dpy</parameter></paramdef>
@@ -516,7 +516,7 @@ macros and as functions. By default, the macro form is used. To use the
function form, #undef the macro name to uncover the function.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncinttovalue'>
<funcprototype>
<funcdef>void <function>XSyncIntToValue</function></funcdef>
<paramdef>XSyncValue<parameter> *pv</parameter></paramdef>
@@ -529,7 +529,7 @@ Converts i to an <function>XSyncValue</function> and stores it in *pv.
Performs sign extension (*pv will have the same sign as i.)
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncintstovalue'>
<funcprototype>
<funcdef>void <function>XSyncIntsToValue</function></funcdef>
<paramdef>XSyncValue<parameter> *pv</parameter></paramdef>
@@ -543,7 +543,7 @@ Stores low in the low 32 bits of *pv and high in the high 32 bits of *pv.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluegreaterthan'>
<funcprototype>
<funcdef>Bool <function>XSyncValueGreaterThan</function></funcdef>
<paramdef>XSyncValue<parameter> a</parameter></paramdef>
@@ -556,7 +556,7 @@ Returns <function>True</function> if a is greater than b, else returns
<function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluelessthan'>
<funcprototype>
<funcdef>Bool <function>XSyncValueLessThan</function></funcdef>
<paramdef>XSyncValue<parameter> a</parameter></paramdef>
@@ -570,7 +570,7 @@ Returns <function>True</function> if a is less than b, else returns
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluegreaterorequal'>
<funcprototype>
<funcdef>Bool <function>XSyncValueGreaterOrEqual</function></funcdef>
<paramdef>XSyncValue<parameter> a</parameter></paramdef>
@@ -583,7 +583,7 @@ Returns <function>True</function> if a is greater than or equal to b,
else returns <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluelessorequal'>
<funcprototype>
<funcdef>Bool <function>XSyncValueLessOrEqual</function></funcdef>
<paramdef>XSyncValue<parameter> a</parameter></paramdef>
@@ -596,7 +596,7 @@ Returns <function>True</function> if a is less than or equal to b,
else returns <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvalueequal'>
<funcprototype>
<funcdef>Bool <function>XSyncValueEqual</function></funcdef>
<paramdef>XSyncValue<parameter> a</parameter></paramdef>
@@ -609,7 +609,7 @@ Returns <function>True</function> if a is equal to b,
else returns <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvalueisnegative'>
<funcprototype>
<funcdef>Bool <function>XSyncValueIsNegative</function></funcdef>
<paramdef>XSyncValue<parameter> v</parameter></paramdef>
@@ -621,7 +621,7 @@ Returns <function>True</function> if v is negative,
else returns <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvalueiszero'>
<funcprototype>
<funcdef>Bool <function>XSyncValueIsZero</function></funcdef>
<paramdef>XSyncValue<parameter> v</parameter></paramdef>
@@ -633,7 +633,7 @@ Returns <function>True</function> if v is zero,
else returns <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvalueispositive'>
<funcprototype>
<funcdef>Bool <function>XSyncValueIsPositive</function></funcdef>
<paramdef>XSyncValue<parameter> v</parameter></paramdef>
@@ -645,7 +645,7 @@ Returns <function>True</function> if v is positive,
else returns <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluelow32'>
<funcprototype>
<funcdef>unsigned int <function>XSyncValueLow32</function></funcdef>
<paramdef>XSyncValue<parameter> v</parameter></paramdef>
@@ -656,7 +656,7 @@ else returns <function>False</function>.
Returns the low 32 bits of v.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluehigh32'>
<funcprototype>
<funcdef>unsigned int <function>XSyncValueHigh32</function></funcdef>
<paramdef>XSyncValue<parameter> v</parameter></paramdef>
@@ -667,7 +667,7 @@ Returns the low 32 bits of v.
Returns the high 32 bits of v.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvalueadd'>
<funcprototype>
<funcdef>void <function>XSyncValueAdd</function></funcdef>
<paramdef>XSyncValue<parameter> *presult</parameter></paramdef>
@@ -683,7 +683,7 @@ fit in 64 bits, *poverflow is set to <function>True</function>, else it is
set to <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncvaluesubtract'>
<funcprototype>
<funcdef>void <function>XSyncValueSubtract</function></funcdef>
<paramdef>XSyncValue<parameter> *presult</parameter></paramdef>
@@ -699,7 +699,7 @@ fit in 64 bits, *poverflow is set to <function>True</function>, else it is
set to <function>False</function>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncmaxvalue'>
<funcprototype>
<funcdef>void <function>XSyncMaxValue</function></funcdef>
<paramdef>XSyncValue<parameter> *pv</parameter></paramdef>
@@ -710,7 +710,7 @@ set to <function>False</function>.
Sets *pv to the maximum value expressible in 64 bits.
</para>
-<funcsynopsis>
+<funcsynopsis id='xsyncminvalue'>
<funcprototype>
<funcdef>void <function>XSyncMinValue</function></funcdef>
<paramdef>XSyncValue<parameter> *pv</parameter></paramdef>