4:48 p.m.
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
4:48 p.m.
New subject: [Hibernate-JIRA] Updated: (BVAL-277) Align on style for author names in JavaDoc
[
https://hibernate.onjira.com/browse/BVAL-277?page=com.atlassian.jira.plug...
]
Gunnar Morling updated BVAL-277:
--------------------------------
Description: 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. (was: 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. )
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
4:54 p.m.
New subject: [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
10:56 a.m.
New subject: [Hibernate-JIRA] (BVAL-277) Align on style for author names in JavaDoc
4097
days inactive
4442
days old
hibernate-issues@lists.jboss.org
4 comments
3 participants
participants (3)
-
Emmanuel Bernard (JIRA) -
Gunnar Morling (JIRA)
-
Hardy Ferentschik (JIRA)