eclipse-collections
eclipse-collections copied to clipboard
eclipse
Improve JavaDocs in Sets class
Improve JavaDocs in Sets class (org.eclipse.collections.impl.factory.Sets). At present lack of documentation makes using this factory class more difficult.
Thanks for the feedback. Any suggestions as to what we can add and where (ReadMe or Reference Guide or Javadoc)? Any examples will be helpful and we can update accordingly. Feel free to raise a Pull Request if you can, if not then we can take your suggestions and update the docs. It’s always helpful to understand what will help the users from a users perspective. Thank you for helping us make the framework better!
@mkrivoshein , @jdimeo any suggestions what is needed for Sets. Happy to accept your contributions as well.
Will take a bit of effort. Won't be able to look into this until September
@nikhilnanivadekar can I join you guys to solve this issue. Ready to take a guidance from you on the subject matter.
As you can see it is not actively worked on. You are welcome to contribute. However, to set expectations I do not have bandwidth to provide guidance at the moment. Thanks for understanding!
On Wed, Jul 13, 2022 at 9:07 AM prasadasabe @.***> wrote:
@nikhilnanivadekar https://github.com/nikhilnanivadekar can I join you guys to solve this issue. Ready to take a guidance from you on the subject matter.
— Reply to this email directly, view it on GitHub https://github.com/eclipse/eclipse-collections/issues/782#issuecomment-1183410899, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACLY4XKX6THOUVYP7TA2623VT3SS7ANCNFSM4J67K4DQ . You are receiving this because you were mentioned.Message ID: @.***>
@prasadasabe I also don't have much bandwidth to devote to this... and I still owe this team a write up on the Javadoc work I did previously!
If you do take a stab at it, you can use this utility I wrote to copy Javadocs from a generated class back to the .stg template: https://github.com/eclipse/eclipse-collections/blob/master/eclipse-collections-code-generator/src/test/java/org/eclipse/collections/codegenerator/tools/JavadocUtil.java This allows you to write Javadocs much faster since IDEs help you with them and then programmatically copy the result back to the template so those comments apply to all other variants.
