[VELOCITY-574] VTL Comment Blocks description is not clear

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.6
• Component/s: Documentation
• Assignee: Unassigned
• Reporter: Spencer Davis
• Created: 12/Dec/07 00:03
• Updated: 04/Sep/08 00:18
• Resolved: 04/Sep/08 00:18

Description

The User Guide says:

There is a third type of comment, the VTL comment block, which may be used to store
such information as the document author and versioning information:
#**
This is a VTL comment block and
may be used to store such information
as the document author and versioning
information:
@author
@version 5
*#

The description only says that it can be used to store the information but not why you
would want to store the information or how it could be used. Also, the examples should
either show more of how it is used or there should be an explanation of how to use
@author and @version.