User: d_jencks
Date: 02/04/05 20:12:55
Added: core/resources/xdoclet/jmx/vendor jbossmx-xml-doc.j
Log:
added jmx mbean documentation generation (to docbook) tsubtask
Revision Changes Path
1.1 xdoclet/core/resources/xdoclet/jmx/vendor/jbossmx-xml-doc.j
Index: jbossmx-xml-doc.j
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "<XDtXml:publicId/>" "<XDtXml:systemId/>">
<section>
<title><XDtClass:fullClassName/></title>
<XDtClass:ifHasClassTag tagName="jmx:mbean" paramName="name"><subtitle>Default
ObjectName: <XDtClass:classTagValue tagName="jmx:mbean"
paramName="name"/></subtitle></XDtClass:ifHasClassTag>
<para><XDtClass:classComment no-comment-signs="true"/></para>
<table>
<title>Descriptors</title>
<tgroup cols="3">
<colspec colname="descriptor"/>
<colspec colname="value"/>
<thead>
<row>
<entry>Descriptor</entry>
<entry>Value</entry>
</row>
</thead>
<tbody>
<XDtClass:ifHasClassTag tagName="jmx:mbean" paramName="persistPolicy"><row>
<entry>persistPolicy</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="persistPolicy"/></entry>
</row></XDtClass:ifHasClassTag>
<XDtClass:ifHasClassTag tagName="jmx:mbean" paramName="persistPeriod"><row>
<entry>persistPeriod</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="persistPeriod"/></entry>
</row></XDtClass:ifHasClassTag>
<XDtClass:ifHasClassTag tagName="jmx:mbean"
paramName="persistLocation"><row>
<entry>persistLocation</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="persistLocation"/></entry>
</row></XDtClass:ifHasClassTag>
<XDtClass:ifHasClassTag tagName="jmx:mbean" paramName="persistName"><row>
<entry>persistName</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="persistName"/></entry>
</row></XDtClass:ifHasClassTag>
<XDtClass:ifHasClassTag tagName="jmx:mbean"
paramName="currencyTimeLimit"><row>
<entry>currencyTimeLimit</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="currencyTimeLimit"/></entry>
</row></XDtClass:ifHasClassTag>
<XDtClass:ifHasClassTag tagName="jmx:mbean"
paramName="state-action-on-update"><row>
<entry>state-action-on-update</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="state-action-on-update"/></entry>
</row></XDtClass:ifHasClassTag>
<XDtClass:ifHasClassTag tagName="jmx:mbean" paramName="descriptor"><row>
<entry>descriptor</entry>
<entry><XDtClass:classTagValue tagName="jmx:mbean"
paramName="descriptor"/></entry>
</row></XDtClass:ifHasClassTag>
</tbody>
</tgroup>
</table>
<section>
<title>Managed Constructors</title>
<XDtConstructor:forAllConstructors superclasses="false" sort="false">
<XDtConstructor:ifHasConstructorTag tagName="jmx:managed-constructor">
<formalpara>
<title>Managed Constructor (sig would be nice here)</title>
<para><XDtConstructor:constructorComment no-comment-signs="true"/>
<orderedlist>
<XDtParameter:forAllConstructorParams>
<listitem>
<para><XDtParameter:methodParamDescription/></para>
<para><XDtParameter:methodParamName/></para>
<para><XDtParameter:methodParamType/></para>
</listitem>
</XDtParameter:forAllConstructorParams>
</orderedlist>
</para>
</formalpara>
</XDtConstructor:ifHasConstructorTag>
</XDtConstructor:forAllConstructors>
</section>
<!--attributes-->
<section>
<title>Managed Attributes</title>
<table>
<!--title></title-->
<tgroup cols="3">
<colspec colname="attribute"/>
<colspec colname="type"/>
<colspec colname="access"/>
<colspec colname="description" align="center"/>
<thead>
<row>
<entry>Attribute</entry>
<entry>Type</entry>
<entry>Access</entry>
<entry align="center">Description</entry>
</row>
</thead>
<tbody>
<XDtProperty:forAllPropertiesWithTag superclasses="true"
tagName="jmx:managed-attribute">
<row>
<entry><XDtMethod:methodNameWithoutPrefix/></entry>
<entry><XDtProperty:propertyTypeWithTag
tagName="jmx:managed-attribute"/></entry>
<entry><XDtMethod:ifHasMethodTag tagName="jmx:managed-attribute"
paramName="access"><XDtMethod:methodTagValue tagName="jmx:managed-attribute"
paramName="access"/></XDtMethod:ifHasMethodTag><XDtMethod:ifDoesntHaveMethodTag
tagName="jmx:managed-attribute"
paramName="access">READ_WRITE</XDtMethod:ifDoesntHaveMethodTag></entry>
<entry><XDtMethod:methodComment no-comment-signs="true"/></entry>
</row>
</XDtProperty:forAllPropertiesWithTag></tbody>
</tgroup>
</table>
</section>
<!--operations -->
<section>
<title>Managed Operations</title>
<XDtMethod:forAllMethods superclasses="true" sort="false">
<XDtMethod:ifHasMethodTag tagName="jmx:managed-operation">
<formalpara>
<title><XDtMethod:methodName/></title>
<para><XDtMethod:methodComment no-comment-signs="true"/>
<orderedlist>
<XDtParameter:forAllMethodParams>
<listitem>
<para><XDtParameter:methodParamDescription/></para>
<para><XDtParameter:methodParamName/></para>
<para><XDtParameter:methodParamType/></para>
</listitem>
</XDtParameter:forAllMethodParams>
<listitem>
<para>return type: <XDtMethod:methodType/></para>
</listitem>
</orderedlist>
</para>
</formalpara>
</XDtMethod:ifHasMethodTag>
</XDtMethod:forAllMethods>
</section>
<!--notifications -->
<section>
<title>Notifications</title>
<table>
<!--title></title-->
<tgroup cols="3">
<colspec colname="name"/>
<colspec colname="type"/>
<colspec colname="description" align="center"/>
<thead>
<row>
<entry>Name</entry>
<entry>Type</entry>
<entry align="center">Description</entry>
</row>
</thead>
<tbody>
<XDtClass:forAllClassTags superclasses="false" tagName="jmx:notification">
<XDtClass:ifHasClassTag tagName="jmx:notification" paramName="description">
<row>
<entry><XDtClass:classTagValue tagName="jmx:notification"
paramName="name"/></entry>
<entry><XDtClass:classTagValue tagName="jmx:notification"
paramName="notificationType"/></entry>
<entry><XDtClass:classTagValue tagName="jmx:notification"
paramName="description"/></entry>
</row>
</XDtClass:ifHasClassTag>
</XDtClass:forAllClassTags>
</tbody>
</tgroup>
</table>
</section>
</section>
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
