branch: externals/org-remark
commit e7aae5e4f4474a31fccaa982a752071c91033288
Author: Noboru Ota <[email protected]>
Commit: Noboru Ota <[email protected]>
doc: docstring for org-remark-highlight-mark-overlay
---
org-remark-line.el | 4 +++-
org-remark.el | 6 +++++-
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/org-remark-line.el b/org-remark-line.el
index 707d931184..f38ce3463b 100644
--- a/org-remark-line.el
+++ b/org-remark-line.el
@@ -112,7 +112,9 @@ by `overlays-in'."
(list bol bol)))
(cl-defmethod org-remark-highlight-mark-overlay (ov face (org-remark-type (eql
'line)))
- (org-remark-line-highlight-overlay-put ov face) ;; LINE
+ "Put FACE and other necessary properties to the highlight OV.
+This is a method for highlights of ORG-REMARK-TYPE \\='line\\='."
+ (org-remark-line-highlight-overlay-put ov face)
(overlay-put ov 'insert-in-front-hooks (list
'org-remark-line-highlight-modified)))
(defun org-remark-line-highlight-overlay-put (ov face &optional string)
diff --git a/org-remark.el b/org-remark.el
index 9ca48e08e3..eb353821f7 100644
--- a/org-remark.el
+++ b/org-remark.el
@@ -804,9 +804,13 @@ Optionally ID can be passed to find the exact ID match."
;; functions here mostly assume the current buffer is the source
;; buffer.
-(cl-defgeneric org-remark-highlight-mark-overlay (_org-remark-type))
+(cl-defgeneric org-remark-highlight-mark-overlay (_org-remark-type)
+ "Put FACE and other necessary properties to the highlight OV")
(cl-defmethod org-remark-highlight-mark-overlay (ov face (_org-remark-type
(eql nil)))
+ "Put FACE and other necessary properties to the highlight OV.
+This is a method for highlights of default ORG-REMARK-TYPE, that
+is for a character range."
(overlay-put ov 'face (if face face 'org-remark-highlighter)))
(defun org-remark-highlight-mark
