Add documentation to public functions and types

This commit is contained in:
kaiyou
2020-05-07 14:33:29 +02:00
committed by Leo Antunes
parent 3a882eb112
commit 5d1acc1fab
4 changed files with 44 additions and 6 deletions

View File

@ -38,6 +38,7 @@ func (n *Node) Encode(limit int) ([]byte, error) {
return buf.Bytes(), nil
}
// Decode the node Meta field into its metadata
func (n *Node) Decode() error {
// TODO: we blindly trust the info we get from the peers; We should be more defensive to limit the damage a leaked
// PSK can cause.