You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by "Byron Foster (JIRA)" <de...@velocity.apache.org> on 2009/02/15 15:29:04 UTC
[jira] Created: (VELOCITY-695) Add comments for directive
parameters
Add comments for directive parameters
-------------------------------------
Key: VELOCITY-695
URL: https://issues.apache.org/jira/browse/VELOCITY-695
Project: Velocity
Issue Type: New Feature
Components: Engine
Affects Versions: 2.0
Reporter: Byron Foster
Add comments for Macro definitions so this type of thing is possible:
#macro(foo ## This is a comment about foo
$bar ## This is the bar parameter
## It has man uses
$bar2 ## Another param
)
#end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org
[jira] Closed: (VELOCITY-695) Add comments for directive parameters
Posted by "Byron Foster (JIRA)" <de...@velocity.apache.org>.
[ https://issues.apache.org/jira/browse/VELOCITY-695?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Byron Foster closed VELOCITY-695.
---------------------------------
Resolution: Fixed
Better huu? :) Ok, looks like this is going in, so I'll close it. Change log update for this coming...
> Add comments for directive parameters
> -------------------------------------
>
> Key: VELOCITY-695
> URL: https://issues.apache.org/jira/browse/VELOCITY-695
> Project: Velocity
> Issue Type: New Feature
> Components: Engine
> Affects Versions: 2.0
> Reporter: Byron Foster
>
> Add comments for Macro definitions so this type of thing is possible:
> #macro(foo ## This is a comment about foo
> $bar ## This is the bar parameter
> ## It has man uses
> $bar2 ## Another param
> )
> #end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org
[jira] Commented: (VELOCITY-695) Add comments for directive
parameters
Posted by "Jarkko Viinamäki (JIRA)" <de...@velocity.apache.org>.
[ https://issues.apache.org/jira/browse/VELOCITY-695?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12673739#action_12673739 ]
Jarkko Viinamäki commented on VELOCITY-695:
-------------------------------------------
Urgh. -1 for this one. I don't see why anyone would want to write templates like that.
Just put the parameter description before the macro definition in comments JavaDoc style.
> Add comments for directive parameters
> -------------------------------------
>
> Key: VELOCITY-695
> URL: https://issues.apache.org/jira/browse/VELOCITY-695
> Project: Velocity
> Issue Type: New Feature
> Components: Engine
> Affects Versions: 2.0
> Reporter: Byron Foster
>
> Add comments for Macro definitions so this type of thing is possible:
> #macro(foo ## This is a comment about foo
> $bar ## This is the bar parameter
> ## It has man uses
> $bar2 ## Another param
> )
> #end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org
[jira] Commented: (VELOCITY-695) Add comments for directive
parameters
Posted by "Nathan Bubna (JIRA)" <de...@velocity.apache.org>.
[ https://issues.apache.org/jira/browse/VELOCITY-695?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12681385#action_12681385 ]
Nathan Bubna commented on VELOCITY-695:
---------------------------------------
I think that so long as someone else does/did the work, i'm fine with this. Other languages allow it, and i think it reasonable for a user to expect this to work. Of course, like Jarkko, i wouldn't ever use it. Javadoc style is better.
> Add comments for directive parameters
> -------------------------------------
>
> Key: VELOCITY-695
> URL: https://issues.apache.org/jira/browse/VELOCITY-695
> Project: Velocity
> Issue Type: New Feature
> Components: Engine
> Affects Versions: 2.0
> Reporter: Byron Foster
>
> Add comments for Macro definitions so this type of thing is possible:
> #macro(foo ## This is a comment about foo
> $bar ## This is the bar parameter
> ## It has man uses
> $bar2 ## Another param
> )
> #end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org
[jira] Commented: (VELOCITY-695) Add comments for directive
parameters
Posted by "Byron Foster (JIRA)" <de...@velocity.apache.org>.
[ https://issues.apache.org/jira/browse/VELOCITY-695?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12674072#action_12674072 ]
Byron Foster commented on VELOCITY-695:
---------------------------------------
You seem to be saying that you don't like the aesthetics of documenting this way so you want to force everyone else not to do it also?
> Add comments for directive parameters
> -------------------------------------
>
> Key: VELOCITY-695
> URL: https://issues.apache.org/jira/browse/VELOCITY-695
> Project: Velocity
> Issue Type: New Feature
> Components: Engine
> Affects Versions: 2.0
> Reporter: Byron Foster
>
> Add comments for Macro definitions so this type of thing is possible:
> #macro(foo ## This is a comment about foo
> $bar ## This is the bar parameter
> ## It has man uses
> $bar2 ## Another param
> )
> #end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org
[jira] Commented: (VELOCITY-695) Add comments for directive
parameters
Posted by "Jarkko Viinamäki (JIRA)" <de...@velocity.apache.org>.
[ https://issues.apache.org/jira/browse/VELOCITY-695?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12674615#action_12674615 ]
Jarkko Viinamäki commented on VELOCITY-695:
-------------------------------------------
I don't like this change because the value of this "feature" vs. the implementation effort, documentation effort, potential new bugs, ugliness of that approach in general etc. are not in balance. :)
> Add comments for directive parameters
> -------------------------------------
>
> Key: VELOCITY-695
> URL: https://issues.apache.org/jira/browse/VELOCITY-695
> Project: Velocity
> Issue Type: New Feature
> Components: Engine
> Affects Versions: 2.0
> Reporter: Byron Foster
>
> Add comments for Macro definitions so this type of thing is possible:
> #macro(foo ## This is a comment about foo
> $bar ## This is the bar parameter
> ## It has man uses
> $bar2 ## Another param
> )
> #end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org
[jira] Commented: (VELOCITY-695) Add comments for directive
parameters
Posted by "Byron Foster (JIRA)" <de...@velocity.apache.org>.
[ https://issues.apache.org/jira/browse/VELOCITY-695?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12675204#action_12675204 ]
Byron Foster commented on VELOCITY-695:
---------------------------------------
Fair enough, does the balance change any given that the implementation effort is done. And now you only have bugy & ugly :) ?
> Add comments for directive parameters
> -------------------------------------
>
> Key: VELOCITY-695
> URL: https://issues.apache.org/jira/browse/VELOCITY-695
> Project: Velocity
> Issue Type: New Feature
> Components: Engine
> Affects Versions: 2.0
> Reporter: Byron Foster
>
> Add comments for Macro definitions so this type of thing is possible:
> #macro(foo ## This is a comment about foo
> $bar ## This is the bar parameter
> ## It has man uses
> $bar2 ## Another param
> )
> #end
--
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: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org