[#57] Upgradeable contract doc
Description
Just looking at an upgradeable contract it is hard to understand how it works, especially if you care not only about the interface but also about implementation.
Now the upgradeable contract has doc which more or less descriptive.
Apart from adding documentation for all upgradeable contract entrypoints, storage type documentation was added.
As a side change, documentEntryPoint
was added. This function provides an ability
to document single entrypoint without unwrapping its parameter type (entryCase
unconditionally performs unwrapping)
Related issue(s)
Resolves part of #57 (closed)
✅ Checklist for your Merge Request
Related changes (conditional)
-
Tests (see short guidelines)
-
If I added new functionality, I added tests covering it. -
If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
-
-
Documentation
Stylistic guide (mandatory)
-
My commits comply with the following policy. -
My code complies with the style guide.
Edited by Roman Melnikov