Description: The <apiDesc> element describes the API item in detail, and expands on the short description about that API item.

# apiDesc

The <apiDesc> element describes the API item in detail, and expands on the short description about that API item.

#### Description

For example, in the Java API reference, the <apiDesc> element represents the class, interface, field, method, and parameter description.

#### Example

The following examples illustrate types of <apiDesc> elements for different API class items:

    <javaFieldDetail>
          <apiDesc>This constant is returned if the connection is open.</apiDesc>
    </javaFieldDetail>

    <javaParamDetail>
         <apiDesc>Be sure to provide a test parameter that matches the defined properties.</apiDesc>
    </javaParamDetail>

    <javaMethodDetail>
          <apiDesc>Specifies the format and size of the serialized content.</apiDesc>
    </javaMethodDetail>

#### Contained by

apiClassifierDetail, apiDetail, apiOperationDetail, apiValueDetail

#### Contains

apiname, b, boolean, cite, cmdname, codeblock, codeph, dl, draft-comment, fig, filepath, fn, i, image, imagemap, indexterm, indextermref, keyword, lines, lq, menucascade, msgblock, msgnum, msgph, note, object, ol, option, p, parml, parmname, ph, pre, q, required-cleanup, screen, simpletable, sl, state, sub, sup, synph, syntaxdiagram, systemoutput, table, term, tm, tt, u, uicontrol, ul, userinput, varname, wintitle, xref

#### Content model

(text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or p or lq or note or dl or parml or ul or ol or sl or pre or codeblock or msgblock or screen or lines or fig or syntaxdiagram or imagemap or image or object or table or simpletable or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

#### Inheritance

topic/section reference/section

Parent topic: apiDetail
Parent topic: apiClassifierDetail
Parent topic: apiOperationDetail
Parent topic: apiValueDetail