diff options
| author | Basil L. Contovounesios | 2020-06-03 17:31:44 +0100 |
|---|---|---|
| committer | Basil L. Contovounesios | 2020-06-06 16:35:52 +0100 |
| commit | d8593fd19ffdb1fa62f0b0c4b971cfdb325fbe1d (patch) | |
| tree | ed7588bd560101abbcf30159c75e227d32a885d3 | |
| parent | 3916e63f9e98269930c4935dd5b3b88c4d940a62 (diff) | |
| download | emacs-d8593fd19ffdb1fa62f0b0c4b971cfdb325fbe1d.tar.gz emacs-d8593fd19ffdb1fa62f0b0c4b971cfdb325fbe1d.zip | |
Minor improvements to EDE and EIEIO manuals
For discussion, see the following threads:
https://lists.gnu.org/archive/html/emacs-devel/2020-05/msg00630.html
https://lists.gnu.org/archive/html/emacs-devel/2020-06/msg00099.html
* doc/misc/ede.texi (ede-generic-project): Clean up example.
* doc/misc/eieio.texi (Accessing Slots): Document slot-value as a
generalized variable and set-slot-value as obsolete.
(Predicates): Fix typo.
(Introspection): Document eieio-class-slots in place of the obsolete
object-slots.
| -rw-r--r-- | doc/misc/ede.texi | 10 | ||||
| -rw-r--r-- | doc/misc/eieio.texi | 17 |
2 files changed, 16 insertions, 11 deletions
diff --git a/doc/misc/ede.texi b/doc/misc/ede.texi index 584b0d7ee50..412176986cc 100644 --- a/doc/misc/ede.texi +++ b/doc/misc/ede.texi | |||
| @@ -955,18 +955,16 @@ The example for Makefiles looks like this: | |||
| 955 | ;;; MAKEFILE | 955 | ;;; MAKEFILE |
| 956 | 956 | ||
| 957 | (defclass ede-generic-makefile-project (ede-generic-project) | 957 | (defclass ede-generic-makefile-project (ede-generic-project) |
| 958 | ((buildfile :initform "Makefile") | 958 | ((buildfile :initform "Makefile")) |
| 959 | ) | ||
| 960 | "Generic Project for makefiles.") | 959 | "Generic Project for makefiles.") |
| 961 | 960 | ||
| 962 | (defmethod ede-generic-setup-configuration ((proj ede-generic-makefile-project) config) | 961 | (defmethod ede-generic-setup-configuration ((proj ede-generic-makefile-project) config) |
| 963 | "Setup a configuration for Make." | 962 | "Set up a configuration for Make." |
| 964 | (oset config build-command "make -k") | 963 | (oset config build-command "make -k") |
| 965 | (oset config debug-command "gdb ") | 964 | (oset config debug-command "gdb ")) |
| 966 | ) | ||
| 967 | 965 | ||
| 968 | (ede-generic-new-autoloader "generic-makefile" "Make" | 966 | (ede-generic-new-autoloader "generic-makefile" "Make" |
| 969 | "Makefile" 'ede-generic-makefile-project) | 967 | "Makefile" 'ede-generic-makefile-project) |
| 970 | @end example | 968 | @end example |
| 971 | 969 | ||
| 972 | This example project will detect any directory with the file | 970 | This example project will detect any directory with the file |
diff --git a/doc/misc/eieio.texi b/doc/misc/eieio.texi index 3943c544c7d..aceaff051e3 100644 --- a/doc/misc/eieio.texi +++ b/doc/misc/eieio.texi | |||
| @@ -734,14 +734,21 @@ slot values, and use the previously mentioned set/ref routines. | |||
| 734 | @anchor{slot-value} | 734 | @anchor{slot-value} |
| 735 | This function retrieves the value of @var{slot} from @var{object}. | 735 | This function retrieves the value of @var{slot} from @var{object}. |
| 736 | Unlike @code{oref}, the symbol for @var{slot} must be quoted. | 736 | Unlike @code{oref}, the symbol for @var{slot} must be quoted. |
| 737 | |||
| 738 | This is a generalized variable that can be used with @code{setf} to | ||
| 739 | modify the value stored in @var{slot}. @xref{Generalized | ||
| 740 | Variables,,,elisp,GNU Emacs Lisp Reference Manual}. | ||
| 737 | @end defun | 741 | @end defun |
| 738 | 742 | ||
| 739 | @defun set-slot-value object slot value | 743 | @defun set-slot-value object slot value |
| 740 | @anchor{set-slot-value} | 744 | @anchor{set-slot-value} |
| 741 | This is not a CLOS function, but is the setter for @code{slot-value} | 745 | This function sets the value of @var{slot} from @var{object}. Unlike |
| 742 | used by the @code{setf} macro. This | ||
| 743 | function sets the value of @var{slot} from @var{object}. Unlike | ||
| 744 | @code{oset}, the symbol for @var{slot} must be quoted. | 746 | @code{oset}, the symbol for @var{slot} must be quoted. |
| 747 | |||
| 748 | This is not a CLOS function, but is the obsolete setter for | ||
| 749 | @code{slot-value} used by the @code{setf} macro. It is therefore | ||
| 750 | recommended to use @w{@code{(setf (slot-value @var{object} @var{slot}) | ||
| 751 | @var{value})}} instead. | ||
| 745 | @end defun | 752 | @end defun |
| 746 | 753 | ||
| 747 | @defun slot-makeunbound object slot | 754 | @defun slot-makeunbound object slot |
| @@ -1062,7 +1069,7 @@ Return a string of the form @samp{#<object-class myobjname>} for @var{obj}. | |||
| 1062 | This should look like Lisp symbols from other parts of Emacs such as | 1069 | This should look like Lisp symbols from other parts of Emacs such as |
| 1063 | buffers and processes, and is shorter and cleaner than printing the | 1070 | buffers and processes, and is shorter and cleaner than printing the |
| 1064 | object's record. It is more useful to use @code{object-print} to get | 1071 | object's record. It is more useful to use @code{object-print} to get |
| 1065 | and object's print form, as this allows the object to add extra display | 1072 | an object's print form, as this allows the object to add extra display |
| 1066 | information into the symbol. | 1073 | information into the symbol. |
| 1067 | @end defun | 1074 | @end defun |
| 1068 | 1075 | ||
| @@ -1217,7 +1224,7 @@ objects on top of records, and thus everything is technically visible, | |||
| 1217 | some functions have been provided. None of these functions are a part | 1224 | some functions have been provided. None of these functions are a part |
| 1218 | of CLOS. | 1225 | of CLOS. |
| 1219 | 1226 | ||
| 1220 | @defun object-slots obj | 1227 | @defun eieio-class-slots obj |
| 1221 | Return the list of public slots for @var{obj}. | 1228 | Return the list of public slots for @var{obj}. |
| 1222 | @end defun | 1229 | @end defun |
| 1223 | 1230 | ||