Commit 8704c16e authored by Max Rottenkolber's avatar Max Rottenkolber

Fixed an error in DECODE's docstring and re-rendered

documentation/cl-rfc2047.html .
parent 48035605
......@@ -105,8 +105,9 @@
(defun decode* (string &key (start 0) end (errorp t))
"Decode mixed STRING (possibly containing encoded as well as unencoded
words) from START to END, if ERRORP is non nil DECODE* will return the
string unmodified if an error occurs."
words) from START to END. If an error occurs during decoding and ERRORP
is NIL, DECODE* will return the string unmodified. ERRORP is bound to {T}
by default."
(handler-case (decode-word* (subseq string start end))
(error (error) (if errorp
(error error)
......
<!DOCTYPE html><HTML><HEAD><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"><TITLE>CL-RFC2047 API</TITLE><LINK REL="stylesheet" TYPE="text/css" HREF="/css/document.css" MEDIA="screen"></HEAD><BODY><HEADER><H1>CL-RFC2047 API</H1></HEADER><ASIDE><HEADER><H2>Package index</H2></HEADER><NAV><UL><LI><A HREF="#section-1">CL-RFC2047</A><UL><LI><A HREF="#section-1-1"><CODE>DECODE</CODE></A><UL><LI><A HREF="#section-1-1-1">Function</A></LI></UL></LI><LI><A HREF="#section-1-2"><CODE>DECODE*</CODE></A><UL><LI><A HREF="#section-1-2-1">Function</A></LI></UL></LI><LI><A HREF="#section-1-3"><CODE>ENCODE</CODE></A><UL><LI><A HREF="#section-1-3-1">Function</A></LI></UL></LI><LI><A HREF="#section-1-4"><CODE>SHOULD-ENCODE-P</CODE></A><UL><LI><A HREF="#section-1-4-1">Function</A></LI></UL></LI></UL></LI></UL></NAV></ASIDE><ARTICLE><SECTION><HEADER><A NAME="section-1"><H2>CL-RFC2047</H2></A></HEADER><P>Implmentation of <CODE>RFC2047.</CODE></P><SECTION><HEADER><A NAME="section-1-1"><H3><CODE>DECODE</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-1-1"><H4>Function</H4></A></HEADER><P>Decode encoded word in <CODE>STRING</CODE> from <CODE>START</CODE> to <CODE>END.</CODE></P><FIGURE><PRE>(STRING &amp;KEY START END)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION><SECTION><HEADER><A NAME="section-1-2"><H3><CODE>DECODE*</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-2-1"><H4>Function</H4></A></HEADER><P>Decode mixed <CODE>STRING</CODE> (possibly containing encoded as well as unencoded words) from <CODE>START</CODE> to <CODE>END</CODE>, if <CODE>ERRORP</CODE> is non nil <CODE>DECODE*</CODE> will return the string unmodified if an error occurs.</P><FIGURE><PRE>(STRING &amp;KEY START END ERRORP)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION><SECTION><HEADER><A NAME="section-1-3"><H3><CODE>ENCODE</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-3-1"><H4>Function</H4></A></HEADER><P>Return encoded <CODE>STRING</CODE> using <CODE>ENCODING</CODE> and <CODE>CHARSET.</CODE></P><FIGURE><PRE>(STRING &amp;KEY ENCODING CHARSET)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION><SECTION><HEADER><A NAME="section-1-4"><H3><CODE>SHOULD-ENCODE-P</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-4-1"><H4>Function</H4></A></HEADER><P>Predicate to test if <CODE>STRING</CODE> should be encoded.</P><FIGURE><PRE>(STRING)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION></SECTION></ARTICLE></BODY></HTML>
\ No newline at end of file
<!DOCTYPE html><HTML><HEAD><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"><TITLE>CL-RFC2047 API</TITLE><LINK REL="stylesheet" TYPE="text/css" HREF="/css/document.css" MEDIA="screen"></HEAD><BODY><HEADER><H1>CL-RFC2047 API</H1></HEADER><ASIDE><HEADER><H2>Package index</H2></HEADER><NAV><UL><LI><A HREF="#section-1">CL-RFC2047</A><UL><LI><A HREF="#section-1-1"><CODE>DECODE</CODE></A><UL><LI><A HREF="#section-1-1-1">Function</A></LI></UL></LI><LI><A HREF="#section-1-2"><CODE>DECODE*</CODE></A><UL><LI><A HREF="#section-1-2-1">Function</A></LI></UL></LI><LI><A HREF="#section-1-3"><CODE>ENCODE</CODE></A><UL><LI><A HREF="#section-1-3-1">Function</A></LI></UL></LI><LI><A HREF="#section-1-4"><CODE>SHOULD-ENCODE-P</CODE></A><UL><LI><A HREF="#section-1-4-1">Function</A></LI></UL></LI></UL></LI></UL></NAV></ASIDE><ARTICLE><SECTION><HEADER><A NAME="section-1"><H2>CL-RFC2047</H2></A></HEADER><P>Implmentation of <CODE>RFC2047.</CODE></P><SECTION><HEADER><A NAME="section-1-1"><H3><CODE>DECODE</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-1-1"><H4>Function</H4></A></HEADER><P>Decode encoded word in <CODE>STRING</CODE> from <CODE>START</CODE> to <CODE>END.</CODE></P><FIGURE><PRE>(STRING &amp;KEY START END)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION><SECTION><HEADER><A NAME="section-1-2"><H3><CODE>DECODE*</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-2-1"><H4>Function</H4></A></HEADER><P>Decode mixed <CODE>STRING</CODE> (possibly containing encoded as well as unencoded words) from <CODE>START</CODE> to <CODE>END.</CODE> If an error occurs during decoding and <CODE>ERRORP</CODE> is <CODE>NIL</CODE>, <CODE>DECODE*</CODE> will return the string unmodified. <CODE>ERRORP</CODE> is bound to <CODE>T</CODE> by default.</P><FIGURE><PRE>(STRING &amp;KEY START END ERRORP)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION><SECTION><HEADER><A NAME="section-1-3"><H3><CODE>ENCODE</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-3-1"><H4>Function</H4></A></HEADER><P>Return encoded <CODE>STRING</CODE> using <CODE>ENCODING</CODE> and <CODE>CHARSET.</CODE></P><FIGURE><PRE>(STRING &amp;KEY ENCODING CHARSET)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION><SECTION><HEADER><A NAME="section-1-4"><H3><CODE>SHOULD-ENCODE-P</CODE></H3></A></HEADER><SECTION><HEADER><A NAME="section-1-4-1"><H4>Function</H4></A></HEADER><P>Predicate to test if <CODE>STRING</CODE> should be encoded.</P><FIGURE><PRE>(STRING)</PRE><FIGCAPTION>Lambda list</FIGCAPTION></FIGURE></SECTION></SECTION></SECTION></ARTICLE></BODY></HTML>
\ No newline at end of file
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