Commit 70da46c3 authored by Pavel Janík's avatar Pavel Janík

Change doc-string comments to `new style' [w/`doc:' keyword].

parent 3ab8acb9
2001-12-11 Pavel Jan,Bm(Bk <Pavel@Janik.cz>
* macros.c, msdos.c, w16select.c: Change doc-string comments to
`new style' [w/`doc:' keyword].
2001-12-10 Jason Rumney <jasonr@gnu.org>
* w32menu.c (w32_free_submenu_strings): Clear menu item struct
......
......@@ -56,13 +56,13 @@ extern Lisp_Object real_this_command;
Lisp_Object Fexecute_kbd_macro ();
DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 1, "P",
"Record subsequent keyboard input, defining a keyboard macro.\n\
The commands are recorded even as they are executed.\n\
Use \\[end-kbd-macro] to finish recording and make the macro available.\n\
Use \\[name-last-kbd-macro] to give it a permanent name.\n\
Non-nil arg (prefix arg) means append to last macro defined;\n\
this begins by re-executing that macro as if you typed it again.")
(append)
doc: /* Record subsequent keyboard input, defining a keyboard macro.
The commands are recorded even as they are executed.
Use \\[end-kbd-macro] to finish recording and make the macro available.
Use \\[name-last-kbd-macro] to give it a permanent name.
Non-nil arg (prefix arg) means append to last macro defined;
this begins by re-executing that macro as if you typed it again. */)
(append)
Lisp_Object append;
{
if (!NILP (current_kboard->defining_kbd_macro))
......@@ -129,16 +129,16 @@ this begins by re-executing that macro as if you typed it again.")
}
DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 1, "p",
"Finish defining a keyboard macro.\n\
The definition was started by \\[start-kbd-macro].\n\
The macro is now available for use via \\[call-last-kbd-macro],\n\
or it can be given a name with \\[name-last-kbd-macro] and then invoked\n\
under that name.\n\
\n\
With numeric arg, repeat macro now that many times,\n\
counting the definition just completed as the first repetition.\n\
An argument of zero means repeat until error.")
(repeat)
doc: /* Finish defining a keyboard macro.
The definition was started by \\[start-kbd-macro].
The macro is now available for use via \\[call-last-kbd-macro],
or it can be given a name with \\[name-last-kbd-macro] and then invoked
under that name.
With numeric arg, repeat macro now that many times,
counting the definition just completed as the first repetition.
An argument of zero means repeat until error. */)
(repeat)
Lisp_Object repeat;
{
if (NILP (current_kboard->defining_kbd_macro))
......@@ -210,8 +210,8 @@ finalize_kbd_macro_chars ()
DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
Scancel_kbd_macro_events, 0, 0, 0,
"Cancel the events added to a keyboard macro for this command.")
()
doc: /* Cancel the events added to a keyboard macro for this command. */)
()
{
current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end;
return Qnil;
......@@ -219,8 +219,8 @@ DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events,
DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event,
Sstore_kbd_macro_event, 1, 1, 0,
"Store EVENT into the keyboard macro being defined.")
(event)
doc: /* Store EVENT into the keyboard macro being defined. */)
(event)
Lisp_Object event;
{
store_kbd_macro_char (event);
......@@ -228,14 +228,14 @@ DEFUN ("store-kbd-macro-event", Fstore_kbd_macro_event,
}
DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro,
0, 1, "p",
"Call the last keyboard macro that you defined with \\[start-kbd-macro].\n\
\n\
A prefix argument serves as a repeat count. Zero means repeat until error.\n\
\n\
To make a macro permanent so you can call it even after\n\
defining others, use \\[name-last-kbd-macro].")
(prefix)
0, 1, "p",
doc: /* Call the last keyboard macro that you defined with \\[start-kbd-macro].
A prefix argument serves as a repeat count. Zero means repeat until error.
To make a macro permanent so you can call it even after
defining others, use \\[name-last-kbd-macro]. */)
(prefix)
Lisp_Object prefix;
{
/* Don't interfere with recognition of the previous command
......@@ -276,10 +276,10 @@ pop_kbd_macro (info)
}
DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 2, 0,
"Execute MACRO as string of editor command characters.\n\
If MACRO is a symbol, its function definition is used.\n\
COUNT is a repeat count, or nil for once, or 0 for infinite loop.")
(macro, count)
doc: /* Execute MACRO as string of editor command characters.
If MACRO is a symbol, its function definition is used.
COUNT is a repeat count, or nil for once, or 0 for infinite loop. */)
(macro, count)
Lisp_Object macro, count;
{
Lisp_Object final;
......@@ -354,14 +354,14 @@ syms_of_macros ()
defsubr (&Sstore_kbd_macro_event);
DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro,
"Non-nil while a keyboard macro is being defined. Don't set this!");
doc: /* Non-nil while a keyboard macro is being defined. Don't set this! */);
DEFVAR_LISP ("executing-macro", &Vexecuting_macro,
"Currently executing keyboard macro (string or vector); nil if none executing.");
doc: /* Currently executing keyboard macro (string or vector); nil if none executing. */);
DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro,
"Currently executing keyboard macro (string or vector); nil if none executing.");
doc: /* Currently executing keyboard macro (string or vector); nil if none executing. */);
DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro,
"Last kbd macro defined, as a string or vector; nil if none defined.");
doc: /* Last kbd macro defined, as a string or vector; nil if none defined. */);
}
......@@ -189,11 +189,11 @@ mouse_setup_buttons (int n_buttons)
DEFUN ("msdos-set-mouse-buttons", Fmsdos_set_mouse_buttons, Smsdos_set_mouse_buttons,
1, 1, "NSet number of mouse buttons to: ",
"Set the number of mouse buttons to use by Emacs.\n\
This is useful with mice that report the number of buttons inconsistently,\n\
e.g., if the number of buttons is reported as 3, but Emacs only sees 2 of\n\
them. This happens with wheeled mice on Windows 9X, for example.")
(nbuttons)
doc: /* Set the number of mouse buttons to use by Emacs.
This is useful with mice that report the number of buttons inconsistently,
e.g., if the number of buttons is reported as 3, but Emacs only sees 2 of
them. This happens with wheeled mice on Windows 9X, for example. */)
(nbuttons)
Lisp_Object nbuttons;
{
int n;
......@@ -2290,7 +2290,7 @@ IT_set_terminal_window (int foo)
default colors for newly-created frames. */
DEFUN ("msdos-remember-default-colors", Fmsdos_remember_default_colors,
Smsdos_remember_default_colors, 1, 1, 0,
"Remember the screen colors of the current frame.")
doc: /* Remember the screen colors of the current frame. */)
(frame)
Lisp_Object frame;
{
......@@ -3124,9 +3124,9 @@ int total_doskeys; /* Total number of elements stored into recent_doskeys */
Lisp_Object recent_doskeys; /* A vector, holding the last 100 keystrokes */
DEFUN ("recent-doskeys", Frecent_doskeys, Srecent_doskeys, 0, 0, 0,
"Return vector of last 100 keyboard input values seen in dos_rawgetc.\n\
Each input key receives two values in this vector: first the ASCII code,\n\
and then the scan code.")
doc: /* Return vector of last 100 keyboard input values seen in dos_rawgetc.
Each input key receives two values in this vector: first the ASCII code,
and then the scan code. */)
()
{
Lisp_Object *keys = XVECTOR (recent_doskeys)->contents;
......@@ -4336,9 +4336,9 @@ int _rename(const char *old, const char *new)
#endif /* __DJGPP__ == 2 && __DJGPP_MINOR__ == 0 */
DEFUN ("msdos-long-file-names", Fmsdos_long_file_names, Smsdos_long_file_names,
0, 0, 0,
"Return non-nil if long file names are supported on MSDOS.")
()
0, 0, 0,
doc: /* Return non-nil if long file names are supported on MSDOS. */)
()
{
return (_USE_LFN ? Qt : Qnil);
}
......@@ -4369,11 +4369,11 @@ msdos_downcase_filename (p)
DEFUN ("msdos-downcase-filename", Fmsdos_downcase_filename, Smsdos_downcase_filename,
1, 1, 0,
"Convert alphabetic characters in FILENAME to lower case and return that.\n\
When long filenames are supported, doesn't change FILENAME.\n\
If FILENAME is not a string, returns nil.\n\
The argument object is never altered--the value is a copy.")
(filename)
doc: /* Convert alphabetic characters in FILENAME to lower case and return that.
When long filenames are supported, doesn't change FILENAME.
If FILENAME is not a string, returns nil.
The argument object is never altered--the value is a copy. */)
(filename)
Lisp_Object filename;
{
Lisp_Object tem;
......@@ -5297,13 +5297,13 @@ syms_of_msdos ()
help_echo_pos = -1;
DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
"List of directories to search for bitmap files for X.");
doc: /* List of directories to search for bitmap files for X. */);
Vx_bitmap_file_path = decode_env_path ((char *) 0, ".");
DEFVAR_BOOL ("x-stretch-cursor", &x_stretch_cursor_p,
"*Non-nil means draw block cursor as wide as the glyph under it.\n\
For example, if a block cursor is over a tab, it will be drawn as\n\
wide as that tab on the display. (No effect on MS-DOS.)");
doc: /* *Non-nil means draw block cursor as wide as the glyph under it.
For example, if a block cursor is over a tab, it will be drawn as
wide as that tab on the display. (No effect on MS-DOS.) */);
x_stretch_cursor_p = 0;
/* The following two are from xfns.c: */
......@@ -5315,15 +5315,15 @@ wide as that tab on the display. (No effect on MS-DOS.)");
staticpro (&Qreverse);
DEFVAR_LISP ("dos-unsupported-char-glyph", &Vdos_unsupported_char_glyph,
"*Glyph to display instead of chars not supported by current codepage.\n\
\n\
This variable is used only by MSDOS terminals.");
Vdos_unsupported_char_glyph = '\177';
doc: /* *Glyph to display instead of chars not supported by current codepage.
This variable is used only by MSDOS terminals. */);
Vdos_unsupported_char_glyph = '\177';
#endif
#ifndef subprocesses
DEFVAR_BOOL ("delete-exited-processes", &delete_exited_processes,
"*Non-nil means delete processes immediately when they exit.\n\
nil means don't delete them until `list-processes' is run.");
doc: /* *Non-nil means delete processes immediately when they exit.
nil means don't delete them until `list-processes' is run. */);
delete_exited_processes = 0;
#endif
......
......@@ -481,9 +481,9 @@ static char system_error_msg[] =
"(Clipboard interface failure; clipboard data not set.)";
DEFUN ("w16-set-clipboard-data", Fw16_set_clipboard_data, Sw16_set_clipboard_data, 1, 2, 0,
"This sets the clipboard data to the given text.")
(string, frame)
Lisp_Object string, frame;
doc: /* This sets the clipboard data to the given text. */)
(string, frame)
Lisp_Object string, frame;
{
unsigned ok = 1, put_status = 0;
int nbytes;
......@@ -592,7 +592,7 @@ DEFUN ("w16-set-clipboard-data", Fw16_set_clipboard_data, Sw16_set_clipboard_dat
}
DEFUN ("w16-get-clipboard-data", Fw16_get_clipboard_data, Sw16_get_clipboard_data, 0, 1, 0,
"This gets the clipboard data in text format.")
doc: /* This gets the clipboard data in text format. */)
(frame)
Lisp_Object frame;
{
......@@ -691,14 +691,14 @@ DEFUN ("w16-get-clipboard-data", Fw16_get_clipboard_data, Sw16_get_clipboard_dat
/* Support checking for a clipboard selection. */
DEFUN ("x-selection-exists-p", Fx_selection_exists_p, Sx_selection_exists_p,
0, 1, 0,
"Whether there is an owner for the given X Selection.\n\
The arg should be the name of the selection in question, typically one of\n\
the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.\n\
\(Those are literal upper-case symbol names, since that's what X expects.)\n\
For convenience, the symbol nil is the same as `PRIMARY',\n\
and t is the same as `SECONDARY'.")
(selection)
0, 1, 0,
doc: /* Whether there is an owner for the given X Selection.
The arg should be the name of the selection in question, typically one of
the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
\(Those are literal upper-case symbol names, since that's what X expects.)
For convenience, the symbol nil is the same as `PRIMARY',
and t is the same as `SECONDARY'. */)
(selection)
Lisp_Object selection;
{
CHECK_SYMBOL (selection);
......@@ -741,18 +741,18 @@ syms_of_win16select ()
defsubr (&Sx_selection_exists_p);
DEFVAR_LISP ("selection-coding-system", &Vselection_coding_system,
"Coding system for communicating with other X clients.\n\
When sending or receiving text via cut_buffer, selection, and clipboard,\n\
the text is encoded or decoded by this coding system.\n\
A default value is `iso-latin-1-dos'");
doc: /* Coding system for communicating with other X clients.
When sending or receiving text via cut_buffer, selection, and clipboard,
the text is encoded or decoded by this coding system.
A default value is `iso-latin-1-dos'. */);
Vselection_coding_system=intern ("iso-latin-1-dos");
DEFVAR_LISP ("next-selection-coding-system", &Vnext_selection_coding_system,
"Coding system for the next communication with other X clients.\n\
Usually, `selection-coding-system' is used for communicating with\n\
other X clients. But, if this variable is set, it is used for the\n\
next communication only. After the communication, this variable is\n\
set to nil.");
doc: /* Coding system for the next communication with other X clients.
Usually, `selection-coding-system' is used for communicating with
other X clients. But, if this variable is set, it is used for the
next communication only. After the communication, this variable is
set to nil. */);
Vnext_selection_coding_system = Qnil;
QPRIMARY = intern ("PRIMARY"); staticpro (&QPRIMARY);
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment