diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2023-11-05 18:24:49 +0100 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2023-11-05 18:24:49 +0100 |
| commit | c14cdda11b90e3f0e2ebf3c8a06d72eb29b6da1f (patch) | |
| tree | e118edf3a6c87a0c29927b2df278ff3ca22af68f | |
| parent | Use #' for quoting of function names (diff) | |
| download | ebuild-mode-c14cdda11b90e3f0e2ebf3c8a06d72eb29b6da1f.tar.gz ebuild-mode-c14cdda11b90e3f0e2ebf3c8a06d72eb29b6da1f.tar.bz2 ebuild-mode-c14cdda11b90e3f0e2ebf3c8a06d72eb29b6da1f.zip | |
Doc fixes
* glep-mode.el: Doc fixes.
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | glep-mode.el | 11 |
2 files changed, 12 insertions, 3 deletions
@@ -1,3 +1,7 @@ +2023-11-05 Ulrich Müller <ulm@gentoo.org> + + * glep-mode.el: Doc fixes. + 2023-10-15 Ulrich Müller <ulm@gentoo.org> * ebuild-mode.el: diff --git a/glep-mode.el b/glep-mode.el index 0c8f12b..6648dae 100644 --- a/glep-mode.el +++ b/glep-mode.el @@ -61,7 +61,7 @@ For efficiency only. Unlimited if nil.") (defun glep-mode-update-last-modified () - ;; Update Last-Modified date + "Update the Last-Modified date." (save-excursion (goto-char (point-min)) (let ((date (ebuild-mode-time-string "%Y-%m-%d")) @@ -73,6 +73,8 @@ For efficiency only. Unlimited if nil.") (replace-match date t t nil 1))))) (defun glep-mode-before-save () + "Function to be called before saving a buffer. +This will be added to the `write-contents-functions' hook." (when glep-mode-update-last-modified (glep-mode-update-last-modified) ;; call it only once per buffer @@ -124,7 +126,8 @@ For efficiency only. Unlimited if nil.") (and pre (>= pos (car pre)) (<= pos (cadr pre))))) (defun glep-mode-font-lock-match-delims (limit) - "Match delimiters to be highlighted by font-lock." + "Match delimiters to be highlighted by font-lock. +LIMIT is the limit of the search." (let ((pos (save-excursion (re-search-forward glep-mode-delim-re limit t)))) (and pos @@ -132,7 +135,8 @@ For efficiency only. Unlimited if nil.") (goto-char pos)))) (defun glep-mode-font-lock-match-preamble (limit) - "Match expressions in the preamble to be highlighted by font-lock." + "Match expressions in the preamble to be highlighted by font-lock. +LIMIT is the limit of the search." (let ((pos (save-excursion (re-search-forward glep-mode-font-lock-keywords limit t)))) (and pos @@ -162,6 +166,7 @@ to `font-lock-end'." ;; Prevent rst-mode from interpreting the "---" delimiter as section header. ;; *** FIXME *** This is incomplete and probably too brittle. (defun glep-mode-ignore-preamble (_adornment end &rest _args) + ;; checkdoc-params: (_adornment end _args) "Ignore GLEP preamble in `rst-classify-adornment'." (not (and (eq major-mode 'glep-mode) (glep-mode-in-preamble-p end)))) |