[mcclim-cvs] CVS mcclim/Doc
thenriksen
thenriksen at common-lisp.net
Sat Jan 19 10:24:19 UTC 2008
Update of /project/mcclim/cvsroot/mcclim/Doc
In directory clnet:/tmp/cvs-serv3342/Doc
Modified Files:
drei.texi
Log Message:
Updated Drei documentation.
--- /project/mcclim/cvsroot/mcclim/Doc/drei.texi 2008/01/13 10:33:09 1.11
+++ /project/mcclim/cvsroot/mcclim/Doc/drei.texi 2008/01/19 10:24:18 1.12
@@ -82,13 +82,27 @@
* Access Functions::
@end menu
+ at node Access Functions
+ at subsection Access Functions
+
+The access functions are the primary interface to Drei state, and should
+be used to access the various parts. It is not recommended to save the
+return value of these functions, as they are by nature ephemeral, and
+may change over the course of a command.
+
+ at include fun-drei-drei-instance.texi
+ at include fun-drei-current-view.texi
+ at include fun-esa-current-buffer.texi
+ at include fun-drei-point.texi
+ at include fun-drei-mark.texi
+ at include fun-drei-current-syntax.texi
+
@node Special Variables
@subsection Special Variables
-Drei uses a number of special variables to provide access to data
-structures. These are described below.
+Drei uses only a few special variables to provide access to data
+structures.
- at include var-drei-star-drei-instance-star.texi
@include var-drei-kill-ring-star-kill-ring-star.texi
Additionally, a number of ESA special variables are used in Drei.
@@ -96,19 +110,6 @@
@include var-esa-star-minibuffer-star.texi
@include var-esa-star-previous-command-star.texi
- at node Access Functions
- at subsection Access Functions
-
-The special variables essentially provide all that is needed to access
-all parts of the Drei state, but for convenience, a number of utility
-functions providing access to commonly used objects have been defined.
-
- at include fun-drei-current-view.texi
- at include fun-esa-current-buffer.texi
- at include fun-drei-point.texi
- at include fun-drei-mark.texi
- at include fun-drei-current-syntax.texi
-
@node External API
@section External API
More information about the Mcclim-cvs
mailing list