]> code.delx.au - gnu-emacs-elpa/commitdiff
Doc: document structures YAS--FIELD and YAS--MIRROR
authorJoão Távora <joaotavora@gmail.com>
Tue, 25 Dec 2012 04:29:51 +0000 (04:29 +0000)
committerJoão Távora <joaotavora@gmail.com>
Tue, 25 Dec 2012 04:30:26 +0000 (04:30 +0000)
yasnippet.el

index d51a7edeab66c00b4bdfdacde679b71864ff56f2..1c1d4618ba9a122dd441ec751b806763f94cb91f 100644 (file)
@@ -2909,7 +2909,16 @@ Use this in primary and mirror transformations to tget."
   force-exit)
 
 (defstruct (yas--field (:constructor yas--make-field (number start end parent-field)))
-  "A field."
+  "A field.
+
+NUMBER is the field number.
+START and END are mostly buffer markers, but see \"apropos markers-to-points\".
+PARENT-FIELD is a `yas--field' this field is nested under, or nil.
+MIRRORS is a list of `yas--mirror's
+TRANSFORM is a lisp form.
+MODIFIED-P is a boolean set to true once user inputs text.
+NEXT is another `yas--field' or `yas--mirror' or `yas--exit'.
+"
   number
   start end
   parent-field
@@ -2918,8 +2927,15 @@ Use this in primary and mirror transformations to tget."
   (modified-p nil)
   next)
 
+
 (defstruct (yas--mirror (:constructor yas--make-mirror (start end transform)))
-  "A mirror."
+  "A mirror.
+
+START and END are mostly buffer markers, but see \"apropos markers-to-points\".
+TRANSFORM is a lisp form.
+PARENT-FIELD is a `yas--field' this mirror is nested under, or nil.
+NEXT is another `yas--field' or `yas--mirror' or `yas--exit'
+DEPTH is a count of how many nested mirrors can affect this mirror"
   start end
   (transform nil)
   parent-field