Mailing-List: contact issues-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: issues@commons.apache.org
Message-ID: <34520933.546471267159467981.JavaMail.jira@brutus.apache.org>
Date: Fri, 26 Feb 2010 04:44:27 +0000 (UTC)
From: "Henri Yandell (JIRA)" <jira@apache.org>
To: issues@commons.apache.org
Subject: [jira] Commented: (LANG-370) Document thread safety of classes
In-Reply-To: <17739973.1193766470666.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


    [ https://issues.apache.org/jira/browse/LANG-370?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12838710#action_12838710 ] 

Henri Yandell commented on LANG-370:
------------------------------------

Let's agree first then on a format to declare threadsafe vs not threadsafe. Very easy to go through and identify it once we know how.

We know that JCIP anno's are out of the question until it's in the JDK.

We could duplicate that, but I think we also need to identify how we would tell the user. I think that would either be by a) A Maven report (which means writing a plugin), b) in the Javadoc or c) a HTML page generated from the source code through some other means.

I think in the Javadoc feels best. Having @ will annoy it, so we just need some other mechanism.

Any thoughts?

> Document thread safety of classes
> ---------------------------------
>
>                 Key: LANG-370
>                 URL: https://issues.apache.org/jira/browse/LANG-370
>             Project: Commons Lang
>          Issue Type: Wish
>          Components: General
>            Reporter: Sebb
>             Fix For: 3.0
>
>
> Few if any of the LANG classes state whether they are intended to be thread-safe or not.
> As a library, such documentation is essential IMO.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.