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/fileio.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/fileio.c')
| -rw-r--r-- | src/fileio.c | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/fileio.c b/src/fileio.c index 69933ccd40b..e4b255a53ac 100644 --- a/src/fileio.c +++ b/src/fileio.c | |||
| @@ -451,7 +451,7 @@ DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory, | |||
| 451 | A `directly usable' directory name is one that may be used without the | 451 | A `directly usable' directory name is one that may be used without the |
| 452 | intervention of any file handler. | 452 | intervention of any file handler. |
| 453 | If FILENAME is a directly usable file itself, return | 453 | If FILENAME is a directly usable file itself, return |
| 454 | \(file-name-directory FILENAME). | 454 | (file-name-directory FILENAME). |
| 455 | If FILENAME refers to a file which is not accessible from a local process, | 455 | If FILENAME refers to a file which is not accessible from a local process, |
| 456 | then this should return nil. | 456 | then this should return nil. |
| 457 | The `call-process' and `start-process' functions use this function to | 457 | The `call-process' and `start-process' functions use this function to |
| @@ -742,7 +742,7 @@ DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0, | |||
| 742 | doc: /* Generate temporary file name (string) starting with PREFIX (a string). | 742 | doc: /* Generate temporary file name (string) starting with PREFIX (a string). |
| 743 | The Emacs process number forms part of the result, so there is no | 743 | The Emacs process number forms part of the result, so there is no |
| 744 | danger of generating a name being used by another Emacs process | 744 | danger of generating a name being used by another Emacs process |
| 745 | \(so long as only a single host can access the containing directory...). | 745 | (so long as only a single host can access the containing directory...). |
| 746 | 746 | ||
| 747 | This function tries to choose a name that has no existing file. | 747 | This function tries to choose a name that has no existing file. |
| 748 | For this to work, PREFIX should be an absolute file name. | 748 | For this to work, PREFIX should be an absolute file name. |
| @@ -758,7 +758,7 @@ normally use `make-temp-file' instead. */) | |||
| 758 | DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, | 758 | DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, |
| 759 | doc: /* Convert filename NAME to absolute, and canonicalize it. | 759 | doc: /* Convert filename NAME to absolute, and canonicalize it. |
| 760 | Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative | 760 | Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative |
| 761 | \(does not start with slash or tilde); both the directory name and | 761 | (does not start with slash or tilde); both the directory name and |
| 762 | a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or | 762 | a directory's file name are accepted. If DEFAULT-DIRECTORY is nil or |
| 763 | missing, the current buffer's value of `default-directory' is used. | 763 | missing, the current buffer's value of `default-directory' is used. |
| 764 | NAME should be a string that is a valid file name for the underlying | 764 | NAME should be a string that is a valid file name for the underlying |
| @@ -776,8 +776,8 @@ See also the function `substitute-in-file-name'. | |||
| 776 | 776 | ||
| 777 | For technical reasons, this function can return correct but | 777 | For technical reasons, this function can return correct but |
| 778 | non-intuitive results for the root directory; for instance, | 778 | non-intuitive results for the root directory; for instance, |
| 779 | \(expand-file-name ".." "/") returns "/..". For this reason, use | 779 | (expand-file-name ".." "/") returns "/..". For this reason, use |
| 780 | \(directory-file-name (file-name-directory dirname)) to traverse a | 780 | (directory-file-name (file-name-directory dirname)) to traverse a |
| 781 | filesystem tree, not (expand-file-name ".." dirname). */) | 781 | filesystem tree, not (expand-file-name ".." dirname). */) |
| 782 | (Lisp_Object name, Lisp_Object default_directory) | 782 | (Lisp_Object name, Lisp_Object default_directory) |
| 783 | { | 783 | { |
| @@ -1460,7 +1460,7 @@ filesystem tree, not (expand-file-name ".." dirname). */) | |||
| 1460 | DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, | 1460 | DEAFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0, |
| 1461 | "Convert FILENAME to absolute, and canonicalize it.\n\ | 1461 | "Convert FILENAME to absolute, and canonicalize it.\n\ |
| 1462 | Second arg DEFAULT is directory to start with if FILENAME is relative\n\ | 1462 | Second arg DEFAULT is directory to start with if FILENAME is relative\n\ |
| 1463 | \(does not start with slash); if DEFAULT is nil or missing,\n\ | 1463 | (does not start with slash); if DEFAULT is nil or missing,\n\ |
| 1464 | the current buffer's value of default-directory is used.\n\ | 1464 | the current buffer's value of default-directory is used.\n\ |
| 1465 | Filenames containing `.' or `..' as components are simplified;\n\ | 1465 | Filenames containing `.' or `..' as components are simplified;\n\ |
| 1466 | initial `~/' expands to your home directory.\n\ | 1466 | initial `~/' expands to your home directory.\n\ |
| @@ -2469,7 +2469,7 @@ Use `file-symlink-p' to test for such links. */) | |||
| 2469 | DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0, | 2469 | DEFUN ("file-executable-p", Ffile_executable_p, Sfile_executable_p, 1, 1, 0, |
| 2470 | doc: /* Return t if FILENAME can be executed by you. | 2470 | doc: /* Return t if FILENAME can be executed by you. |
| 2471 | For a directory, this means you can access files in that directory. | 2471 | For a directory, this means you can access files in that directory. |
| 2472 | \(It is generally better to use `file-accessible-directory-p' for that | 2472 | (It is generally better to use `file-accessible-directory-p' for that |
| 2473 | purpose, though.) */) | 2473 | purpose, though.) */) |
| 2474 | (Lisp_Object filename) | 2474 | (Lisp_Object filename) |
| 2475 | { | 2475 | { |
| @@ -5306,8 +5306,8 @@ DEFUN ("set-visited-file-modtime", Fset_visited_file_modtime, | |||
| 5306 | Useful if the buffer was not read from the file normally | 5306 | Useful if the buffer was not read from the file normally |
| 5307 | or if the file itself has been changed for some known benign reason. | 5307 | or if the file itself has been changed for some known benign reason. |
| 5308 | An argument specifies the modification time value to use | 5308 | An argument specifies the modification time value to use |
| 5309 | \(instead of that of the visited file), in the form of a list | 5309 | (instead of that of the visited file), in the form of a list |
| 5310 | \(HIGH LOW USEC PSEC) or an integer flag as returned by | 5310 | (HIGH LOW USEC PSEC) or an integer flag as returned by |
| 5311 | `visited-file-modtime'. */) | 5311 | `visited-file-modtime'. */) |
| 5312 | (Lisp_Object time_flag) | 5312 | (Lisp_Object time_flag) |
| 5313 | { | 5313 | { |