Merge pull request #41 from ConsenSys/docs/godoc

docs: prettify godoc
Consensys · Apr 13, 2021 · 186d567 · 186d567
2 parents bea9b40 + 7c6275f
commit 186d567
Show file tree

Hide file tree

Showing 88 changed files with 1,285 additions and 125 deletions.
diff --git a/accumulator/merkletree/readers.go b/accumulator/merkletree/readers.go
@@ -1,4 +1,21 @@
-// from https://gitlab.com/NebulousLabs/merkletree
+// Original Copyright (c) 2015 Nebulous
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
 
 package merkletree
 

diff --git a/accumulator/merkletree/tree.go b/accumulator/merkletree/tree.go
@@ -1,5 +1,25 @@
-// from https://gitlab.com/NebulousLabs/merkletree
-
+// Original Copyright (c) 2015 Nebulous
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+// Package merkletree provides Merkle tree and proof following RFC 6962.
+//
+// From https://gitlab.com/NebulousLabs/merkletree
 package merkletree
 
 import (

diff --git a/accumulator/merkletree/verify.go b/accumulator/merkletree/verify.go
@@ -1,4 +1,21 @@
-// from https://gitlab.com/NebulousLabs/merkletree
+// Original Copyright (c) 2015 Nebulous
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
 
 package merkletree
 

diff --git a/ecc/bls12-377/doc.go b/ecc/bls12-377/doc.go
diff --git a/ecc/bls12-377/fp/doc.go b/ecc/bls12-377/fp/doc.go
diff --git a/ecc/bls12-377/fp/element.go b/ecc/bls12-377/fp/element.go
diff --git a/ecc/bls12-377/fr/doc.go b/ecc/bls12-377/fr/doc.go
diff --git a/ecc/bls12-377/fr/element.go b/ecc/bls12-377/fr/element.go
diff --git a/ecc/bls12-377/fr/fft/doc.go b/ecc/bls12-377/fr/fft/doc.go
diff --git a/ecc/bls12-377/fr/mimc/doc.go b/ecc/bls12-377/fr/mimc/doc.go
diff --git a/ecc/bls12-377/fr/polynomial/doc.go b/ecc/bls12-377/fr/polynomial/doc.go
diff --git a/ecc/bls12-377/fr/polynomial/mockcommitment/doc.go b/ecc/bls12-377/fr/polynomial/mockcommitment/doc.go
diff --git a/ecc/bls12-377/marshal.go b/ecc/bls12-377/marshal.go
diff --git a/ecc/bls12-377/twistededwards/doc.go b/ecc/bls12-377/twistededwards/doc.go
diff --git a/ecc/bls12-377/twistededwards/eddsa/doc.go b/ecc/bls12-377/twistededwards/eddsa/doc.go
diff --git a/ecc/bls12-377/twistededwards/eddsa/eddsa_test.go b/ecc/bls12-377/twistededwards/eddsa/eddsa_test.go
diff --git a/ecc/bls12-381/doc.go b/ecc/bls12-381/doc.go