diff options
| author | Glenn Morris | 2018-02-13 14:22:16 -0800 |
|---|---|---|
| committer | Glenn Morris | 2018-02-13 14:22:16 -0800 |
| commit | 4bee1b8bacb9ce6107ea605da464d01f6bd3aa7d (patch) | |
| tree | dc5dc2098f8956b66620cc1003601f705c289cd2 /doc | |
| parent | 6c7186de3bbb2b7652cdc01a68bee035761197e5 (diff) | |
| download | emacs-4bee1b8bacb9ce6107ea605da464d01f6bd3aa7d.tar.gz emacs-4bee1b8bacb9ce6107ea605da464d01f6bd3aa7d.zip | |
Stop keeping multiple doc copies for items defined multiple times
It was always a nuisance to keep all the copies in sync.
* src/doc.c (Fsnarf_documentation): Don't skip entire files.
Instead, skip individual doc strings starting with "SKIP".
* doc/lispref/internals.texi (Writing Emacs Primitives):
Mention this skipping.
* lisp/term/ns-win.el, lisp/term/pc-win.el, src/dosfns.c:
* src/frame.c, src/nsfns.m, src/nsmenu.m, src/nsterm.m:
* src/w16select.c, src/w32fns.c, src/w32menu.c, src/w32select.c:
* src/w32term.c, src/xmenu.c: Remove duplicated doc strings.
* src/xfns.c: Merge in information from doc string duplicates.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/internals.texi | 7 |
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 |
| 759 | arguments. | 759 | arguments. |
| 760 | 760 | ||
| 761 | Some primitives have multiple definitions, one per platform (e.g., | ||
| 762 | @code{x-create-frame}). In such cases, rather than writing the | ||
| 763 | same documentation string in each definition, only one definition has | ||
| 764 | the 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 | |||
| 761 | All the usual rules for documentation strings in Lisp code | 768 | All 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 |
| 763 | too. | 770 | too. |