summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/librotor.tex5
-rw-r--r--Doc/librotor.tex5
2 files changed, 6 insertions, 4 deletions
diff --git a/Doc/lib/librotor.tex b/Doc/lib/librotor.tex
index 6befb05..af2a283 100644
--- a/Doc/lib/librotor.tex
+++ b/Doc/lib/librotor.tex
@@ -35,8 +35,9 @@ if it is omitted, a default value of 6 will be used.
Rotor objects have the following methods:
\renewcommand{\indexsubitem}{(rotor method)}
-\begin{funcdesc}{setkey}{}
-Reset the rotor to its initial state.
+\begin{funcdesc}{setkey}{\optional{key}}
+Sets the rotor's key to \var{key}. If \var{key} is not given, this
+function does nothing\footnote{This is for backwards compatibility.}.
\end{funcdesc}
\begin{funcdesc}{encrypt}{plaintext}
diff --git a/Doc/librotor.tex b/Doc/librotor.tex
index 6befb05..af2a283 100644
--- a/Doc/librotor.tex
+++ b/Doc/librotor.tex
@@ -35,8 +35,9 @@ if it is omitted, a default value of 6 will be used.
Rotor objects have the following methods:
\renewcommand{\indexsubitem}{(rotor method)}
-\begin{funcdesc}{setkey}{}
-Reset the rotor to its initial state.
+\begin{funcdesc}{setkey}{\optional{key}}
+Sets the rotor's key to \var{key}. If \var{key} is not given, this
+function does nothing\footnote{This is for backwards compatibility.}.
\end{funcdesc}
\begin{funcdesc}{encrypt}{plaintext}