Print
MetaClass Doclet Tags

Introduction

Warning! This is just a draft of the upcoming document.

A Doclet Tag is metadata insterted into the Javadoc part of a source file. A tag is always prefixed with the @ character.

MetaClass Tags

The following tags are defined

mx.component

Defines a component.

Position: Class or Interface header

Parameters:

  • description Description of the class ( Is this mandatory? It doesn't seem to be.)
  • Why is it not possible to set topic on the component directly? *

mx.interface

Indicates a specific interface as a management interface.

Position: Class header

Parameters:

  • type Classname of the interface (mandatory)
  • topic Topic of the management interface *

mx.constructor

Defines a constructor

Position: Constructor header

mx.operation

Defines a method

Position: Method header

Parameters:

  • impact The impact of a method call. Possible values are 'INFO', 'ACTION' and 'ACTION_INFO'.

mx.attribute

Defines a Getter or Setter method

Position: Method header

mx.parameter

Annotates constructor and method parameters

Position: Method or Constructor header

Parameters:

  • name Name of the paramter (mandatory)
  • description Description of the parameter

Notes

topic

Verify if the following is correct

Each managed class can have multiple "topics" associated with them. Still, usually one topic is defined for each managed object and one for each management interface. The topic name may be used by the management subsystem and shown to the user by the management agent.

Powered by Atlassian Confluence