DocBook: The Definitive Guide

docbook: the definitive guide
By Norman Walsh & Leonard Muellner
1st Edition October 1999
1-56592-580-7, Order Number: 5807
652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
PrevNext

Name

ParamDef -- Information about a function parameter in a programming language

Synopsis

Mixed Content Model

ParamDef ::= ((#PCDATA|Replaceable|Parameter|FuncParams)*)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Description

In the syntax summary for a function in a programming language, ParamDef provides the description of a parameter to the function. Typically, this includes the data type of the parameter and its name. For parameters that are pointers to functions, it also includes a summary of the nested parameters.

Within the ParamDef, the parameter name is identified with Parameter, and the rest of the content is assumed to be the data type.

In the following definition, str is the name of the parameter and char * is its type:

<paramdef>char *<parameter>str</parameter></paramdef>

Sometimes a data type requires punctuation on both sides of the parameter. For example, the a parameter in this definition is an array of char *:

<paramdef>char *<parameter>a</parameter>[]</paramdef>

Processing expectations

Formatted inline. For a complete description of the processing expectations, see FuncSynopsis.

Parents

These elements contain ParamDef: FuncPrototype, FuncSynopsis.

Children

The following elements occur in ParamDef: FuncParams, Parameter, Replaceable.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

See Also

FuncDef, FuncParams, FuncPrototype, FuncSynopsisInfo, Function, Parameter, ReturnValue, VarArgs, Void

Examples

<!DOCTYPE funcsynopsis PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <funcsynopsis> <funcprototype>   <funcdef>int <function>max</function></funcdef>   <paramdef>int <parameter>int1</parameter></paramdef>   <paramdef>int <parameter>int2</parameter></paramdef> </funcprototype> </funcsynopsis>

int max(int int1, int int2);

For additional examples, see also FuncDef, FuncSynopsis.


PrevHomeNext
ParaUpParameter

Back to: DocBook: The Definitive Guide


O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts
International | About O'Reilly | Affiliated Companies

© 1999, O'Reilly & Associates, Inc.



DocBook. The Definitive Guide
DocBook 5: The Definitive Guide
ISBN: 0596805020
EAN: 2147483647
Year: 1999
Pages: 412
Authors: Walsh Norman, Richard L. Hamilton
BUY ON AMAZON

Similar book on Amazon
DocBook XSL: The Complete Guide (4th Edition)
DocBook XSL: The Complete Guide (4th Edition)
XSLT, 2nd Edition
XSLT, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XSLT Cookbook: Solutions and Examples for XML and XSLT Developers, 2nd Edition
XML: Visual QuickStart Guide (2nd Edition)
XML: Visual QuickStart Guide (2nd Edition)

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net