diff options
| author | Paul Eggert | 2015-09-16 16:23:55 -0700 |
|---|---|---|
| committer | Paul Eggert | 2015-09-16 16:26:07 -0700 |
| commit | 032ce1c7d1afb23e6b1265d91c5a97e45de071ce (patch) | |
| tree | dab9ca1e540c23aeb15ee9ef8fdc6b78e1929b6d /src/menu.c | |
| parent | 309d39b832ccd72f99cc726090ff03f7e146948d (diff) | |
| download | emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.tar.gz emacs-032ce1c7d1afb23e6b1265d91c5a97e45de071ce.zip | |
Omit unnecessary \ before paren in C docstrings
Although \( is needed in docstrings in Elisp code, it is not needed in
docstrings in C code, since C function definitiions do not start with
a parenthesis. The backslashes made the docstrings a bit harder to
read and to format in columns. Also, some C docstrings had ( in
column 1 and this did not appear to be causing any problems. So,
simplify C docstrings by replacing \( with ( and \) with ).
Diffstat (limited to 'src/menu.c')
| -rw-r--r-- | src/menu.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/menu.c b/src/menu.c index e36fe260f24..dc82809629a 100644 --- a/src/menu.c +++ b/src/menu.c | |||
| @@ -1129,7 +1129,7 @@ If POSITION is t, it means to use the current mouse position. | |||
| 1129 | MENU is a specifier for a menu. For the simplest case, MENU is a keymap. | 1129 | MENU is a specifier for a menu. For the simplest case, MENU is a keymap. |
| 1130 | The menu items come from key bindings that have a menu string as well as | 1130 | The menu items come from key bindings that have a menu string as well as |
| 1131 | a definition; actually, the "definition" in such a key binding looks like | 1131 | a definition; actually, the "definition" in such a key binding looks like |
| 1132 | \(STRING . REAL-DEFINITION). To give the menu a title, put a string into | 1132 | (STRING . REAL-DEFINITION). To give the menu a title, put a string into |
| 1133 | the keymap as a top-level element. | 1133 | the keymap as a top-level element. |
| 1134 | 1134 | ||
| 1135 | If REAL-DEFINITION is nil, that puts a nonselectable string in the menu. | 1135 | If REAL-DEFINITION is nil, that puts a nonselectable string in the menu. |
| @@ -1491,7 +1491,7 @@ The return value is VALUE from the chosen item. | |||
| 1491 | An ITEM may also be just a string--that makes a nonselectable item. | 1491 | An ITEM may also be just a string--that makes a nonselectable item. |
| 1492 | An ITEM may also be nil--that means to put all preceding items | 1492 | An ITEM may also be nil--that means to put all preceding items |
| 1493 | on the left of the dialog box and all following items on the right. | 1493 | on the left of the dialog box and all following items on the right. |
| 1494 | \(By default, approximately half appear on each side.) | 1494 | (By default, approximately half appear on each side.) |
| 1495 | 1495 | ||
| 1496 | If HEADER is non-nil, the frame title for the box is "Information", | 1496 | If HEADER is non-nil, the frame title for the box is "Information", |
| 1497 | otherwise it is "Question". | 1497 | otherwise it is "Question". |