neow3j icon indicating copy to clipboard operation
neow3j copied to clipboard

Extend the documentation (continuous task)

Open csmuller opened this issue 5 years ago • 3 comments

External docs:

  • [ ] Mention the behavior of equals and == after implementation of #517.
  • [x] Add explanations of the convenience classes and methods that neow3j provides (e.g., all the SmartContract subclasses)
  • [ ] Extend the "Devpack" section.
  • [x] Add links to the online Javadocs of the core and contract modules to the dApp development sections.
  • [ ] Add a section on updating deployed smart contracts.
  • [ ] Create a table of supported Java language features similar to boa.
  • [ ] Explain why POJOs used in smart contracts should have public field variables and not getters and setters.

Javadocs:

  • [ ] Document all devpack annotations.
  • [ ] Document the event classes and interface in the devpack.

csmuller avatar Mar 26 '21 14:03 csmuller

@csmuller should we turn some of these tasks into specific issues?

Or can we review this issue to check what's done and what's still "missing"?

gsmachado avatar Feb 14 '22 17:02 gsmachado

I will work on this today (clean up the docs where necessary and extend where possible with little effort) and update this issue afterwards.

csmuller avatar Feb 15 '22 09:02 csmuller

I will work on this today (clean up the docs where necessary and extend where possible with little effort) and update this issue afterwards.

Great! 💪

gsmachado avatar Feb 15 '22 09:02 gsmachado