planetarium / libplanet

Blockchain in C#/.NET for on-chain, decentralized gaming
https://docs.libplanet.io/
GNU Lesser General Public License v2.1
506 stars 142 forks source link

Document more specifically #914

Closed moreal closed 1 year ago

moreal commented 4 years ago

Now, the API document of Libplanet, doesn't have enough documents. The example, where I felt the needs of this issue, was Libplanet.Crypto.PrivateKey. The constructor of the class, actually check the sanity and can raise ArgumentException when got invalid byte array as the argument, from the getter, Libplanet.Crypto.PrivateKey.PublicKey used Org.BouncyCastle.Crypto.Parameters.ECDomainParameters. But there is no document to know what exceptions can be thrown and why they can occur. Then, it may confuse to write code and to debug, with Libplanet.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.