javaMethod

The <javaMethod> element provides the name of the Java API method that you are describing and all the elements necessary to describe the method.

Description

The <javaMethod> template requires an ID attribute as an anchor point. This ID is the target for references by the keyref attribute and for the internal applications that refer to that <javaMethod> element content. Use a unique key such as fully qualified class name (for example, com.ibm.xtools.ras.engine.tasks.IImportEngineTask) for the named API reference.

The <apiName>, <shortdesc> and the <javaMethodDetail> elements are required for this top-level container. The name of a method must differ from the name of all other non methods declared in the same class.

Contained by

javaClass, javaInterface

Contains

apiName, javaMethodDetail, no-topic-nesting, prolog, related-links, shortdesc

Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (javaMethodDetail) then (related-links) (optional) then (no-topic-nesting) (any number))

Inheritance

topic/topic reference/reference apiRef/apiRef apiOperation/apiOperation