aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2023-04-21 20:10:01 +0200
committerTeddy Wing2023-04-21 20:10:01 +0200
commit2e5415ff7cfd8b8bd176a9206ae8fdc08c364862 (patch)
tree3d0ffd63aa3f394ab9a08fef95447cc3a387d5f9
parentd70f4a9091968b3664078b9ebc228a09d3990f55 (diff)
downloadxfdf-2e5415ff7cfd8b8bd176a9206ae8fdc08c364862.tar.bz2
field-xfdf: Add documentation to these functions
-rw-r--r--src/xfdf.lisp4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/xfdf.lisp b/src/xfdf.lisp
index 5e0be7c..d88c15d 100644
--- a/src/xfdf.lisp
+++ b/src/xfdf.lisp
@@ -33,10 +33,12 @@ list."
(defconstant +field-base-indentation+ 2)
(defun field-xfdf (name value)
+ "Build an XFDF XML string for a field."
(field-xfdf* name value 0))
(defun field-xfdf* (name value nesting-level)
- ""
+ "Build an XFDF XML string for a field. The `nesting-level` specifies the
+amount of indentation to use relative to the +field-base-indentation+."
(let ((indent (+ +field-base-indentation+ nesting-level)))
;; TODO: Add checkbox default values.
(if (consp value)