Update of /cvsroot/xdoclet/xdoclet/modules/hibernate/src/xdoclet/modules/hibernate
In directory
sc8-pr-cvs1:/tmp/cvs-serv16812/xdoclet/modules/hibernate/src/xdoclet/modules/hibernate
Modified Files:
JBossServiceSubTask.java
Log Message:
Updated the Ant documentation. This is the preferred (and most intuitive) way to
document tasks and subtasks.
Index: JBossServiceSubTask.java
===================================================================
RCS file:
/cvsroot/xdoclet/xdoclet/modules/hibernate/src/xdoclet/modules/hibernate/JBossServiceSubTask.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** JBossServiceSubTask.java 12 Dec 2002 18:27:56 -0000 1.3
--- JBossServiceSubTask.java 13 Dec 2002 16:43:29 -0000 1.4
***************
*** 13,35 ****
* Generate jboss mbean descriptor for hibernated classes
*
! * @author Konstantin Pribluda ([EMAIL PROTECTED])
! * @created December 11, 2002
! * @version $Revision$
! * @ant.element name="jbossservice" display-name="JBoss service configuration"
* parent="xdoclet.modules.hibernate.HibernateDocletTask"
- * @ant.attribute name="datasource" description="JNDI name of data source to use
in session factory" required="Yes"
- * @ant.attribute name="username" description="Use this user name to login to
database" required="No"
- * @ant.attribute name="password" description="Use this password to login to
database" required="No"
- * @ant.attribute name="dialect" description="SQL dialect of database."
required="Yes. Shall be fully qualified class
- * name of <tt>Dialect</tt> subclass"
- * @ant.attribute name="jndiname" description="JNDI name to bind to the
<tt>SessionFactory</tt> " required="Yes."
- * @ant.attribute name="useouterjoin" description="Whether to use outer join"
required="no. default is false"
- * @ant.attribute name="showsql" description="Log sql statemets" required="no.
default is false"
- * @ant.attribute name="usertransactionname" description="The JNDI name of the JTA
UserTransaction object (used only
- * be <tt>JTATransaction</tt> )" required="no."
- * @ant.attribute name="transactionstrategy" description="The fully qualified
class name of the Hibernate <tt>
- * TransactionFactory</tt> implementation" required="no."
- * @ant.attribute name="transactionmanagerlookup" description="strategy for
obtaining the JTA <tt>TransactionManager
- * </tt>" required="no."
*/
public class JBossServiceSubTask
--- 13,21 ----
* Generate jboss mbean descriptor for hibernated classes
*
! * @author Konstantin Pribluda ([EMAIL PROTECTED])
! * @created December 11, 2002
! * @version $Revision$
! * @ant.element name="jbossservice" display-name="JBoss service configuration"
* parent="xdoclet.modules.hibernate.HibernateDocletTask"
*/
public class JBossServiceSubTask
***************
*** 131,134 ****
--- 117,126 ----
}
+ /**
+ * Strategy for obtaining the JTA <tt>TransactionManager</tt>
+ *
+ * @param transactionManagerStrategy
+ * @ant.required
+ */
public void setTransactionManagerStrategy(String transactionManagerStrategy)
{
***************
*** 136,139 ****
--- 128,137 ----
}
+ /**
+ * The JNDI name of the JTA UserTransaction object
+ *
+ * @param userTransactionName
+ * @ant.not-required
+ */
public void setUserTransactionName(String userTransactionName)
{
***************
*** 141,144 ****
--- 139,148 ----
}
+ /**
+ * The fully qualified class name of the Hibernate <tt>TransactionFactory</tt>
+implementation.
+ *
+ * @param transactionStrategy
+ * @ant.not-required
+ */
public void setTransactionStrategy(String transactionStrategy)
{
***************
*** 146,149 ****
--- 150,159 ----
}
+ /**
+ * Use this user name to login to the database
+ *
+ * @param userName
+ * @ant.not-required
+ */
public void setUserName(String userName)
{
***************
*** 151,154 ****
--- 161,170 ----
}
+ /**
+ * Use this password to login to the database
+ *
+ * @param password
+ * @ant.not-required
+ */
public void setPassword(String password)
{
***************
*** 156,159 ****
--- 172,181 ----
}
+ /**
+ * Whether to use outer join
+ *
+ * @param useOuterJoin
+ * @ant.not-required No. Defaults to false.
+ */
public void setUseOuterJoin(boolean useOuterJoin)
{
***************
*** 161,164 ****
--- 183,192 ----
}
+ /**
+ * Log sql statemets.
+ *
+ * @param showSql
+ * @ant.not-required No. Defaults to false.
+ */
public void setShowSql(boolean showSql)
{
***************
*** 166,169 ****
--- 194,201 ----
}
+ /**
+ * @param serviceName
+ * @ant.required
+ */
public void setServiceName(String serviceName)
{
***************
*** 171,174 ****
--- 203,212 ----
}
+ /**
+ * JNDI name to bind to the <tt>SessionFactory</tt>
+ *
+ * @param jndiName
+ * @ant.required
+ */
public void setJndiName(String jndiName)
{
***************
*** 176,179 ****
--- 214,223 ----
}
+ /**
+ * JNDI name of data source to use in the session factory.
+ *
+ * @param dataSource
+ * @ant.required
+ */
public void setDataSource(String dataSource)
{
***************
*** 181,184 ****
--- 225,235 ----
}
+ /**
+ * SQL <a
+href="http://hibernate.bluemars.net/hib_docs/api/cirrus/hibernate/sql/Dialect.html";>dialect</a>
+ of the
+ * database.
+ *
+ * @param dialect
+ * @ant.required Yes. Use fully-qualified class name.
+ */
public void setDialect(String dialect)
{
-------------------------------------------------------
This sf.net email is sponsored by:
With Great Power, Comes Great Responsibility
Learn to use your power at OSDN's High Performance Computing Channel
http://hpc.devchannel.org/
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
