[elpa] externals/realgud-trepan-ni 5143caf 16/25: Checkdoc linting

[Rocky Bernstein]

branch: externals/realgud-trepan-ni
commit 5143cafec403ca052bdfe421bf39a45c4fe73b93
Author: rocky <address@hidden>
Commit: rocky <address@hidden>

    Checkdoc linting
---
 realgud-trepan-ni.el |  4 ++--
 trepan-ni/core.el    | 20 ++++++++++++--------
 trepan-ni/init.el    | 10 +++++-----
 trepan-ni/main.el    | 11 +++++------
 4 files changed, 24 insertions(+), 21 deletions(-)

diff --git a/realgud-trepan-ni.el b/realgud-trepan-ni.el
index f19088f..f554d58 100644
--- a/realgud-trepan-ni.el
+++ b/realgud-trepan-ni.el
@@ -1,4 +1,4 @@
-;;; realgud-trepan-ni.el --- realgud front-end to newer "node inspect"
+;;; realgud-trepan-ni.el --- adds realgud front-end debugger support for 
trepan-ni
 
 ;; Author: Rocky Bernstein
 ;; Version: 1.0.0
@@ -27,7 +27,7 @@
 ;;; Commentary:
 
 ;; realgud support for the "node inspect" with V8 inspector support.
-;; See https://nodejs.org/api/debugger.html
+;; See https://nodejs.org/api/debugger.html and 
https://www.npmjs.com/package/trepan-ni
 ;;
 ;;; Code:
 
diff --git a/trepan-ni/core.el b/trepan-ni/core.el
index 725e37e..85a71ac 100644
--- a/trepan-ni/core.el
+++ b/trepan-ni/core.el
@@ -1,4 +1,4 @@
-;;; Copyright (C) 2015-2018 Rocky Bernstein <address@hidden>
+;;; Copyright (C) 2015-2019 Rocky Bernstein <address@hidden>
 ;; This program 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 of the License, or
@@ -31,7 +31,7 @@
 ;; FIXME: I think the following could be generalized and moved to
 ;; realgud-... probably via a macro.
 (defvar realgud:trepan-ni-minibuffer-history nil
-  "minibuffer history list for the command `trepan-ni'.")
+  "Minibuffer history list for the command `trepan-ni'.")
 
 (easy-mmode-defmap realgud:trepan-ni-minibuffer-local-map
   '(("\C-i" . comint-dynamic-complete-filename))
@@ -51,10 +51,13 @@
 (defun trepan-ni-parse-cmd-args (orig-args)
   "Parse command line ORIG-ARGS for the name of script to debug.
 
-ORIG-ARGS should contain a tokenized list of the command line to run.
+ORIG-ARGS should contain a tokenized list of the command line to
+run.
 
 We return the a list containing
-* the name of the debugger given (e.g. trepan-ni) and its arguments - a list 
of strings
+
+* the name of the debugger given (e.g. trepan-ni) and its arguments:
+  a list of strings
 * the script name and its arguments - list of strings
 
 For example for the following input:
@@ -62,10 +65,10 @@ For example for the following input:
    '(node --interactive --debugger-port 5858 trepan-ni ./gcd.js a b))
 
 we might return:
-   ((\"node\" \"--interactive\" \"--debugger-port\" \"5858\") nil 
(\"/tmp/gcd.js\" \"a\" \"b\"))
+   ((\"node\" \"--interactive\" \"--debugger-port\" \"5858\")
+   nil (\"/tmp/gcd.js\" \"a\" \"b\"))
 
-Note that path elements have been expanded via `expand-file-name'.
-"
+Note that path elements have been expanded via `expand-file-name'."
 
   ;; Parse the following kind of pattern:
   ;;  node trepan-ni-options script-name script-options
@@ -128,7 +131,8 @@ Note that path elements have been expanded via 
`expand-file-name'.
 (defvar realgud:trepan-ni-command-name)
 
 (defun realgud:trepan-ni-suggest-invocation (debugger-name)
-  "Suggest a trepan-ni command invocation via `realgud-suggest-invocaton'"
+  "Suggest a trepan-ni command invocation via `realgud-suggest-invocaton'.
+Argument DEBUGGER-NAME name of debugger."
   (realgud-suggest-invocation realgud:trepan-ni-command-name
                              realgud:trepan-ni-minibuffer-history
                              "js" "\\.js$"))
diff --git a/trepan-ni/init.el b/trepan-ni/init.el
index a6e3f70..708afce 100644
--- a/trepan-ni/init.el
+++ b/trepan-ni/init.el
@@ -1,4 +1,4 @@
-;; Copyright (C) 2015-2016, 2018 Rocky Bernstein <address@hidden>
+;; Copyright (C) 2015-2016, 2019 Rocky Bernstein <address@hidden>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -13,7 +13,7 @@
 ;; You should have received a copy of the GNU General Public License
 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-;;; "node inspect" debugger
+;;; "trepan-ni" debugger
 
 (eval-when-compile (require 'cl-lib))   ;For setf.
 
@@ -117,7 +117,7 @@ realgud-loc-pat struct")
        :line-group 3
        :char-offset-group 4))
 
-(defconst realgud:trepan-ni-debugger-name "trepan-ni" "Name of debugger")
+(defconst realgud:trepan-ni-debugger-name "trepan-ni" "Name of debugger.")
 
 ;; Regular expression that for a termination message.
 (setf (gethash "termination" realgud:trepan-ni-pat-hash)
@@ -155,8 +155,8 @@ realgud-loc-pat struct")
       "realgud:trepan-ni")
 
 (defvar realgud:trepan-ni-command-hash (make-hash-table :test 'equal)
-  "Hash key is command name like 'finish' and the value is
-  the trepan-ni command to use, like 'out'")
+  "Hash key is command name like 'finish' and the value is the
+trepan-ni command to use, like 'out'.")
 
 (setf (gethash realgud:trepan-ni-debugger-name
               realgud-command-hash)
diff --git a/trepan-ni/main.el b/trepan-ni/main.el
index fc7230d..c48b9fc 100644
--- a/trepan-ni/main.el
+++ b/trepan-ni/main.el
@@ -1,4 +1,4 @@
-;; Copyright (C) 2016, 2018 Rocky Bernstein
+;; Copyright (C) 2016, 2018-2019 Rocky Bernstein
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -53,18 +53,17 @@ This should be an executable on your path, or an absolute 
file name."
 String OPT-CMD-LINE specifies how to run trepan-ni.
 
 OPT-CMD-LINE is treated like a shell string; arguments are
-tokenized by `split-string-and-unquote'. The tokenized string is
+tokenized by `split-string-and-unquote'.  The tokenized string is
 parsed by `trepan-ni-parse-cmd-args' and path elements found by that
 are expanded using `realgud:expand-file-name-if-exists'.
 
 Normally, command buffers are reused when the same debugger is
-reinvoked inside a command buffer with a similar command. If we
+reinvoked inside a command buffer with a similar command.  If we
 discover that the buffer has prior command-buffer information and
 NO-RESET is nil, then that information which may point into other
 buffers and source buffers which may contain marks and fringe or
-marginal icons is reset. See `loc-changes-clear-buffer' to clear
-fringe and marginal icons.
-"
+marginal icons is reset.  See `loc-changes-clear-buffer' to clear
+fringe and marginal icons."
   (interactive)
   (let ((cmd-buf
         (realgud:run-debugger "trepan-ni"