[ 
https://issues.apache.org/jira/browse/VELOCITY-574?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Spencer Davis updated VELOCITY-574:
-----------------------------------

    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.

  was:
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 them.


> VTL Comment Blocks description is not clear
> -------------------------------------------
>
>                 Key: VELOCITY-574
>                 URL: https://issues.apache.org/jira/browse/VELOCITY-574
>             Project: Velocity
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Spencer Davis
>            Priority: Minor
>
> 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.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to