funcparams

funcparams — Parameters for a function referenced through a function pointer in a synopsis

Synopsis

funcparams ::=

Zero or more of:
- text
- phrase (db._phrase)
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  
  indexterm (db.indexterm.singular)
  
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  
  biblioref
  
  link
  
  olink
  
  xref
- Ubiquitous inlines
  alt
  
  anchor
  
  annotation
  
  biblioref
  
  indexterm (db.indexterm.endofrange)
  
  indexterm (db.indexterm.singular)
  
  indexterm (db.indexterm.startofrange)
  
  inlinemediaobject
  
  link
  
  olink
  
  remark
  
  subscript
  
  superscript
  
  xref

Attributes

Common attributes and common linking attributes.

Description

In some programming languages (like C), it is possible for a function to have a pointer to another function as one of its parameters. In the syntax summary for such a function, the funcparams element provides a wrapper for the function pointer.

For example, the following prototype describes the function sort, which takes two parameters. The first parameter, arr, is an array of integers. The second parameter is a pointer to a function, comp that returns an int. The comp function takes two parameters, both of type int *:


<funcprototype>
  <funcdef>void <function>sort</function></funcdef>
    <paramdef>int *<parameter>arr</parameter>[]</paramdef>
    <paramdef>int <parameter>(* comp)</parameter>
      <funcparams>int *, int *</funcparams></paramdef>
</funcprototype>

Processing expectations

Formatted inline. For a complete description of the processing expecations, see funcsynopsis.

Parents

These elements contain funcparams: methodparam, paramdef.

Children

The following elements occur in funcparams: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, xref.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example funcparams</title>

<funcsynopsis>
<funcprototype>
  <funcdef>void <function>qsort</function></funcdef>
    <paramdef>void *<parameter>dataptr</parameter>[]</paramdef>
    <paramdef>int <parameter>left</parameter></paramdef>
    <paramdef>int <parameter>right</parameter></paramdef>
    <paramdef>int (*<parameter>comp</parameter>)
      <funcparams>void *, void *</funcparams></paramdef>
</funcprototype>
</funcsynopsis>

</article>

`void qsort(`	`dataptr`,
	`left`,
	`right`,
	`comp)`;

`void *`	`dataptr;`
`int`	`left;`
`int`	`right;`
`int (*`	`comp`(void , void `)`;

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.


funcdef		funcprototype