commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bruno P. Kinoshita (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (VALIDATOR-366) Document concurrency properties of validator implementations
Date Sun, 24 May 2015 10:07:17 GMT

    [ https://issues.apache.org/jira/browse/VALIDATOR-366?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14557696#comment-14557696
] 

Bruno P. Kinoshita commented on VALIDATOR-366:
----------------------------------------------

Should we

a) document in the class JavaDoc with something like in [lang]'s BooleanUtils:

{noformat}
<p>#ThreadSafe#</p>
{noformat}

b) document in the `package-info.java` too whether all the classes are mutable, all the classes
are immutable, or if some classes are immutable? (I think I've seen that in some project?)

Or is there any other approach that would work better for this issue? 

Cheers
Bruno

> Document concurrency properties of validator implementations
> ------------------------------------------------------------
>
>                 Key: VALIDATOR-366
>                 URL: https://issues.apache.org/jira/browse/VALIDATOR-366
>             Project: Commons Validator
>          Issue Type: Improvement
>          Components: Routines
>            Reporter: Benedikt Ritter
>
> It would be useful if we add some documentation about thread-safety/immutability to the
class JavaDoc of validator implementations.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message