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 /lisp | |
| 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 'lisp')
| -rw-r--r-- | lisp/term/ns-win.el | 9 | ||||
| -rw-r--r-- | lisp/term/pc-win.el | 138 |
2 files changed, 20 insertions, 127 deletions
diff --git a/lisp/term/ns-win.el b/lisp/term/ns-win.el index ca2cc725a66..7d89ec33a46 100644 --- a/lisp/term/ns-win.el +++ b/lisp/term/ns-win.el | |||
| @@ -437,14 +437,7 @@ Lines are highlighted according to `ns-input-line'." | |||
| 437 | ;;;; File handling. | 437 | ;;;; File handling. |
| 438 | 438 | ||
| 439 | (defun x-file-dialog (prompt dir default_filename mustmatch only_dir_p) | 439 | (defun x-file-dialog (prompt dir default_filename mustmatch only_dir_p) |
| 440 | "Read file name, prompting with PROMPT in directory DIR. | 440 | "SKIP: real doc in xfns.c." |
| 441 | Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file | ||
| 442 | selection box, if specified. If MUSTMATCH is non-nil, the returned file | ||
| 443 | or directory must exist. | ||
| 444 | |||
| 445 | This function is only defined on NS, MS Windows, and X Windows with the | ||
| 446 | Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored. | ||
| 447 | Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories." | ||
| 448 | (ns-read-file-name prompt dir mustmatch default_filename only_dir_p)) | 441 | (ns-read-file-name prompt dir mustmatch default_filename only_dir_p)) |
| 449 | 442 | ||
| 450 | (defun ns-open-file-using-panel () | 443 | (defun ns-open-file-using-panel () |
diff --git a/lisp/term/pc-win.el b/lisp/term/pc-win.el index 3ed21b8e436..9c1b471d484 100644 --- a/lisp/term/pc-win.el +++ b/lisp/term/pc-win.el | |||
| @@ -158,159 +158,59 @@ created." | |||
| 158 | ;; a useful function for returning 'nil regardless of argument. | 158 | ;; a useful function for returning 'nil regardless of argument. |
| 159 | 159 | ||
| 160 | ;; Note: Any re-definition in this file of a function that is defined | 160 | ;; Note: Any re-definition in this file of a function that is defined |
| 161 | ;; in C on other platforms, should either have no doc-string, or one | 161 | ;; in C on other platforms, should either have a doc-string that |
| 162 | ;; that is identical to the C version, but with the arglist signature | 162 | ;; starts with "SKIP", or one that is identical to the C version, |
| 163 | ;; at the end. Otherwise help-split-fundoc gets confused on other | 163 | ;; but with the arglist signature at the end. Otherwise |
| 164 | ;; platforms. (Bug#10783) | 164 | ;; help-split-fundoc gets confused on other platforms. (Bug#10783) |
| 165 | 165 | ||
| 166 | ;; From src/xfns.c | ||
| 167 | (defun x-list-fonts (_pattern &optional _face _frame _maximum width) | 166 | (defun x-list-fonts (_pattern &optional _face _frame _maximum width) |
| 168 | "Return a list of the names of available fonts matching PATTERN. | 167 | "SKIP: real doc in xfaces.c." |
| 169 | If optional arguments FACE and FRAME are specified, return only fonts | ||
| 170 | the same size as FACE on FRAME. | ||
| 171 | |||
| 172 | PATTERN should be a string containing a font name in the XLFD, | ||
| 173 | Fontconfig, or GTK format. A font name given in the XLFD format may | ||
| 174 | contain wildcard characters: | ||
| 175 | the * character matches any substring, and | ||
| 176 | the ? character matches any single character. | ||
| 177 | PATTERN is case-insensitive. | ||
| 178 | |||
| 179 | The return value is a list of strings, suitable as arguments to | ||
| 180 | `set-face-font'. | ||
| 181 | |||
| 182 | Fonts Emacs can't use may or may not be excluded | ||
| 183 | even if they match PATTERN and FACE. | ||
| 184 | The optional fourth argument MAXIMUM sets a limit on how many | ||
| 185 | fonts to match. The first MAXIMUM fonts are reported. | ||
| 186 | The optional fifth argument WIDTH, if specified, is a number of columns | ||
| 187 | occupied by a character of a font. In that case, return only fonts | ||
| 188 | the WIDTH times as wide as FACE on FRAME." | ||
| 189 | (if (or (null width) (and (numberp width) (= width 1))) | 168 | (if (or (null width) (and (numberp width) (= width 1))) |
| 190 | (list "ms-dos") | 169 | (list "ms-dos") |
| 191 | (list "no-such-font"))) | 170 | (list "no-such-font"))) |
| 192 | (defun x-display-pixel-width (&optional frame) | 171 | (defun x-display-pixel-width (&optional frame) |
| 193 | "Return the width in pixels of DISPLAY. | 172 | "SKIP: real doc in xfns.c." |
| 194 | The optional argument DISPLAY specifies which display to ask about. | ||
| 195 | DISPLAY should be either a frame or a display name (a string). | ||
| 196 | If omitted or nil, that stands for the selected frame's display. | ||
| 197 | |||
| 198 | On \"multi-monitor\" setups this refers to the pixel width for all | ||
| 199 | physical monitors associated with DISPLAY. To get information for | ||
| 200 | each physical monitor, use `display-monitor-attributes-list'." | ||
| 201 | (frame-width frame)) | 173 | (frame-width frame)) |
| 202 | (defun x-display-pixel-height (&optional frame) | 174 | (defun x-display-pixel-height (&optional frame) |
| 203 | "Return the height in pixels of DISPLAY. | 175 | "SKIP: real doc in xfns.c." |
| 204 | The optional argument DISPLAY specifies which display to ask about. | ||
| 205 | DISPLAY should be either a frame or a display name (a string). | ||
| 206 | If omitted or nil, that stands for the selected frame's display. | ||
| 207 | |||
| 208 | On \"multi-monitor\" setups this refers to the pixel height for all | ||
| 209 | physical monitors associated with DISPLAY. To get information for | ||
| 210 | each physical monitor, use `display-monitor-attributes-list'." | ||
| 211 | (frame-height frame)) | 176 | (frame-height frame)) |
| 212 | (defun x-display-planes (&optional _frame) | 177 | (defun x-display-planes (&optional _frame) |
| 213 | "Return the number of bitplanes of DISPLAY. | 178 | "SKIP: real doc in xfns.c." |
| 214 | The optional argument DISPLAY specifies which display to ask about. | ||
| 215 | DISPLAY should be either a frame or a display name (a string). | ||
| 216 | If omitted or nil, that stands for the selected frame's display." | ||
| 217 | 4) ;bg switched to 16 colors as well | 179 | 4) ;bg switched to 16 colors as well |
| 218 | (defun x-display-color-cells (&optional _frame) | 180 | (defun x-display-color-cells (&optional _frame) |
| 219 | "Return the number of color cells of DISPLAY. | 181 | "SKIP: real doc in xfns.c." |
| 220 | The optional argument DISPLAY specifies which display to ask about. | ||
| 221 | DISPLAY should be either a frame or a display name (a string). | ||
| 222 | If omitted or nil, that stands for the selected frame's display." | ||
| 223 | 16) | 182 | 16) |
| 224 | (defun x-server-max-request-size (&optional _frame) | 183 | (defun x-server-max-request-size (&optional _frame) |
| 225 | "Return the maximum request size of the server of DISPLAY. | 184 | "SKIP: real doc in xfns.c." |
| 226 | The optional argument DISPLAY specifies which display to ask about. | ||
| 227 | DISPLAY should be either a frame or a display name (a string). | ||
| 228 | If omitted or nil, that stands for the selected frame's display." | ||
| 229 | 1000000) ; ??? | 185 | 1000000) ; ??? |
| 230 | (defun x-server-vendor (&optional _frame) | 186 | (defun x-server-vendor (&optional _frame) |
| 231 | "Return the \"vendor ID\" string of the GUI software on TERMINAL. | 187 | "SKIP: real doc in xfns.c." |
| 232 | |||
| 233 | \(Labeling every distributor as a \"vendor\" embodies the false assumption | ||
| 234 | that operating systems cannot be developed and distributed noncommercially.) | ||
| 235 | |||
| 236 | For GNU and Unix systems, this queries the X server software; for | ||
| 237 | MS-Windows, this queries the OS. | ||
| 238 | |||
| 239 | The optional argument TERMINAL specifies which display to ask about. | ||
| 240 | TERMINAL should be a terminal object, a frame or a display name (a string). | ||
| 241 | If omitted or nil, that stands for the selected frame's display." | ||
| 242 | "GNU") | 188 | "GNU") |
| 243 | (defun x-server-version (&optional _frame) | 189 | (defun x-server-version (&optional _frame) |
| 244 | "Return the version numbers of the GUI software on TERMINAL. | 190 | "SKIP: real doc in xfns.c." |
| 245 | The value is a list of three integers specifying the version of the GUI | ||
| 246 | software in use. | ||
| 247 | |||
| 248 | For GNU and Unix system, the first 2 numbers are the version of the X | ||
| 249 | Protocol used on TERMINAL and the 3rd number is the distributor-specific | ||
| 250 | release number. For MS-Windows, the 3 numbers report the version and | ||
| 251 | the build number of the OS. | ||
| 252 | |||
| 253 | See also the function `x-server-vendor'. | ||
| 254 | |||
| 255 | The optional argument TERMINAL specifies which display to ask about. | ||
| 256 | TERMINAL should be a terminal object, a frame or a display name (a string). | ||
| 257 | If omitted or nil, that stands for the selected frame's display." | ||
| 258 | '(1 0 0)) | 191 | '(1 0 0)) |
| 259 | (defun x-display-screens (&optional _frame) | 192 | (defun x-display-screens (&optional _frame) |
| 260 | "Return the number of screens on the server of DISPLAY. | 193 | "SKIP: real doc in xfns.c." |
| 261 | The optional argument DISPLAY specifies which display to ask about. | ||
| 262 | DISPLAY should be either a frame or a display name (a string). | ||
| 263 | If omitted or nil, that stands for the selected frame's display." | ||
| 264 | 1) | 194 | 1) |
| 265 | (defun x-display-mm-height (&optional _frame) | 195 | (defun x-display-mm-height (&optional _frame) |
| 266 | "Return the height in millimeters of DISPLAY. | 196 | "SKIP: real doc in xfns.c." |
| 267 | The optional argument DISPLAY specifies which display to ask about. | ||
| 268 | DISPLAY should be either a frame or a display name (a string). | ||
| 269 | If omitted or nil, that stands for the selected frame's display. | ||
| 270 | |||
| 271 | On \"multi-monitor\" setups this refers to the height in millimeters for | ||
| 272 | all physical monitors associated with DISPLAY. To get information | ||
| 273 | for each physical monitor, use `display-monitor-attributes-list'." | ||
| 274 | 245) ; Guess the size of my... | 197 | 245) ; Guess the size of my... |
| 275 | (defun x-display-mm-width (&optional _frame) | 198 | (defun x-display-mm-width (&optional _frame) |
| 276 | "Return the width in millimeters of DISPLAY. | 199 | "SKIP: real doc in xfns.c." |
| 277 | The optional argument DISPLAY specifies which display to ask about. | ||
| 278 | DISPLAY should be either a frame or a display name (a string). | ||
| 279 | If omitted or nil, that stands for the selected frame's display. | ||
| 280 | |||
| 281 | On \"multi-monitor\" setups this refers to the width in millimeters for | ||
| 282 | all physical monitors associated with TERMINAL. To get information | ||
| 283 | for each physical monitor, use `display-monitor-attributes-list'." | ||
| 284 | 322) ; ...monitor, EZ... | 200 | 322) ; ...monitor, EZ... |
| 285 | (defun x-display-backing-store (&optional _frame) | 201 | (defun x-display-backing-store (&optional _frame) |
| 286 | "Return an indication of whether DISPLAY does backing store. | 202 | "SKIP: real doc in xfns.c." |
| 287 | The value may be `always', `when-mapped', or `not-useful'. | ||
| 288 | The optional argument DISPLAY specifies which display to ask about. | ||
| 289 | DISPLAY should be either a frame or a display name (a string). | ||
| 290 | If omitted or nil, that stands for the selected frame's display." | ||
| 291 | 'not-useful) | 203 | 'not-useful) |
| 292 | (defun x-display-visual-class (&optional _frame) | 204 | (defun x-display-visual-class (&optional _frame) |
| 293 | "Return the visual class of DISPLAY. | 205 | "SKIP: real doc in xfns.c." |
| 294 | The value is one of the symbols `static-gray', `gray-scale', | ||
| 295 | `static-color', `pseudo-color', `true-color', or `direct-color'. | ||
| 296 | |||
| 297 | The optional argument DISPLAY specifies which display to ask about. | ||
| 298 | DISPLAY should be either a frame or a display name (a string). | ||
| 299 | If omitted or nil, that stands for the selected frame's display." | ||
| 300 | 'static-color) | 206 | 'static-color) |
| 301 | (fset 'x-display-save-under 'ignore) | 207 | (fset 'x-display-save-under 'ignore) |
| 302 | (fset 'x-get-resource 'ignore) | 208 | (fset 'x-get-resource 'ignore) |
| 303 | 209 | ||
| 304 | ;; From lisp/term/x-win.el | ||
| 305 | (defvar x-display-name "pc" | 210 | (defvar x-display-name "pc" |
| 306 | "The name of the window display on which Emacs was started. | 211 | "SKIP: real doc in common-win.el.") |
| 307 | On X, the display name of individual X frames is recorded in the | ||
| 308 | `display' frame parameter.") | ||
| 309 | (defvar x-colors (mapcar 'car msdos-color-values) | 212 | (defvar x-colors (mapcar 'car msdos-color-values) |
| 310 | "List of basic colors available on color displays. | 213 | "SKIP: real doc in common-win.el.") |
| 311 | For X, the list comes from the `rgb.txt' file,v 10.41 94/02/20. | ||
| 312 | For Nextstep, this is a list of non-PANTONE colors returned by | ||
| 313 | the operating system.") | ||
| 314 | 214 | ||
| 315 | ;; From lisp/term/w32-win.el | 215 | ;; From lisp/term/w32-win.el |
| 316 | ; | 216 | ; |