ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lisp/ox-html.el: Fix some checkdoc warnings 

* lisp/ox-html.el (org-html-format-list-item): Document some function
arguments.
(org-html--latex-environment-numbered-p): Suppress checkdoc heuristics.
(org-html-image-link-filter): Add docstring.
(org-html-table--table.el-table):
(org-html-final-function):  Document the function arguments.
This commit is contained in:
Ihor Radchenko 2023-12-11 12:59:27 +01:00
parent 664ffde149
commit 0c4358b4ac
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lisp/ox-html.el
View File

@ -2910,7 +2910,10 @@ INFO is a plist holding contextual information. See
(defun org-html-format-list-item (contents type checkbox info (defun org-html-format-list-item (contents type checkbox info
&optional term-counter-id &optional term-counter-id
headline) headline)
"Format a list item into HTML." "Format a list item into HTML.
CONTENTS is the item contents. TYPE is one of symbols `ordered',
`unordered', or `descriptive'. CHECKBOX checkbox type is nil or one of
symbols `on', `off', or `trans'. INFO is the info plist."
(let ((class (if checkbox (let ((class (if checkbox
(format " class=\"%s\"" (format " class=\"%s\""
(symbol-name checkbox)) "")) (symbol-name checkbox)) ""))
@ -3051,7 +3054,7 @@ used as a predicate for `org-export-get-ordinal' or a value to
(org-element-property :value element))) (org-element-property :value element)))
(defun org-html--latex-environment-numbered-p (element) (defun org-html--latex-environment-numbered-p (element)
"Non-nil when ELEMENT contains a numbered LaTeX math environment. "Non-nil when ELEMENT is a numbered LaTeX math environment.
Starred and \"displaymath\" environments are not numbered." Starred and \"displaymath\" environments are not numbered."
(not (string-match-p "\\`[ \t]*\\\\begin{\\(.*\\*\\|displaymath\\)}" (not (string-match-p "\\`[ \t]*\\\\begin{\\(.*\\*\\|displaymath\\)}"
(org-element-property :value element)))) (org-element-property :value element))))
@ -3133,6 +3136,9 @@ CONTENTS is nil. INFO is a plist holding contextual information."
;;;; Link ;;;; Link
(defun org-html-image-link-filter (data _backend info) (defun org-html-image-link-filter (data _backend info)
"Process image links that are inside descriptions.
DATA is the parse tree. INFO is and info plist.
See `org-export-insert-image-links' for more details."
(org-export-insert-image-links data info org-html-inline-image-rules)) (org-export-insert-image-links data info org-html-inline-image-rules))
(defun org-html-inline-image-p (link info) (defun org-html-inline-image-p (link info)
@ -3793,7 +3799,7 @@ INFO is a plist used as a communication channel."
(cdr (org-element-contents table-row))))) (cdr (org-element-contents table-row)))))
(defun org-html-table--table.el-table (table _info) (defun org-html-table--table.el-table (table _info)
"Format table.el tables into HTML. "Format table.el TABLE into HTML.
INFO is a plist used as a communication channel." INFO is a plist used as a communication channel."
(when (eq (org-element-property :type table) 'table.el) (when (eq (org-element-property :type table) 'table.el)
(require 'table) (require 'table)
@ -3923,7 +3929,8 @@ contextual information."
;;; Filter Functions ;;; Filter Functions
(defun org-html-final-function (contents _backend info) (defun org-html-final-function (contents _backend info)
"Filter to indent the HTML and convert HTML entities." "Filter to indent the HTML and convert HTML entities.
CONTENTS is the exported HTML code. INFO is the info plist."
(with-temp-buffer (with-temp-buffer
(insert contents) (insert contents)
(set-auto-mode t) (set-auto-mode t)