jon 01/08/12 17:53:19
Modified: src/util/java/org/apache/fulcrum/template TemplateEmail.java
Log:
cleaned up some javadoc
Revision Changes Path
1.2 +12 -3
jakarta-turbine-fulcrum/src/util/java/org/apache/fulcrum/template/TemplateEmail.java
Index: TemplateEmail.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-fulcrum/src/util/java/org/apache/fulcrum/template/TemplateEmail.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TemplateEmail.java 2001/08/10 19:57:28 1.1
+++ TemplateEmail.java 2001/08/13 00:53:19 1.2
@@ -69,9 +69,15 @@
* <p>Example Usage (This all needs to be on one line in your
* template):
*
+ * <p>Setup your imports:
+ *
+ * <p>import org.apache.fulcrum.template.TemplateEmail;
+ * <p>import org.apache.turbine.modules.ContextAdapter;
+ *
* <p>Setup your context:
*
* <p>context.put ("TemplateEmail", new TemplateEmail() );
+ * <p>context.put ("contextAdapter", new ContextAdapter(context) );
*
* <p>Then, in your template (Velocity Example):
*
@@ -79,7 +85,7 @@
* $TemplateEmail.setTo("Jon Stevens", "[EMAIL PROTECTED]")
* .setFrom("Mom", "[EMAIL PROTECTED]").setSubject("Eat dinner")
* .setTemplate("email/momEmail.vm")
- * .setContext($context)
+ * .setContext($contextAdapter)
* </pre>
*
* The email/momEmail.vm template will then be parsed with the
@@ -88,11 +94,14 @@
* <p>If you want to use this class from within your Java code all you
* have to do is something like this:
*
+ * <p>import org.apache.fulcrum.template.TemplateEmail;
+ * <p>import org.apache.turbine.modules.ContextAdapter;
+ *
* <pre>
* TemplateEmail ve = new TemplateEmail();
* ve.setTo("Jon Stevens", "[EMAIL PROTECTED]");
* ve.setFrom("Mom", "[EMAIL PROTECTED]").setSubject("Eat dinner");
- * ve.setContext(context);
+ * ve.setContext(new ContextAdapter(context));
* ve.setTemplate("email/momEmail.vm")
* ve.send();
* </pre>
@@ -114,7 +123,7 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Jon S. Stevens</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Greg Coladonato</a>
- * @version $Id: TemplateEmail.java,v 1.1 2001/08/10 19:57:28 jon Exp $
+ * @version $Id: TemplateEmail.java,v 1.2 2001/08/13 00:53:19 jon Exp $
*/
public class TemplateEmail
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
