dlr 01/08/20 18:26:58
Modified: src/java/org/apache/velocity/texen/ant TexenTask.java
Log:
Cleaned up doc for populateInitialContext().
Revision Changes Path
1.26 +15 -16
jakarta-velocity/src/java/org/apache/velocity/texen/ant/TexenTask.java
Index: TexenTask.java
===================================================================
RCS file:
/home/cvs/jakarta-velocity/src/java/org/apache/velocity/texen/ant/TexenTask.java,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -u -r1.25 -r1.26
--- TexenTask.java 2001/05/11 03:55:32 1.25
+++ TexenTask.java 2001/08/21 01:26:58 1.26
@@ -84,7 +84,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
* @author <a href="[EMAIL PROTECTED]">Robert Burrell Donkin</a>
- * @version $Id: TexenTask.java,v 1.25 2001/05/11 03:55:32 geirm Exp $
+ * @version $Id: TexenTask.java,v 1.26 2001/08/21 01:26:58 dlr Exp $
*/
public class TexenTask extends Task
{
@@ -480,26 +480,25 @@
}
/**
- * <p>
- * Place useful objects into the initial context.
- * </p><p>
- * TexenTask places <code>Date().toString()</code> into the context as
<code>$now</code>.
- * Subclasses who want to vary the objects in the context should override this
method.
- * </p><p>
- * <code>$generator</code> is not put into the context in this method.
- * </p>
- * @param Context initial context
+ * <p>Place useful objects into the initial context.</p>
+ *
+ * <p>TexenTask places <code>Date().toString()</code> into the
+ * context as <code>$now</code>. Subclasses who want to vary the
+ * objects in the context should override this method.</p>
+ *
+ * <p><code>$generator</code> is not put into the context in this
+ * method.</p>
*
- * @throws Exception the execute method will catch and rethrow as a
<code>BuildException</code>
+ * @param context The context to populate, as retrieved from
+ * {@link #initControlContext()}.
+ *
+ * @throws Exception Error while populating context. The {@link
+ * #execute()} method will catch and rethrow as a
+ * <code>BuildException</code>.
*/
protected void populateInitialContext(Context context)
throws Exception
{
- /*
- * Place the current date in the context. Hmm,
- * this should probably be standard and moved
- * into the Texen task proper.
- */
context.put("now", new Date().toString());
}
}
