cookxml.core.doclet

Interface DocletActionReporter

All Known Implementing Classes:

CallFunctionAdder, CallFunctionSetter, CallSetterAdder, CompoundAdder, ConstantSetter, DefaultCreator, DefaultSetter, GetInstanceCreator, HelperCreator

public interface DocletActionReporter

This function returns the related function/constructor/field/methods that is called by creator/setter etc. CookXmlDoc would then retrieve the JavaDoc associated with Member object and use it in the documentation.

Since:

CookXml 3.1

Version:

$Id: DocletActionReporter.java 244 2007-06-07 04:29:13Z coconut $

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getActions(TagLibrary tagLibrary, java.lang.String tagNS, java.lang.String tag, java.lang.String attrNS, java.lang.String attr, java.lang.Class cl) This function returns the related function/constructor/field/methods that is called by creator/setter etc.

Method Detail

getActions

java.lang.Object[] getActions(TagLibrary tagLibrary,
                              java.lang.String tagNS,
                              java.lang.String tag,
                              java.lang.String attrNS,
                              java.lang.String attr,
                              java.lang.Class cl)

This function returns the related function/constructor/field/methods that is called by creator/setter etc. CookXmlDoc would then retrieve the JavaDoc associated with Member object and use it in the documentation.

Parameters:

tagLibrary - the tag library being used.

tagNS - the namespace of the tag

tag - possible tag

attrNS - the namespace of the attribute

attr - the attribute

cl - the possible class

Returns:

A non-empty array of actions performed by this object.