Commit f308c0f1 authored by Barry Warsaw's avatar Barry Warsaw

From reading the source, it turns out that the setkey() method can

take an optional string key, but if key is not given, the method does
nothing!  In the rewrite (see upcoming check-in), I left things this
way, but here I document that this is the case.
parent f3dd5aab
......@@ -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}
......
......@@ -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}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment