*.c: Reformat docstrings.

[catacomb-python] / pubkey.c

diff --git a/pubkey.c b/pubkey.c
index 5680429c1a410cd81ee5724078a9b8abcf5b99be..3fc42af069cdeaf38d796fbc3be5b27c71c90465 100644 (file)
--- a/pubkey.c
+++ b/pubkey.c
@@ -191,16 +191,16 @@ end:
 
 static PyMethodDef dsapub_pymethods[] = {
 #define METHNAME(name) dsameth_##name
-  METH (beginhash,             "D.beginhash() -> hash object")
-  METH (endhash,               "D.endhash(H) -> BYTES")
-  METH (verify,                "D.verify(MSG, (R, S)) -> true/false")
+  METH (beginhash,     "D.beginhash() -> hash object")
+  METH (endhash,       "D.endhash(H) -> BYTES")
+  METH (verify,        "D.verify(MSG, (R, S)) -> true/false")
 #undef METHNAME
   { 0 }
 };
 
 static PyMethodDef dsapriv_pymethods[] = {
 #define METHNAME(name) dsameth_##name
-  KWMETH(sign,                 "D.sign(MSG, [k = K]) -> R, S")
+  KWMETH(sign,         "D.sign(MSG, [k = K]) -> R, S")
 #undef METHNAME
   { 0 }
 };
@@ -247,7 +247,7 @@ static PyTypeObject dsapub_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"DSAPub(GROUP, P, [hash = sha], [rng = rand]): DSA public key.",
+  "DSAPub(GROUP, P, [hash = sha], [rng = rand]): DSA public key.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -295,7 +295,8 @@ static PyTypeObject dsapriv_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"DSAPriv(GROUP, U, [p = u G], [hash = sha], [rng = rand]): DSA private key.",
+  "DSAPriv(GROUP, U, [p = u G], [hash = sha], [rng = rand]): "
+                                                         "DSA private key.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -428,16 +429,16 @@ end:
 
 static PyMethodDef kcdsapub_pymethods[] = {
 #define METHNAME(name) kcdsameth_##name
-  METH (beginhash,             "D.beginhash() -> hash object")
-  METH (endhash,               "D.endhash(H) -> BYTES")
-  METH (verify,                "D.verify(MSG, (R, S)) -> true/false")
+  METH (beginhash,     "D.beginhash() -> hash object")
+  METH (endhash,       "D.endhash(H) -> BYTES")
+  METH (verify,        "D.verify(MSG, (R, S)) -> true/false")
 #undef METHNAME
   { 0 }
 };
 
 static PyMethodDef kcdsapriv_pymethods[] = {
 #define METHNAME(name) kcdsameth_##name
-  KWMETH(sign,                 "D.sign(MSG, [k = K]) -> R, S")
+  KWMETH(sign,         "D.sign(MSG, [k = K]) -> R, S")
 #undef METHNAME
   { 0 }
 };
@@ -467,7 +468,7 @@ static PyTypeObject kcdsapub_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KCDSAPub(GROUP, P, [hash = sha], [rng = rand]): KCDSA public key.",
+  "KCDSAPub(GROUP, P, [hash = sha], [rng = rand]): KCDSA public key.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -515,7 +516,8 @@ static PyTypeObject kcdsapriv_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"KCDSAPriv(GROUP, U, [p = u G], [hash = sha], [rng = rand]): KCDSA private key.",
+  "KCDSAPriv(GROUP, U, [p = u G], [hash = sha], [rng = rand]): "
+                                                       "KCDSA private key.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -758,35 +760,35 @@ end:
 
 static PyGetSetDef rsapub_pygetset[] = {
 #define GETSETNAME(op, name) rsa##op##_##name
-  GET  (n,                     "R.n -> N")
-  GET  (e,                     "R.e -> E")
+  GET  (n,             "R.n -> N")
+  GET  (e,             "R.e -> E")
 #undef GETSETNAME
   { 0 }
 };
 
 static PyMethodDef rsapub_pymethods[] = {
 #define METHNAME(name) rsameth_##name
-  METH (pubop,                 "R.pubop(X) -> X^E (mod N)")
+  METH (pubop,         "R.pubop(X) -> X^E (mod N)")
 #undef METHNAME
   { 0 }
 };
 
 static PyGetSetDef rsapriv_pygetset[] = {
 #define GETSETNAME(op, name) rsa##op##_##name
-  GET  (d,                     "R.d -> D")
-  GET  (p,                     "R.p -> P")
-  GET  (q,                     "R.q -> Q")
-  GET  (dp,                    "R.dp -> D mod (P - 1)")
-  GET  (dq,                    "R.dq -> D mod (Q - 1)")
-  GET  (q_inv,                 "R.q_inv -> Q^{-1} mod P")
-  GETSET(rng,                  "R.rng -> random number source for blinding")
+  GET  (d,             "R.d -> D")
+  GET  (p,             "R.p -> P")
+  GET  (q,             "R.q -> Q")
+  GET  (dp,            "R.dp -> D mod (P - 1)")
+  GET  (dq,            "R.dq -> D mod (Q - 1)")
+  GET  (q_inv,         "R.q_inv -> Q^{-1} mod P")
+  GETSET(rng,          "R.rng -> random number source for blinding")
 #undef GETSETNAME
   { 0 }
 };
 
 static PyMethodDef rsapriv_pymethods[] = {
 #define METHNAME(name) rsameth_##name
-  KWMETH(privop,               "R.privop(X, [rng = None]) -> X^D (mod N)")
+  KWMETH(privop,       "R.privop(X, [rng = None]) -> X^D (mod N)")
 #undef METHNAME
   { 0 }
 };
@@ -816,7 +818,7 @@ static PyTypeObject rsapub_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"RSAPub(N, E): RSA public key.",
+  "RSAPub(N, E): RSA public key.",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -864,8 +866,8 @@ static PyTypeObject rsapriv_pytype_skel = {
     Py_TPFLAGS_BASETYPE,
 
   /* @tp_doc@ */
-"RSAPriv(..., [rng = rand]): RSA private key.\n\
-  Keywords: n, e, d, p, q, dp, dq, q_inv; must provide enough",
+  "RSAPriv(..., [rng = rand]): RSA private key.\n"
+  "  Keywords: n, e, d, p, q, dp, dq, q_inv; must provide enough",
 
   0,                                   /* @tp_traverse@ */
   0,                                   /* @tp_clear@ */
@@ -1262,30 +1264,26 @@ EDDSAS(DEFEDDSA)
 
 static PyMethodDef methods[] = {
 #define METHNAME(name) meth_##name
-  KWMETH(_p1crypt_encode,              0)
-  KWMETH(_p1crypt_decode,              0)
-  KWMETH(_p1sig_encode,                        0)
-  KWMETH(_p1sig_decode,                        0)
-  KWMETH(_oaep_encode,                 0)
-  KWMETH(_oaep_decode,                 0)
-  KWMETH(_pss_encode,                  0)
-  KWMETH(_pss_decode,                  0)
-  KWMETH(_RSAPriv_generate,            "\
-generate(NBITS, [event = pgen_nullev], [rng = rand], [nsteps = 0]) -> R")
+  KWMETH(_p1crypt_encode, 0)
+  KWMETH(_p1crypt_decode, 0)
+  KWMETH(_p1sig_encode,        0)
+  KWMETH(_p1sig_decode,        0)
+  KWMETH(_oaep_encode, 0)
+  KWMETH(_oaep_decode, 0)
+  KWMETH(_pss_encode,  0)
+  KWMETH(_pss_decode,  0)
+  KWMETH(_RSAPriv_generate, "generate(NBITS, [event = pgen_nullev], "
+                                         "[rng = rand], [nsteps = 0]) -> R")
 #define DEFMETH(X, x)                                                  \
-  METH  (x,                            "\
-" #x "(KEY, PUBLIC) -> SHARED")
+  METH (x,             "" #x "(KEY, PUBLIC) -> SHARED")
   XDHS(DEFMETH)
 #undef DEFMETH
 #define DEFMETH(ED, ed, phdflt, sigver)                                        \
-  METH  (ed##_pubkey,                  "\
-" #ed "_pubkey(KEY) -> PUBLIC")                                                \
-  KWMETH(ed##_sign,                    "\
-" #ed "_sign(KEY, MSG, [pub = PUBLIC], "                               \
-        "[perso = STRING], [phflag = BOOL]) -> SIG")                   \
-  KWMETH(ed##_verify,                  "\
-" #ed "_verify(PUBLIC, MSG, SIG, "                                     \
-        "[perso = STRING], [phflag = BOOL]) -> BOOL")
+  METH (ed##_pubkey,   "" #ed "_pubkey(KEY) -> PUBLIC")                \
+  KWMETH(ed##_sign,    "" #ed "_sign(KEY, MSG, [pub = PUBLIC], "       \
+                          "[perso = STRING], [phflag = BOOL]) -> SIG") \
+  KWMETH(ed##_verify,  "" #ed "_verify(PUBLIC, MSG, SIG, "             \
+                         "[perso = STRING], [phflag = BOOL]) -> BOOL")
   EDDSAS(DEFMETH)
 #undef DEFMETH
 #undef METHNAME