eclipse-collections
eclipse-collections copied to clipboard
Is documentation updated?
Hi,
going through the source code I found ConcurrentHashMap
. I have been using this library for months and I didn't know you have concurrent containers. I see you even have multiple versions of concurrent maps, but I see no javadoc for them, and it is not documented anywhere. This leads me to believe there are so many things this library has that I just don't know about. Is there planning to revamp the documentation ??? Specially this site: https://github.com/eclipse/eclipse-collections/blob/master/docs/guide.md#eclipse-collections-reference-guide
There is some javadoc:
https://www.eclipse.org/collections/javadoc/11.0.0/org/eclipse/collections/impl/map/mutable/ConcurrentHashMap.html
More documentation is always welcome.
Hi @PyAntony, we've migrated the reference guide to AsciiDoc. The reference guide above points to the new guide in the first link.
https://github.com/eclipse/eclipse-collections/blob/master/docs/0-RefGuide.adoc
Some contributors have been helping us improve the documentation, including JavaDoc. There are a lot of classes in Eclipse Collections so as @mohrezaei says "More documentation is always welcome."
I created the Lost and Found Kata to capture some hands-on examples of data structures that will not have a direct equivalent in the JDK. It links to some blogs I wrote on the topic a year and half ago. I did not cover ConcurrentHashMap
though.
https://github.com/eclipse/eclipse-collections-kata/tree/master/lost-and-found-kata
Haven't done this Kata yet. Will go over it. Thanks!