Velocity
  1. Velocity
  2. VELOCITY-574

VTL Comment Blocks description is not clear

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.6
    • Component/s: Documentation
    • Labels:
      None

      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.

        Activity

        Spencer Davis created issue -
        Spencer Davis made changes -
        Field Original Value New Value
        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 them.
        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.
        Hide
        Nathan Bubna added a comment -

        heh. third type... i guess it's true, but barely.

        Show
        Nathan Bubna added a comment - heh. third type... i guess it's true, but barely.
        Nathan Bubna made changes -
        Resolution Fixed [ 1 ]
        Fix Version/s 1.6 [ 12310290 ]
        Status Open [ 1 ] Resolved [ 5 ]
        Mark Thomas made changes -
        Workflow jira [ 12419094 ] Default workflow, editable Closed status [ 12551555 ]
        Mark Thomas made changes -
        Workflow Default workflow, editable Closed status [ 12551555 ] jira [ 12552440 ]
        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open Resolved Resolved
        267d 15m 1 Nathan Bubna 04/Sep/08 01:18

          People

          • Assignee:
            Unassigned
            Reporter:
            Spencer Davis
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development