From: Eli Zaretskii Date: Wed, 10 Jan 2018 19:24:58 +0000 (+0200) Subject: Fix documentation of some x-* functions X-Git-Tag: emacs-26.0.91~19 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4bd2416d5519a194a0be1a830dc19400676ac4f7;p=emacs.git Fix documentation of some x-* functions * lisp/term/pc-win.el (x-display-pixel-width) (x-display-pixel-height, x-display-planes) (x-display-color-cells, x-server-max-request-size) (x-server-vendor, x-server-version, x-display-screens) (x-display-mm-height, x-display-mm-width) (x-display-backing-store, x-display-visual-class): Provide doc strings, so that 'makedoc' produces non-empty documentation in etc/DOC for these functions. (Bug#30068) --- diff --git a/lisp/term/pc-win.el b/lisp/term/pc-win.el index 7c9c84b0a7d..83f5923ad59 100644 --- a/lisp/term/pc-win.el +++ b/lisp/term/pc-win.el @@ -189,18 +189,115 @@ the WIDTH times as wide as FACE on FRAME." (if (or (null width) (and (numberp width) (= width 1))) (list "ms-dos") (list "no-such-font"))) -(defun x-display-pixel-width (&optional frame) (frame-width frame)) -(defun x-display-pixel-height (&optional frame) (frame-height frame)) -(defun x-display-planes (&optional _frame) 4) ;bg switched to 16 colors as well -(defun x-display-color-cells (&optional _frame) 16) -(defun x-server-max-request-size (&optional _frame) 1000000) ; ??? -(defun x-server-vendor (&optional _frame) t "GNU") -(defun x-server-version (&optional _frame) '(1 0 0)) -(defun x-display-screens (&optional _frame) 1) -(defun x-display-mm-height (&optional _frame) 245) ; Guess the size of my -(defun x-display-mm-width (&optional _frame) 322) ; monitor, EZ... -(defun x-display-backing-store (&optional _frame) 'not-useful) -(defun x-display-visual-class (&optional _frame) 'static-color) +(defun x-display-pixel-width (&optional frame) + "Return the width in pixels of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display. + +On \"multi-monitor\" setups this refers to the pixel width for all +physical monitors associated with DISPLAY. To get information for +each physical monitor, use `display-monitor-attributes-list'." + (frame-width frame)) +(defun x-display-pixel-height (&optional frame) + "Return the height in pixels of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display. + +On \"multi-monitor\" setups this refers to the pixel height for all +physical monitors associated with DISPLAY. To get information for +each physical monitor, use `display-monitor-attributes-list'." + (frame-height frame)) +(defun x-display-planes (&optional _frame) + "Return the number of bitplanes of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + 4) ;bg switched to 16 colors as well +(defun x-display-color-cells (&optional _frame) + "Return the number of color cells of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + 16) +(defun x-server-max-request-size (&optional _frame) + "Return the maximum request size of the server of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + 1000000) ; ??? +(defun x-server-vendor (&optional _frame) + "Return the \"vendor ID\" string of the GUI software on TERMINAL. + +\(Labeling every distributor as a \"vendor\" embodies the false assumption +that operating systems cannot be developed and distributed noncommercially.) + +For GNU and Unix systems, this queries the X server software; for +MS-Windows, this queries the OS. + +The optional argument TERMINAL specifies which display to ask about. +TERMINAL should be a terminal object, a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + "GNU") +(defun x-server-version (&optional _frame) + "Return the version numbers of the GUI software on TERMINAL. +The value is a list of three integers specifying the version of the GUI +software in use. + +For GNU and Unix system, the first 2 numbers are the version of the X +Protocol used on TERMINAL and the 3rd number is the distributor-specific +release number. For MS-Windows, the 3 numbers report the version and +the build number of the OS. + +See also the function `x-server-vendor'. + +The optional argument TERMINAL specifies which display to ask about. +TERMINAL should be a terminal object, a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + '(1 0 0)) +(defun x-display-screens (&optional _frame) + "Return the number of screens on the server of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + 1) +(defun x-display-mm-height (&optional _frame) + "Return the height in millimeters of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display. + +On \"multi-monitor\" setups this refers to the height in millimeters for +all physical monitors associated with DISPLAY. To get information +for each physical monitor, use `display-monitor-attributes-list'." + 245) ; Guess the size of my... +(defun x-display-mm-width (&optional _frame) + "Return the width in millimeters of DISPLAY. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display. + +On \"multi-monitor\" setups this refers to the width in millimeters for +all physical monitors associated with TERMINAL. To get information +for each physical monitor, use `display-monitor-attributes-list'." + 322) ; ...monitor, EZ... +(defun x-display-backing-store (&optional _frame) + "Return an indication of whether DISPLAY does backing store. +The value may be `always', `when-mapped', or `not-useful'. +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + 'not-useful) +(defun x-display-visual-class (&optional _frame) + "Return the visual class of DISPLAY. +The value is one of the symbols `static-gray', `gray-scale', +`static-color', `pseudo-color', `true-color', or `direct-color'. + +The optional argument DISPLAY specifies which display to ask about. +DISPLAY should be either a frame or a display name (a string). +If omitted or nil, that stands for the selected frame's display." + 'static-color) (fset 'x-display-save-under 'ignore) (fset 'x-get-resource 'ignore)