[hibernate-issues] [Hibernate-JIRA] Commented: (BVAL-277) Align on style for author names in JavaDoc
[
https://hibernate.onjira.com/browse/BVAL-277?page=com.atlassian.jira.plug...
]
Hardy Ferentschik commented on BVAL-277:
----------------------------------------
another idea would be to have a way to include the java code directly into the
documentation and save the cut&paste completely. This would safe a lot of work. I know
Christian worked on such a tool, but I am not sure how far he got with his _AuthorDoclet_
- http://in.relation.to/Bloggers/IntroducingAuthorDoclet
Align on style for author names in JavaDoc
------------------------------------------
Key: BVAL-277
URL: https://hibernate.onjira.com/browse/BVAL-277
Project: Bean Validation
Issue Type: Improvement
Components: spec-general
Reporter: Gunnar Morling
We should align on a style for {{@author}} tags in the API. One idea would be to specify
e-mail addresses in the actual API types (e.g. {{@author Gunnar Morling
(gunnar(a)beanvalidation.org)}}) but to omit addresses from the spec listings for the sake
of brevity.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira