branch: elpa/evil-nerd-commenter
commit 31db96711ee894e3b997b5823c5664bbed165143
Author: Chen Bin <[email protected]>
Commit: Chen Bin <[email protected]>
make check-doc happy
---
evil-nerd-commenter-operator.el | 15 +++++++++------
evil-nerd-commenter-sdk.el | 3 +++
evil-nerd-commenter.el | 8 ++++----
3 files changed, 16 insertions(+), 10 deletions(-)
diff --git a/evil-nerd-commenter-operator.el b/evil-nerd-commenter-operator.el
index c67d334a4e..b8adf6c683 100644
--- a/evil-nerd-commenter-operator.el
+++ b/evil-nerd-commenter-operator.el
@@ -50,10 +50,10 @@
"Major modes using C comment syntax.")
(defvar evilnc-temporary-goal-column 0
- "Value passed to `temporary-goal-column' which specify the right edge
-of rectangle yank.")
+ "Value of`temporary-goal-column' specifying right edge of rectangle yank.")
(defadvice evil-visual-highlight-block (around
evil-visual-highlight-block-hack activate)
+ "Show overlay over innert comment text object."
ad-do-it
(when (eq this-command 'evilnc-inner-comment)
(dolist (overlay evil-visual-block-overlays)
@@ -64,6 +64,7 @@ of rectangle yank.")
(move-overlay overlay b e)))))
(defadvice evil-apply-on-block (around evil-apply-on-block-around-hack
activate)
+ "Yank correct region of nner comment text object."
(let* ((tmp-command last-command))
;; force `evil-apply-on-block' use our temporary-goal-column
(when (> evilnc-temporary-goal-column 0)
@@ -127,7 +128,7 @@ of rectangle yank.")
(comment-region beg end))))
(defun evilnc-is-one-line-comment (b e)
- "One line comment."
+ "Check whether text between B and E is one line comment."
(save-excursion
(goto-char b)
(and (<= (line-beginning-position) b)
@@ -176,6 +177,7 @@ of rectangle yank.")
rlt))
(defun evilnc-adjusted-comment-end (b e)
+ "Ajust comment end of region between B and E."
(let* ((next-end-char (evilnc-get-char (- e 2)))
(end-char (evilnc-get-char (- e 1))))
;; avoid selecting CR/LF at the end of comment
@@ -208,7 +210,8 @@ of rectangle yank.")
(defun evilnc-comment-column-bounds (beg end &optional c-style)
"From BEG to END find column bounds of rectangle selection.
-Return (cons col-min col-max) or nil."
+Return (cons col-min col-max) or nil. If C-STYLE is t,
+we are processing C like language."
(let* ((col-min most-positive-fixnum)
(col-max 0))
(while (< beg end)
@@ -282,7 +285,7 @@ Return (cons col-min col-max) or nil."
(setq evilnc-temporary-goal-column (evil-column e)))))
(evil-range b e 'block :expanded t))))
(t
- (error "Not inside a comment.")))))
+ (error "Not inside a comment")))))
(evil-define-text-object evilnc-outer-commenter (&optional count begin end
type)
"An outer comment text object."
@@ -293,7 +296,7 @@ Return (cons col-min col-max) or nil."
(e (cdr bounds)))
(evil-range b e 'exclusive :expanded t)))
(t
- (error "Not inside a comment.")))))
+ (error "Not inside a comment")))))
(provide 'evil-nerd-commenter-operator)
;;; evil-nerd-commenter-operator.el ends here
diff --git a/evil-nerd-commenter-sdk.el b/evil-nerd-commenter-sdk.el
index abb1ae7f44..cc744cff1d 100644
--- a/evil-nerd-commenter-sdk.el
+++ b/evil-nerd-commenter-sdk.el
@@ -28,6 +28,7 @@
;;; Code:
(defun evilnc--check-fonts (fonts-under-cursor fonts-list)
+ "Check whether FONTS-UNDER-CURSOR among FONTS-LIST."
(delq nil
(mapcar #'(lambda (f)
;; learn this trick from flyspell
@@ -79,11 +80,13 @@ or else we can't select multiple lines comment."
(evilnc-is-pure-comment pos)))))
(defun evilnc-get-char (pos)
+ "Get character at POS."
(save-excursion
(goto-char pos)
(following-char)))
(defun evilnc-is-comment-delimiter (pos)
+ "Is character at POS a comment delimiter?"
(let* ((fontfaces (if (> pos 0) (get-text-property pos 'face))))
(if (not (listp fontfaces))
(setf fontfaces (list fontfaces)))
diff --git a/evil-nerd-commenter.el b/evil-nerd-commenter.el
index 4779ace9e2..7250398d13 100644
--- a/evil-nerd-commenter.el
+++ b/evil-nerd-commenter.el
@@ -366,6 +366,7 @@ Code snippets embedded in Org-mode is identified and right
`major-mode' is used.
is-comment))
(defun evilnc--web-mode-is-region-comment (beg end)
+ "Is region between BEG and END is comment in web mode?"
(let* ((rlt (and (save-excursion
(goto-char beg)
(goto-char (line-end-position))
@@ -654,7 +655,7 @@ Then we operate the expanded region. NUM is ignored."
;; {{ for non-evil user only
;;;###autoload
(defun evilnc-copy-to-line (&optional LINENUM)
- "Copy from current line to LINENUM line. For non-evil user only."
+ "Copy from current line to LINENUM line. For non-evil user only."
(interactive "nCopy to line: ")
(if (not (region-active-p))
(let* ((b (line-beginning-position))
@@ -698,10 +699,9 @@ Then we operate the expanded region. NUM is ignored."
(defvar evil-outer-text-objects-map)
;;;###autoload
(defun evilnc-default-hotkeys (&optional no-evil-keybindings)
- "Set up the key bindings of evil-nerd-comment.
-If NO-EVIL-KEYBINDINGS is t, we don't define keybindings in evil-mode."
+ "Setup the key bindings of evil-nerd-comment.
+If NO-EVIL-KEYBINDINGS is t, we don't define keybindings in EVIL."
(interactive)
-
;; Install hotkeys for Emacs mode
(global-set-key (kbd "M-;") 'evilnc-comment-or-uncomment-lines)
(global-set-key (kbd "C-c l") 'evilnc-quick-comment-or-uncomment-to-the-line)
