methodsynopsis
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# methodsynopsis

## Name

methodsynopsis — A syntax summary for a method

##

# Synopsis

### Content Model

    methodsynopsis ::=
    (modifier*,
     (type|void)?,
     methodname,
     (methodparam+|void),
     exceptionname*,modifier*)

### Attributes

Common attributes

### Parameter Entities

The following parameter entities contain methodsynopsis:

Parameter Entities
`%admon.mix;` | `%bookcomponent.content;` | `%component.mix;`
`%divcomponent.mix;` | `%example.mix;` | `%figure.mix;`
`%footnote.mix;` | `%glossdef.mix;` | `%indexdivcomponent.mix;`
`%method.synop.class;` | `%para.char.mix;` | `%qandaset.mix;`
`%refcomponent.mix;` | `%revdescription.mix;` | `%sidebar.mix;`
`%synop.class;` | `%tbl.entry.mdl;` |

## Description

A `MethodSynopsis` contains the syntax summary of a method (generally speaking, methods in the object-oriented programming language sense).

This is one of the few places where DocBook attempts to model as well as describe. Unlike `FuncSynopsis` which was designed with C language function prototypes in mind, the content model of `MethodSynopsis` was designed to capture a wide range of semantics.

### Processing expectations

For the most part, the processing application is expected to generate all of the parenthesis, semicolons, commas, and so on. required in the rendered synopsis.

### Parents

These elements contain methodsynopsis: `answer`, `appendix`, `application`, `article`, `attribution`, `bibliodiv`, `bibliography`, `bibliomisc`, `blockquote`, `callout`, `caution`, `chapter`, `citation`, `citetitle`, `classsynopsis`, `constraintdef`, `emphasis`, `entry`, `example`, `figure`, `footnote`, `foreignphrase`, `glossary`, `glossdef`, `glossdiv`, `glosssee`, `glossseealso`, `glossterm`, `important`, `index`, `indexdiv`, `informalexample`, `informalfigure`, `lineannotation`, `link`, `listitem`, `literallayout`, `lotentry`, `member`, `msgaud`, `msgexplan`, `msgtext`, `note`, `olink`, `para`, `partintro`, `phrase`, `preface`, `procedure`, `productname`, `programlisting`, `qandadiv`, `qandaset`, `question`, `quote`, `refentrytitle`, `refsect1`, `refsect2`, `refsect3`, `refsynopsisdiv`, `remark`, `revdescription`, `screen`, `screeninfo`, `sect1`, `sect2`, `sect3`, `sect4`, `sect5`, `section`, `seg`, `setindex`, `sidebar`, `simpara`, `simplesect`, `step`, `synopsis`, `term`, `tip`, `tocback`, `tocentry`, `tocfront`, `ulink`, `warning`.

### Children

The following elements occur in methodsynopsis: `exceptionname`, `methodname`, `methodparam`, `modifier`, `type`, `void`.

Prev | Home | Next
methodparam | Up | modespec

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.