Use Rust docstring comments

Addresses part of #785
mit-plv · May 11, 2020 · 1776b15 · 1776b15
1 parent 065f5a2
commit 1776b15
Show file tree

Hide file tree

Showing 45 changed files with 2,503 additions and 2,912 deletions.
diff --git a/fiat-bedrock2/src/curve25519_32.c b/fiat-bedrock2/src/curve25519_32.c
@@ -4,7 +4,7 @@
 /* n = 10 (from "10") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1] */
 

diff --git a/fiat-bedrock2/src/curve25519_64.c b/fiat-bedrock2/src/curve25519_64.c
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */
 

diff --git a/fiat-bedrock2/src/p448_solinas_64.c b/fiat-bedrock2/src/p448_solinas_64.c
@@ -4,7 +4,7 @@
 /* n = 8 (from "8") */
 /* s-c = 2^448 - [(2^224, 1), (1, 1)] (from "2^448 - 2^224 - 1") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [3, 7, 4, 0, 5, 1, 6, 2, 7, 3, 4, 0] */
 

diff --git a/fiat-bedrock2/src/p521_64.c b/fiat-bedrock2/src/p521_64.c
@@ -4,7 +4,7 @@
 /* n = 9 (from "9") */
 /* s-c = 2^521 - [(1, 1)] (from "2^521 - 1") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 0, 1] */
 

diff --git a/fiat-bedrock2/src/poly1305_32.c b/fiat-bedrock2/src/poly1305_32.c
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */
 

diff --git a/fiat-bedrock2/src/poly1305_64.c b/fiat-bedrock2/src/poly1305_64.c
@@ -4,7 +4,7 @@
 /* n = 3 (from "3") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 0, 1] */
 

diff --git a/fiat-c/src/curve25519_32.c b/fiat-c/src/curve25519_32.c
@@ -4,7 +4,7 @@
 /* n = 10 (from "10") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1] */
 

diff --git a/fiat-c/src/curve25519_64.c b/fiat-c/src/curve25519_64.c
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */
 

diff --git a/fiat-c/src/p448_solinas_64.c b/fiat-c/src/p448_solinas_64.c
@@ -4,7 +4,7 @@
 /* n = 8 (from "8") */
 /* s-c = 2^448 - [(2^224, 1), (1, 1)] (from "2^448 - 2^224 - 1") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [3, 7, 4, 0, 5, 1, 6, 2, 7, 3, 4, 0] */
 

diff --git a/fiat-c/src/p521_64.c b/fiat-c/src/p521_64.c
@@ -4,7 +4,7 @@
 /* n = 9 (from "9") */
 /* s-c = 2^521 - [(1, 1)] (from "2^521 - 1") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 0, 1] */
 

diff --git a/fiat-c/src/poly1305_32.c b/fiat-c/src/poly1305_32.c
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */
 

diff --git a/fiat-c/src/poly1305_64.c b/fiat-c/src/poly1305_64.c
@@ -4,7 +4,7 @@
 /* n = 3 (from "3") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 0, 1] */
 

diff --git a/fiat-go/src/curve25519_32.go b/fiat-go/src/curve25519_32.go
@@ -4,7 +4,7 @@
 /* n = 10 (from "10") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1] */
 

diff --git a/fiat-go/src/curve25519_64.go b/fiat-go/src/curve25519_64.go
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */
 

diff --git a/fiat-go/src/p448_solinas_64.go b/fiat-go/src/p448_solinas_64.go
@@ -4,7 +4,7 @@
 /* n = 8 (from "8") */
 /* s-c = 2^448 - [(2^224, 1), (1, 1)] (from "2^448 - 2^224 - 1") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [3, 7, 4, 0, 5, 1, 6, 2, 7, 3, 4, 0] */
 

diff --git a/fiat-go/src/p521_64.go b/fiat-go/src/p521_64.go
@@ -4,7 +4,7 @@
 /* n = 9 (from "9") */
 /* s-c = 2^521 - [(1, 1)] (from "2^521 - 1") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 0, 1] */
 

diff --git a/fiat-go/src/poly1305_32.go b/fiat-go/src/poly1305_32.go
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */
 

diff --git a/fiat-go/src/poly1305_64.go b/fiat-go/src/poly1305_64.go
@@ -4,7 +4,7 @@
 /* n = 3 (from "3") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 64 (from "64") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 0, 1] */
 

diff --git a/fiat-java/src/FiatCurve25519.java b/fiat-java/src/FiatCurve25519.java
@@ -4,7 +4,7 @@
 /* n = 10 (from "10") */
 /* s-c = 2^255 - [(1, 19)] (from "2^255 - 19") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1] */
 

diff --git a/fiat-java/src/FiatPoly1305.java b/fiat-java/src/FiatPoly1305.java
@@ -4,7 +4,7 @@
 /* n = 5 (from "5") */
 /* s-c = 2^130 - [(1, 5)] (from "2^130 - 5") */
 /* machine_wordsize = 32 (from "32") */
-
+/*  */
 /* Computed values: */
 /* carry_chain = [0, 1, 2, 3, 4, 0, 1] */