aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/internals.texi7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi
index 8bf9abfc614..76be7bf0ac6 100644
--- a/doc/lispref/internals.texi
+++ b/doc/lispref/internals.texi
@@ -758,6 +758,13 @@ names in the documentation string from the ones used in the C code.
758@samp{usage:} is required if the function has an unlimited number of 758@samp{usage:} is required if the function has an unlimited number of
759arguments. 759arguments.
760 760
761Some primitives have multiple definitions, one per platform (e.g.,
762@code{x-create-frame}). In such cases, rather than writing the
763same documentation string in each definition, only one definition has
764the actual documentation. The others have placeholders beginning with
765@samp{SKIP}, which are ignored by the function that parses the
766@file{DOC} file.
767
761All the usual rules for documentation strings in Lisp code 768All the usual rules for documentation strings in Lisp code
762(@pxref{Documentation Tips}) apply to C code documentation strings 769(@pxref{Documentation Tips}) apply to C code documentation strings
763too. 770too.