diff options
| author | Juanma Barranquero | 2005-07-01 14:13:12 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2005-07-01 14:13:12 +0000 |
| commit | 173569aaca3cba48898cf22372074c464b703b5a (patch) | |
| tree | c53b0bbc2cd69c3392dbfc563fd6ae6254dd4a19 | |
| parent | 12d6b12433b560d4e82833a6c5f2dfbc4763c10c (diff) | |
| download | emacs-173569aaca3cba48898cf22372074c464b703b5a.tar.gz emacs-173569aaca3cba48898cf22372074c464b703b5a.zip | |
(flymake-find-possible-master-files, flymake-master-file-compare,
flymake-get-line-err-count, flymake-highlight-line,
flymake-gui-warnings-enabled): Fix typos in docstrings.
(flymake-parse-line, flymake-get-project-include-dirs-function,
flymake-get-prev-err-line-no, flymake-goto-prev-error): Doc fixes.
(flymake-get-project-include-dirs-function, flymake-make-err-menu-data): Improve
argument/docstring consistency.
| -rw-r--r-- | lisp/progmodes/flymake.el | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index c47f2e34cd2..112c725f6d9 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el | |||
| @@ -390,7 +390,7 @@ Return t if so, nil if not." | |||
| 390 | 390 | ||
| 391 | (defun flymake-find-possible-master-files (file-name master-file-dirs masks) | 391 | (defun flymake-find-possible-master-files (file-name master-file-dirs masks) |
| 392 | "Find (by name and location) all possible master files. | 392 | "Find (by name and location) all possible master files. |
| 393 | Master files are .cpp and .c for and .h. Files are searched for | 393 | Master files are .cpp and .c for and .h. Files are searched for |
| 394 | starting from the .h directory and max max-level parent dirs. | 394 | starting from the .h directory and max max-level parent dirs. |
| 395 | File contents are not checked." | 395 | File contents are not checked." |
| 396 | (let* ((dirs master-file-dirs) | 396 | (let* ((dirs master-file-dirs) |
| @@ -423,9 +423,9 @@ File contents are not checked." | |||
| 423 | files)) | 423 | files)) |
| 424 | 424 | ||
| 425 | (defun flymake-master-file-compare (file-one file-two) | 425 | (defun flymake-master-file-compare (file-one file-two) |
| 426 | "Compare two files speccified by FILE-ONE and FILE-TWO. | 426 | "Compare two files specified by FILE-ONE and FILE-TWO. |
| 427 | This function is used in sort to move most possible file names | 427 | This function is used in sort to move most possible file names |
| 428 | to the beginning of the list (File.h -> File.cpp moved to top." | 428 | to the beginning of the list (File.h -> File.cpp moved to top)." |
| 429 | (and (equal (file-name-sans-extension flymake-included-file-name) | 429 | (and (equal (file-name-sans-extension flymake-included-file-name) |
| 430 | (file-name-sans-extension (file-name-nondirectory file-one))) | 430 | (file-name-sans-extension (file-name-nondirectory file-one))) |
| 431 | (not (equal file-one file-two)))) | 431 | (not (equal file-one file-two)))) |
| @@ -750,7 +750,7 @@ It's flymake process filter." | |||
| 750 | 750 | ||
| 751 | (defun flymake-get-line-err-count (line-err-info-list type) | 751 | (defun flymake-get-line-err-count (line-err-info-list type) |
| 752 | "Return number of errors of specified TYPE. | 752 | "Return number of errors of specified TYPE. |
| 753 | Value of TYPE is eigher e or w." | 753 | Value of TYPE is either \"e\" or \"w\"." |
| 754 | (let* ((idx 0) | 754 | (let* ((idx 0) |
| 755 | (count (length line-err-info-list)) | 755 | (count (length line-err-info-list)) |
| 756 | (err-count 0)) | 756 | (err-count 0)) |
| @@ -859,7 +859,7 @@ Return t if it has at least one flymake overlay, nil if no overlay." | |||
| 859 | 859 | ||
| 860 | (defun flymake-highlight-line (line-no line-err-info-list) | 860 | (defun flymake-highlight-line (line-no line-err-info-list) |
| 861 | "Highlight line LINE-NO in current buffer. | 861 | "Highlight line LINE-NO in current buffer. |
| 862 | Perhaps use text from LINE-ERR-INFO-ILST to enhance highlighting." | 862 | Perhaps use text from LINE-ERR-INFO-LIST to enhance highlighting." |
| 863 | (goto-line line-no) | 863 | (goto-line line-no) |
| 864 | (let* ((line-beg (flymake-line-beginning-position)) | 864 | (let* ((line-beg (flymake-line-beginning-position)) |
| 865 | (line-end (flymake-line-end-position)) | 865 | (line-end (flymake-line-end-position)) |
| @@ -995,8 +995,8 @@ from compile.el") | |||
| 995 | ;;) | 995 | ;;) |
| 996 | 996 | ||
| 997 | (defun flymake-parse-line (line) | 997 | (defun flymake-parse-line (line) |
| 998 | "Parse LINE to see if it is an error of warning. | 998 | "Parse LINE to see if it is an error or warning. |
| 999 | Return its components if so, nil if no." | 999 | Return its components if so, nil otherwise." |
| 1000 | (let ((raw-file-name nil) | 1000 | (let ((raw-file-name nil) |
| 1001 | (line-no 0) | 1001 | (line-no 0) |
| 1002 | (err-type "e") | 1002 | (err-type "e") |
| @@ -1110,7 +1110,7 @@ For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'." | |||
| 1110 | inc-dirs))) | 1110 | inc-dirs))) |
| 1111 | 1111 | ||
| 1112 | (defcustom flymake-get-project-include-dirs-function 'flymake-get-project-include-dirs-imp | 1112 | (defcustom flymake-get-project-include-dirs-function 'flymake-get-project-include-dirs-imp |
| 1113 | "Function used to get project inc dirs, one paramater: basedir name." | 1113 | "Function used to get project include dirs, one parameter: basedir name." |
| 1114 | :group 'flymake | 1114 | :group 'flymake |
| 1115 | :type 'function) | 1115 | :type 'function) |
| 1116 | 1116 | ||
| @@ -1139,7 +1139,7 @@ For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'." | |||
| 1139 | include-dirs)) | 1139 | include-dirs)) |
| 1140 | 1140 | ||
| 1141 | (defun flymake-find-file (rel-file-name include-dirs) | 1141 | (defun flymake-find-file (rel-file-name include-dirs) |
| 1142 | "Iterate through include-dirs to find file REL-FILE-NAME. | 1142 | "Iterate through INCLUDE-DIRS to find file REL-FILE-NAME. |
| 1143 | Return first 'INCLUDE-DIRS/REL-FILE-NAME' that exists, or just REL-FILE-NAME if not." | 1143 | Return first 'INCLUDE-DIRS/REL-FILE-NAME' that exists, or just REL-FILE-NAME if not." |
| 1144 | (let* ((count (length include-dirs)) | 1144 | (let* ((count (length include-dirs)) |
| 1145 | (idx 0) | 1145 | (idx 0) |
| @@ -1366,7 +1366,7 @@ Return first 'INCLUDE-DIRS/REL-FILE-NAME' that exists, or just REL-FILE-NAME if | |||
| 1366 | (flymake-log 1 "no errors for line %d" line-no)))) | 1366 | (flymake-log 1 "no errors for line %d" line-no)))) |
| 1367 | 1367 | ||
| 1368 | (defun flymake-make-err-menu-data (line-no line-err-info-list) | 1368 | (defun flymake-make-err-menu-data (line-no line-err-info-list) |
| 1369 | "Make a (menu-title (item-title item-action)*) list with errors/warnings from line-err-info." | 1369 | "Make a (menu-title (item-title item-action)*) list with errors/warnings from LINE-ERR-INFO-LIST." |
| 1370 | (let* ((menu-items nil)) | 1370 | (let* ((menu-items nil)) |
| 1371 | (when line-err-info-list | 1371 | (when line-err-info-list |
| 1372 | (let* ((count (length line-err-info-list)) | 1372 | (let* ((count (length line-err-info-list)) |
| @@ -1431,7 +1431,7 @@ Return first 'INCLUDE-DIRS/REL-FILE-NAME' that exists, or just REL-FILE-NAME if | |||
| 1431 | (message-box warning)) | 1431 | (message-box warning)) |
| 1432 | 1432 | ||
| 1433 | (defcustom flymake-gui-warnings-enabled t | 1433 | (defcustom flymake-gui-warnings-enabled t |
| 1434 | "Enables/disables gui warnings." | 1434 | "Enables/disables GUI warnings." |
| 1435 | :group 'flymake | 1435 | :group 'flymake |
| 1436 | :type 'boolean) | 1436 | :type 'boolean) |
| 1437 | 1437 | ||
| @@ -1557,7 +1557,7 @@ With arg, turn Flymake mode on if and only if arg is positive." | |||
| 1557 | (flymake-er-get-line (nth idx err-info-list)))))) | 1557 | (flymake-er-get-line (nth idx err-info-list)))))) |
| 1558 | 1558 | ||
| 1559 | (defun flymake-get-prev-err-line-no (err-info-list line-no) | 1559 | (defun flymake-get-prev-err-line-no (err-info-list line-no) |
| 1560 | "Return prev line with error." | 1560 | "Return previous line with error." |
| 1561 | (when err-info-list | 1561 | (when err-info-list |
| 1562 | (let* ((count (length err-info-list))) | 1562 | (let* ((count (length err-info-list))) |
| 1563 | (while (and (> count 0) (<= line-no (flymake-er-get-line (nth (1- count) err-info-list)))) | 1563 | (while (and (> count 0) (<= line-no (flymake-er-get-line (nth (1- count) err-info-list)))) |
| @@ -1587,7 +1587,7 @@ With arg, turn Flymake mode on if and only if arg is positive." | |||
| 1587 | (flymake-log 1 "no errors in current buffer")))) | 1587 | (flymake-log 1 "no errors in current buffer")))) |
| 1588 | 1588 | ||
| 1589 | (defun flymake-goto-prev-error () | 1589 | (defun flymake-goto-prev-error () |
| 1590 | "Go to prev error in err ring." | 1590 | "Go to previous error in err ring." |
| 1591 | (interactive) | 1591 | (interactive) |
| 1592 | (let ((line-no (flymake-get-prev-err-line-no flymake-err-info (flymake-current-line-no)))) | 1592 | (let ((line-no (flymake-get-prev-err-line-no flymake-err-info (flymake-current-line-no)))) |
| 1593 | (when (not line-no) | 1593 | (when (not line-no) |