I vote mainly for the use of - Custom annotations - Put the information right into the JavaDoc is also useful but I think that maybe some indication on the name of the class might be a good idea too
On Sat, Nov 19, 2016 at 6:52 AM, Benedikt Ritter <brit...@apache.org> wrote: > Hi, > > after my presentation about Apache Commons, there where some comments about > [lang]. One person said, that it is hard to find out whether our classes > are threadsafe or not. He would like to see that better documented. > > I know that sebb has done some work in that direction, but as far as I know > the information about thread safety is currently only in Java comments. > > How can we improve our docs with regards to thread safety? I see several > ways: > - Custom annotations like @Immutable, @ThreadSafe, @NotThreadSafe > - Custom JavaDoc doclets > - Put the information right into the JavaDoc > > Anything else? > > Benedikt > -- Thiago Andrade MSc in Computer Science, UFPE – Brazil BSc in Computer Engineering, UPE – Brazil
