[Amdatu-developers] [JIRA] (AMDATU-648) Provide proper velocity templates documentation

Thu, 10 May 2012 09:18:23 -0700

The example code snippet does not clarify what type of object the 'm_context' is (and it is confusing since the same snippet also contains a 'context' which is something completely different). It is definitely not the BundleContext. The example should represent the 'preferred' way and work out of the box when copied to your own service. For example, use BundleContext.getServiceReferences and BundleContext.getService to retrieve the template engine.
Same for INPUT_FILE and OUTPUT_FILE, I would like to see a little context for these variables. For example, something like this;
File inputFile = new File(...); // the input file
File outputFile = new File(...); // the output file

I think these comments are details and preferences. IMHO the example must illustrate basic usage of the TemplateEngine api and it does. The finer details on the api are in javadoc and service lookups/velocity are documented elsewhere.

Closing this issue. Feel free to make minor improvements cause it is a wiki. A meta discussion on how documentation examples should be laid out should take place on the mailing lists.
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators.
For more information on JIRA, see: http://www.atlassian.com/software/jira 
_______________________________________________
Amdatu-developers mailing list
[email protected]
http://lists.amdatu.org/mailman/listinfo/amdatu-developers

Reply via email to