1998-05-11 Martin Buchholz <martin(a)xemacs.org>
* lisp/buff-menu.el:
* lisp/lisp-mode.el:
* lisp/obsolete.el:
* src/buffer.c:
* src/fileio.c:
* src/lread.c:
* src/xselect.c:
Change empty docstrings into no doc strings at all.
Fix bogus FSF-format docstrings.
* lisp/etags.el: Fix docstring.
* src/extents.c:
Standardize docstrings.
* src/floatfns.c:
Explain problems with matherr.
* src/glyphs.c: make DEFUNs etags-readable, i.e. single-line
--- lisp/buff-menu.el.old
+++ lisp/buff-menu.el
＠＠ -66,7 +66,7 ＠＠
(defvar Buffer-menu-buffer-column 4)
-(defvar Buffer-menu-mode-map nil "")
+(defvar Buffer-menu-mode-map nil)
(if Buffer-menu-mode-map
()
--- lisp/etags.el.old
+++ lisp/etags.el
＠＠ -554,9 +554,9 ＠＠
arguments.")
(defvar find-tag-hook nil
- "Function to call after a hook is found.
+ "Function to call after a tag is found.
Make it buffer-local in a mode hook. The function is called with no
- argsuments.")
+ arguments.")
;; Return a default tag to search for, based on the text at point.
(defun find-tag-default ()
--- lisp/lisp-mode.el.old
+++ lisp/lisp-mode.el
＠＠ -41,9 +41,9 ＠＠
:group 'languages
:group 'development)
-(defvar lisp-mode-syntax-table nil "")
-(defvar emacs-lisp-mode-syntax-table nil "")
-(defvar lisp-mode-abbrev-table nil "")
+(defvar lisp-mode-syntax-table nil)
+(defvar emacs-lisp-mode-syntax-table nil)
+(defvar lisp-mode-abbrev-table nil)
;; XEmacs change
(defvar lisp-interaction-mode-popup-menu nil)
＠＠ -491,8 +491,8 ＠＠
(insert block-comment-start))
(indent-for-comment))
-(defconst lisp-indent-offset nil "")
-(defconst lisp-indent-function 'lisp-indent-function "")
+(defconst lisp-indent-offset nil)
+(defconst lisp-indent-function 'lisp-indent-function)
(defun lisp-indent-line (&optional whole-exp)
"Indent current line as Lisp code.
--- lisp/obsolete.el.old
+++ lisp/obsolete.el
＠＠ -93,11 +93,10 ＠＠
(define-function 'x-grayscale-display-p 'x-display-grayscale-p)
(make-compatible 'x-display-grayscale-p 'device-class)
-(define-compatible-function-alias 'x-display-pixel-width 'device-pixel-width)
-(define-compatible-function-alias 'x-display-pixel-height
- 'device-pixel-height)
-(define-compatible-function-alias 'x-display-planes 'device-bitplanes)
-(define-compatible-function-alias 'x-display-color-cells 'device-color-cells)
+(define-compatible-function-alias 'x-display-pixel-width 'device-pixel-width)
+(define-compatible-function-alias 'x-display-pixel-height 'device-pixel-height)
+(define-compatible-function-alias 'x-display-planes 'device-bitplanes)
+(define-compatible-function-alias 'x-display-color-cells 'device-color-cells)
(define-obsolete-function-alias 'baud-rate 'device-baud-rate)
＠＠ -122,7 +121,7 ＠＠
(define-obsolete-function-alias 'extent-buffer 'extent-object)
(defun set-extent-attribute (extent attr &optional clearp)
- "" ;; obsoleteness info will be displayed, so no need for anything more.
+ ;; obsoleteness info will be displayed, so no need for docstring.
(cond ((eq attr 'write-protected)
(set-extent-property extent 'read-only t))
((eq attr 'unhighlight)
＠＠ -136,20 +135,20 ＠＠
(make-obsolete 'set-extent-attribute 'set-extent-property)
(defun extent-glyph (extent)
- "" ;; obsoleteness info will be displayed, so no need for anything more.
+ ;; obsoleteness info will be displayed, so no need for docstring.
(or (extent-begin-glyph extent)
(extent-end-glyph extent)))
(make-obsolete 'extent-glyph
"use `extent-begin-glyph' or `extent-end-glyph' instead.")
(defun extent-layout (extent)
- "" ;; obsoleteness info will be displayed, so no need for anything more.
+ ;; obsoleteness info will be displayed, so no need for docstring.
(extent-begin-glyph-layout extent))
(make-obsolete 'extent-layout
"use `extent-begin-glyph-layout' or `extent-end-glyph-layout' instead.")
(defun set-extent-layout (extent layout)
- "" ;; obsoleteness info will be displayed, so no need for anything more.
+ ;; obsoleteness info will be displayed, so no need for docstring.
(set-extent-begin-glyph-layout extent layout))
(make-obsolete 'set-extent-layout
"use `set-extent-begin-glyph-layout' or `set-extent-end-glyph-layout' instead.")
＠＠ -245,7 +244,7 ＠＠
(define-obsolete-variable-alias 'x-screen-defaults 'default-x-frame-alist)
(defun x-create-screen (parms window-id)
- ""
+ ;; obsoleteness info will be displayed, so no need for docstring.
(if (not (eq 'x (device-type (selected-device))))
(error "Cannot create X frames on non-X device"))
(make-frame (append parms (list (list 'window-id window-id)))
--- src/lread.c.old
+++ src/lread.c
＠＠ -3142,7 +3142,7 ＠＠
Vload_file_name = Qnil;
DEFVAR_LISP ("load-read-function", &Vload_read_function /*
- "Function used by `load' and `eval-region' for reading expressions.
+Function used by `load' and `eval-region' for reading expressions.
The default is nil, which means use the function `read'.
*/ );
Vload_read_function = Qnil;
--- src/xselect.c.old
+++ src/xselect.c
＠＠ -1051,7 +1051,6 ＠＠
DEFUN ("x-selection-reply-timeout-internal", Fx_selection_reply_timeout_internal,
1, 1, 0, /*
-
*/
(arg))
{
--- src/fileio.c.old
+++ src/fileio.c
＠＠ -2455,7 +2455,7 ＠＠
}
DEFUN ("file-regular-p", Ffile_regular_p, 1, 1, 0, /*
- "Return t if file FILENAME is the name of a regular file.
+Return t if file FILENAME is the name of a regular file.
This is the sort of file that holds an ordinary stream of data bytes.
*/
(filename))
--- src/buffer.c.old
+++ src/buffer.c
＠＠ -2445,7 +2445,7 ＠＠
*/ );
DEFVAR_BUFFER_LOCAL ("buffer-file-type", buffer_file_type /*
- "Non-nil if the visited file is a binary file.
+Non-nil if the visited file is a binary file.
This variable is meaningful on MS-DOS and Windows NT.
On those systems, it is automatically local in every buffer.
On other systems, this variable is normally always nil.
--- src/callproc.c.old
+++ src/callproc.c
＠＠ -49,7 +49,7 ＠＠
#ifdef DOS_NT
/* When we are starting external processes we need to know whether they
take binary input (no conversion) or text input (\n is converted to
- \r\n). Similar for output: if newlines are written as \r\n then it's
+ \r\n). Similarly for output: if newlines are written as \r\n then it's
text process output, otherwise it's binary. */
Lisp_Object Vbinary_process_input;
Lisp_Object Vbinary_process_output;
--- src/device-x.c.old
+++ src/device-x.c
＠＠ -489,8 +489,8 ＠＠
depth = DefaultDepth(dpy, screen);
}
- /* If we've got the same visual as the default and its PseudoColor, check to see if the user
- specified that we need a private colormap */
+ /* If we've got the same visual as the default and it's PseudoColor,
+ check to see if the user specified that we need a private colormap */
if (visual == DefaultVisual(dpy, screen))
{
sprintf (buf1, "%s.privateColormap", app_name);
--- src/extents.c.old
+++ src/extents.c
＠＠ -4925,7 +4925,7 ＠＠
}
DEFUN ("set-extent-end-glyph", Fset_extent_end_glyph, 2, 3, 0, /*
-Display a bitmap, subwindow or string at the end of the EXTENT.
+Display a bitmap, subwindow or string at the end of EXTENT.
END-GLYPH must be a glyph object. The layout policy defaults to `text'.
*/
(extent, end_glyph, layout))
＠＠ -4937,22 +4937,22 ＠＠
Return the glyph object displayed at the beginning of EXTENT.
If there is none, nil is returned.
*/
- (extent_obj))
+ (extent))
{
- return extent_begin_glyph (decode_extent (extent_obj, 0));
+ return extent_begin_glyph (decode_extent (extent, 0));
}
DEFUN ("extent-end-glyph", Fextent_end_glyph, 1, 1, 0, /*
Return the glyph object displayed at the end of EXTENT.
If there is none, nil is returned.
*/
- (extent_obj))
+ (extent))
{
- return extent_end_glyph (decode_extent (extent_obj, 0));
+ return extent_end_glyph (decode_extent (extent, 0));
}
DEFUN ("set-extent-begin-glyph-layout", Fset_extent_begin_glyph_layout, 2, 2, 0, /*
-Set the layout policy of the given extent's begin glyph.
+Set the layout policy of EXTENT's begin glyph.
Access this using the `extent-begin-glyph-layout' function.
*/
(extent, layout))
＠＠ -4965,7 +4965,7 ＠＠
}
DEFUN ("set-extent-end-glyph-layout", Fset_extent_end_glyph_layout, 2, 2, 0, /*
-Set the layout policy of the given extent's end glyph.
+Set the layout policy of EXTENT's end glyph.
Access this using the `extent-end-glyph-layout' function.
*/
(extent, layout))
＠＠ -4978,7 +4978,7 ＠＠
}
DEFUN ("extent-begin-glyph-layout", Fextent_begin_glyph_layout, 1, 1, 0, /*
-Return the layout policy associated with the given extent's begin glyph.
+Return the layout policy associated with EXTENT's begin glyph.
Set this using the `set-extent-begin-glyph-layout' function.
*/
(extent))
＠＠ -4988,7 +4988,7 ＠＠
}
DEFUN ("extent-end-glyph-layout", Fextent_end_glyph_layout, 1, 1, 0, /*
-Return the layout policy associated with the given extent's end glyph.
+Return the layout policy associated with EXTENT's end glyph.
Set this using the `set-extent-end-glyph-layout' function.
*/
(extent))
＠＠ -5332,7 +5332,7 ＠＠
}
DEFUN ("extent-properties", Fextent_properties, 1, 1, 0, /*
-Return a property list of the attributes of the given extent.
+Return a property list of the attributes of EXTENT.
Do not modify this list; use `set-extent-property' instead.
*/
(extent))
＠＠ -5448,29 +5448,29 ＠＠
This is the same as `highlight-extent', except that it will work even
on extents without the `mouse-face' property.
*/
- (extent_obj, highlight_p))
+ (extent, highlight_p))
{
- if (NILP (extent_obj))
+ if (NILP (extent))
highlight_p = Qnil;
else
- XSETEXTENT (extent_obj, decode_extent (extent_obj, DE_MUST_BE_ATTACHED));
- do_highlight (extent_obj, !NILP (highlight_p));
+ XSETEXTENT (extent, decode_extent (extent, DE_MUST_BE_ATTACHED));
+ do_highlight (extent, !NILP (highlight_p));
return Qnil;
}
DEFUN ("highlight-extent", Fhighlight_extent, 1, 2, 0, /*
-Highlight the given extent, if it is highlightable
+Highlight EXTENT, if it is highlightable.
\(that is, if it has the `mouse-face' property).
If the second arg is non-nil, it will be highlighted, else dehighlighted.
Highlighted extents are displayed as if they were merged with the face
or faces specified by the `mouse-face' property.
*/
- (extent_obj, highlight_p))
+ (extent, highlight_p))
{
- if (EXTENTP (extent_obj) && NILP (extent_mouse_face (XEXTENT (extent_obj))))
+ if (EXTENTP (extent) && NILP (extent_mouse_face (XEXTENT (extent))))
return Qnil;
else
- return Fforce_highlight_extent (extent_obj, highlight_p);
+ return Fforce_highlight_extent (extent, highlight_p);
}
--- src/floatfns.c.old
+++ src/floatfns.c
＠＠ -929,6 +929,9 ＠＠
#endif /* FLOAT_CATCH_SIGILL */
+/* In C++, it is impossible to determine what type matherr expects
+ without some more configure magic.
+ We shouldn't be using matherr anyways - it's a non-standard SYSVism. */
#if defined (HAVE_MATHERR) && !defined(__cplusplus)
int
matherr (struct exception *x)
＠＠ -947,11 +950,11 ＠＠
: Qnil)));
switch (x->type)
{
- case DOMAIN: Fsignal (Qdomain_error, args); break;
- case SING: Fsignal (Qsingularity_error, args); break;
- case OVERFLOW: Fsignal (Qoverflow_error, args); break;
- case UNDERFLOW: Fsignal (Qunderflow_error, args); break;
- default: Fsignal (Qarith_error, args); break;
+ case DOMAIN: Fsignal (Qdomain_error, args); break;
+ case SING: Fsignal (Qsingularity_error, args); break;
+ case OVERFLOW: Fsignal (Qoverflow_error, args); break;
+ case UNDERFLOW: Fsignal (Qunderflow_error, args); break;
+ default: Fsignal (Qarith_error, args); break;
}
return 1; /* don't set errno or print a message */
}
--- src/glyphs.c.old
+++ src/glyphs.c
＠＠ -142,8 +142,8 ＠＠
return (decode_image_instantiator_format (format, ERROR_ME_NOT) != 0);
}
-DEFUN ("valid-image-instantiator-format-p",
- Fvalid_image_instantiator_format_p, 1, 1, 0, /*
+DEFUN ("valid-image-instantiator-format-p", Fvalid_image_instantiator_format_p,
+ 1, 1, 0, /*
Given an IMAGE-INSTANTIATOR-FORMAT, return non-nil if it is valid.
Valid formats are some subset of 'nothing, 'string, 'formatted-string,
'xpm, 'xbm, 'xface, 'gif, 'jpeg, 'png, 'tiff, 'cursor-font, 'font,
＠＠ -155,8 +155,8 ＠＠
Qt : Qnil;
}
-DEFUN ("image-instantiator-format-list",
- Fimage_instantiator_format_list, 0, 0, 0, /*
+DEFUN ("image-instantiator-format-list", Fimage_instantiator_format_list,
+ 0, 0, 0, /*
Return a list of valid image-instantiator formats.
*/
())
＠＠ -184,8 +184,8 ＠＠
return &decode_console_type (console_type, ERROR_ME)->image_conversion_list;
}
-DEFUN ("set-console-type-image-conversion-list",
- Fset_console_type_image_conversion_list, 2, 2, 0, /*
+DEFUN ("set-console-type-image-conversion-list", Fset_console_type_image_conversion_list,
+ 2, 2, 0, /*
Set the image-conversion-list for consoles of the given TYPE.
The image-conversion-list specifies how image instantiators that
are strings should be interpreted. Each element of the list should be
＠＠ -252,8 +252,8 ＠＠
return list;
}
-DEFUN ("console-type-image-conversion-list",
- Fconsole_type_image_conversion_list, 1, 1, 0, /*
+DEFUN ("console-type-image-conversion-list", Fconsole_type_image_conversion_list,
+ 1, 1, 0, /*
Return the image-conversion-list for devices of the given TYPE.
The image-conversion-list specifies how to interpret image string
instantiators for the specified console type. See
＠＠ -3143,7 +3143,7 ＠＠
IIFORMAT_VALID_KEYWORD (xpm, Q_data, check_valid_string);
IIFORMAT_VALID_KEYWORD (xpm, Q_file, check_valid_string);
IIFORMAT_VALID_KEYWORD (xpm, Q_color_symbols, check_valid_xpm_color_symbols);
-#endif
+#endif /* HAVE_XPM */
}
void
＠＠ -3207,7 +3207,7 ＠＠
\"foreground\" and \"background\" to be the colors of the `default' face.
*/ );
Vxpm_color_symbols = Qnil; /* initialized in x-faces.el */
-#endif
+#endif /* HAVE_XPM */
}
void
--- src/mule-charset.c.old
+++ src/mule-charset.c
＠＠ -816,8 +816,7 ＠＠
return new_charset;
}
-/* #### The defsubr for this is commented out at the moment but no
- reason why is given. */
+/* #### Reverse direction charsets not yet implemented. */
#if 0
DEFUN ("charset-reverse-direction-charset", Fcharset_reverse_direction_charset,
1, 1, 0, /*
