spullara / mustache.java

Implementation of mustache.js for Java

Home Page:http://www.javarants.com/the-ideal-web-application-templating-system-b301fa4a1f49

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation > Improve api documentation

ghilainm opened this issue · comments

Hi,

Seems like the API documentation is not very descriptive, would it be possible to improve the documentation?

For example, the translate method of the MustacheFactory, I cannot understand what it does. When I look at the code it seems it just returns the value provided as a parameter, what is it supposed to be used for?

Thanks for that :).

I agree and I don't remember what circumstances caused me to add it. What it does is let you change a tag name. By default it does nothing. For example, you might have a tag "class" but Java doesn't allow you to use that name because it is a reserved word. So you implement this method and rename class to clazz before variable resolution.