summaryrefslogtreecommitdiff
path: root/lisp/format.el
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2002-04-03 15:29:25 +0000
committerRichard M. Stallman <rms@gnu.org>2002-04-03 15:29:25 +0000
commit92308d3a2af481d69783a0984d3eac067414bb71 (patch)
treee326ca6070c6dd15bb14a64e232995b5667f3b7a /lisp/format.el
parentae8f92579cbbf873dcbef1fad931cd4f2797ea31 (diff)
downloademacs-92308d3a2af481d69783a0984d3eac067414bb71.tar.gz
(format-deannotate-region): Doc fix.
Diffstat (limited to 'lisp/format.el')
-rw-r--r--lisp/format.el15
1 files changed, 9 insertions, 6 deletions
diff --git a/lisp/format.el b/lisp/format.el
index d5b4c859d8a..e8298a5d47a 100644
--- a/lisp/format.el
+++ b/lisp/format.el
@@ -565,12 +565,15 @@ the TRANSLATIONS list: PARAMETER and FUNCTION \(spelled in uppercase).
Annotations listed under the pseudo-property PARAMETER are considered to be
arguments of the immediately surrounding annotation; the text between the
opening and closing parameter annotations is deleted from the buffer but saved
-as a string. The surrounding annotation should be listed under the
-pseudo-property FUNCTION. Instead of inserting a text-property for this
-annotation, the function listed in the VALUE slot is called to make whatever
-changes are appropriate. The function's first two arguments are the START and
-END locations, and the rest of the arguments are any PARAMETERs found in that
-region.
+as a string.
+
+The surrounding annotation should be listed under the pseudo-property
+FUNCTION. Instead of inserting a text-property for this annotation,
+the function listed in the VALUE slot is called to make whatever
+changes are appropriate. It can also return a list of the form
+\(START LOC PROP VALUE) which specifies a property to put on. The
+function's first two arguments are the START and END locations, and
+the rest of the arguments are any PARAMETERs found in that region.
Any annotations that are found by NEXT-FN but not defined by TRANSLATIONS
are saved as values of the `unknown' text-property \(which is list-valued).