[nongnu] elpa/lorem-ipsum bdbe8a1fb1 07/30: fix comments and add docstrings

[ELPA Syncer]

branch: elpa/lorem-ipsum
commit bdbe8a1fb11210a077a6454e0b8eddb16d87d096
Author: Joe Schafer <joe@jschaf.com>
Commit: Joe Schafer <joe@jschaf.com>

    fix comments and add docstrings
---
 lorem-ipsum.el | 64 ++++++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 42 insertions(+), 22 deletions(-)

diff --git a/lorem-ipsum.el b/lorem-ipsum.el
index 45872525e1..323d33b5c4 100644
--- a/lorem-ipsum.el
+++ b/lorem-ipsum.el
@@ -1,32 +1,46 @@
 ;;; lorem-ipsum.el --- Insert dummy pseudo Latin text.
-;; Author & Maintainer: Jean-Philippe Theberge (jphil21@sourceforge.net)
-;; Special Thanks: The emacswiki users, the #emacs@freenode.net citizens
-;;                 and Marcus Tullius Cicero
-;;
-;; version :
-(defconst lorem-ipsum-version "0.2")
 
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;;; Copyright (c) 2003 Jean-Philippe Theberge
+;; Copyright (c) 2003 Jean-Philippe Theberge
 ;;
-;; This file is not (yet?) part of GNU Emacs.
+;; Author: Jean-Philippe Theberge (jphil21@sourceforge.net)
+;; Maintainer: Joe Schafer (joe@jschaf.com)
 ;;
-;; This file is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
+;; Special Thanks: The emacswiki users, the #emacs@freenode.net citizens
+;;                 and Marcus Tullius Cicero
+;; keywords: tools, language
+
+;; This file is not part of GNU Emacs.
+
+;; Contains code from GNU Emacs <https://www.gnu.org/software/emacs/>,
+;; released under the GNU General Public License version 3 or later.
+
+;; lorem-ipsum.el is free software; you can redistribute it and/or modify it
+;; under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
 ;; any later version.
-;;
-;; GNU Emacs is distributed in the hope that it will be useful,
+
+;; lorem-ipsum.el is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;; GNU General Public License for more details.
-;;
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
-;;
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; along with lorem-ipsum.el.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; History:
+
+;; Version 0.1 released by Jean-Philippe Theberge in 2003.  After
+;; attempting to contact Jean-Philippe, Joe Schafer took over as
+;; maintainer and published to Github.
+
+;;; Commentary:
+
+
+
+;;; Code:
+
+
+(defconst lorem-ipsum-version "0.2")
 
 (defconst Lorem-ipsum-text
   '(("Lorem ipsum dolor sit amet, consectetuer adipiscing elit."
@@ -112,6 +126,8 @@
                                  Lorem-ipsum-list-end "</ul>\n")))
 
 (defun Lorem-ipsum-insert-paragraphs (&optional num)
+  "Insert Lorem ipsum paragraphs into buffer.
+If NUM is non-nil, insert NUM paragraphs."
   (interactive "p")
   (if (not num)(setq num 1))
   (if (> num 0)
@@ -123,6 +139,8 @@
        (Lorem-ipsum-insert-paragraphs (- num 1)))))
 
 (defun Lorem-ipsum-insert-sentences (&optional num)
+  "Insert Lorem ipsum sentences into buffer.
+If NUM is non-nil, insert NUM sentences."
   (interactive "p")
   (if (not num)(setq num 1))
   (if (> num 0)
@@ -133,6 +151,8 @@
        (Lorem-ipsum-insert-sentences (- num 1)))))
 
 (defun Lorem-ipsum-insert-list (&optional num)
+  "Insert Lorem ipsum list items into buffer.
+If NUM is non-nil, insert NUM list items."
   (interactive "p")
   (if (not num)(setq num 1))
   (if (> num 0)