From 00a5124f0353291367984fffd294b616149e6337 Mon Sep 17 00:00:00 2001 From: contrapunctus Date: Sat, 13 Mar 2021 08:53:49 +0530 Subject: [PATCH] Fix more checkdoc complaints --- jabber.el | 9 +++++---- jabber.org | 9 +++++---- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/jabber.el b/jabber.el index 0c75078..9271d7b 100644 --- a/jabber.el +++ b/jabber.el @@ -966,7 +966,7 @@ With prefix argument, remove it." (require 'cl)) (defun jabber-escape-xml (str) - "escape strings for xml" + "Escape strings for XML." (if (stringp str) (let ((newstr (concat str))) ;; Form feeds might appear in code you copy, etc. Nevertheless, @@ -998,7 +998,8 @@ With prefix argument, remove it." str)) (defun jabber-sexp2xml (sexp) - "converts an SEXP in the format (tagname ((attribute-name . attribute-value)...) children...) and converts it to well-formatted xml." + "Return SEXP as well-formatted XML. +SEXP should be in the form (tagname ((attribute-name . attribute-value)...) children...)" (cond ((stringp sexp) (jabber-escape-xml sexp)) @@ -1467,7 +1468,7 @@ connection fails." ;; of the link ;; TODO: make this configurable (defun jabber-ssl-connect (fsm server network-server port) - "connect via OpenSSL or GnuTLS to a Jabber Server + "Connect via OpenSSL or GnuTLS to a Jabber Server. Send a message of the form (:connected CONNECTION) to FSM if connection succeeds. Send a message (:connection-failed ERRORS) if connection fails." @@ -1555,7 +1556,7 @@ connection fails." (fsm-send fsm (list :connection-failed (nreverse errors)))))) (defun jabber-starttls-initiate (fsm) - "Initiate a starttls connection" + "Initiate a starttls connection." (jabber-send-sexp fsm '(starttls ((xmlns . "urn:ietf:params:xml:ns:xmpp-tls"))))) diff --git a/jabber.org b/jabber.org index fd3f0ce..d120158 100644 --- a/jabber.org +++ b/jabber.org @@ -1306,7 +1306,7 @@ With prefix argument, remove it." **** jabber-escape-xml :function: #+BEGIN_SRC emacs-lisp (defun jabber-escape-xml (str) - "escape strings for xml" + "Escape strings for XML." (if (stringp str) (let ((newstr (concat str))) ;; Form feeds might appear in code you copy, etc. Nevertheless, @@ -1344,7 +1344,8 @@ With prefix argument, remove it." **** jabber-sexp2xml :function: #+BEGIN_SRC emacs-lisp (defun jabber-sexp2xml (sexp) - "converts an SEXP in the format (tagname ((attribute-name . attribute-value)...) children...) and converts it to well-formatted xml." + "Return SEXP as well-formatted XML. +SEXP should be in the form (tagname ((attribute-name . attribute-value)...) children...)" (cond ((stringp sexp) (jabber-escape-xml sexp)) @@ -1894,7 +1895,7 @@ connection fails." ;; of the link ;; TODO: make this configurable (defun jabber-ssl-connect (fsm server network-server port) - "connect via OpenSSL or GnuTLS to a Jabber Server + "Connect via OpenSSL or GnuTLS to a Jabber Server. Send a message of the form (:connected CONNECTION) to FSM if connection succeeds. Send a message (:connection-failed ERRORS) if connection fails." @@ -1991,7 +1992,7 @@ connection fails." **** jabber-starttls-initiate :function: #+BEGIN_SRC emacs-lisp (defun jabber-starttls-initiate (fsm) - "Initiate a starttls connection" + "Initiate a starttls connection." (jabber-send-sexp fsm '(starttls ((xmlns . "urn:ietf:params:xml:ns:xmpp-tls")))))