Doc: document structures YAS--FIELD and YAS--MIRROR

This commit is contained in:
João Távora 2012-12-25 04:29:51 +00:00
parent 35493b8f06
commit 618cf506ee

View File

@ -2909,7 +2909,16 @@ Use this in primary and mirror transformations to tget."
force-exit) force-exit)
(defstruct (yas--field (:constructor yas--make-field (number start end parent-field))) (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 number
start end start end
parent-field parent-field
@ -2918,8 +2927,15 @@ Use this in primary and mirror transformations to tget."
(modified-p nil) (modified-p nil)
next) next)
(defstruct (yas--mirror (:constructor yas--make-mirror (start end transform))) (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 start end
(transform nil) (transform nil)
parent-field parent-field