diff options
| author | Juanma Barranquero | 2006-12-03 21:29:14 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2006-12-03 21:29:14 +0000 |
| commit | 7977c946cf76960847b982720c983d8d48bc99bc (patch) | |
| tree | 31b97d18903cf99d1ed56c5ffdaabb81fac3c614 | |
| parent | d166d7c41bdfe552bb03b7962732bb84747173d3 (diff) | |
| download | emacs-7977c946cf76960847b982720c983d8d48bc99bc.tar.gz emacs-7977c946cf76960847b982720c983d8d48bc99bc.zip | |
(is-windows, ada-find-in-src-path): Doc fixes.
(ada-xref-pos-ring-max, ada-xref-project-files, ada-xref-initialize,
ada-prj-default-comp-cmd, ada-quote-cmd, ada-compile-current):
Fix typos in docstrings.
| -rw-r--r-- | lisp/ChangeLog | 7 | ||||
| -rw-r--r-- | lisp/progmodes/ada-xref.el | 39 |
2 files changed, 26 insertions, 20 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 2902d6cb1f6..f62da47498e 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,10 @@ | |||
| 1 | 2006-12-03 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * progmodes/ada-xref.el (is-windows, ada-find-in-src-path): Doc fixes. | ||
| 4 | (ada-xref-pos-ring-max, ada-xref-project-files, ada-xref-initialize) | ||
| 5 | (ada-prj-default-comp-cmd, ada-quote-cmd, ada-compile-current): | ||
| 6 | Fix typos in docstrings. | ||
| 7 | |||
| 1 | 2006-12-03 Glenn Morris <rgm@gnu.org> | 8 | 2006-12-03 Glenn Morris <rgm@gnu.org> |
| 2 | 9 | ||
| 3 | * progmodes/cc-align.el | 10 | * progmodes/cc-align.el |
diff --git a/lisp/progmodes/ada-xref.el b/lisp/progmodes/ada-xref.el index 6c59560094a..fc8b4cf3727 100644 --- a/lisp/progmodes/ada-xref.el +++ b/lisp/progmodes/ada-xref.el | |||
| @@ -117,7 +117,7 @@ the filename at the end. This is the same syntax as in the project file." | |||
| 117 | " ${comp_opt}") | 117 | " ${comp_opt}") |
| 118 | "*Default command to be used to compile a single file. | 118 | "*Default command to be used to compile a single file. |
| 119 | Emacs will substitute the current filename for ${full_current}, or add | 119 | Emacs will substitute the current filename for ${full_current}, or add |
| 120 | the filename at the end. This is the same syntax as in the project file." | 120 | the filename at the end. This is the same syntax as in the project file." |
| 121 | :type 'string :group 'ada) | 121 | :type 'string :group 'ada) |
| 122 | 122 | ||
| 123 | (defcustom ada-prj-default-debugger "${cross_prefix}gdb" | 123 | (defcustom ada-prj-default-debugger "${cross_prefix}gdb" |
| @@ -148,7 +148,7 @@ Otherwise, ask the user for the name of the project file to use." | |||
| 148 | :type 'boolean :group 'ada) | 148 | :type 'boolean :group 'ada) |
| 149 | 149 | ||
| 150 | (defconst is-windows (memq system-type (quote (windows-nt))) | 150 | (defconst is-windows (memq system-type (quote (windows-nt))) |
| 151 | "True if we are running on Windows NT or Windows 95.") | 151 | "True if we are running on Windows.") |
| 152 | 152 | ||
| 153 | (defcustom ada-tight-gvd-integration nil | 153 | (defcustom ada-tight-gvd-integration nil |
| 154 | "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging. | 154 | "*If non-nil, a new Emacs frame will be swallowed in GVD when debugging. |
| @@ -208,7 +208,7 @@ we need to use `/d' or the drive is never changed.") | |||
| 208 | \"&&\" for now.") | 208 | \"&&\" for now.") |
| 209 | 209 | ||
| 210 | (defconst ada-xref-pos-ring-max 16 | 210 | (defconst ada-xref-pos-ring-max 16 |
| 211 | "Number of positions kept in the list ada-xref-pos-ring.") | 211 | "Number of positions kept in the list `ada-xref-pos-ring'.") |
| 212 | 212 | ||
| 213 | (defvar ada-operator-re | 213 | (defvar ada-operator-re |
| 214 | "\\+\\|-\\|/\\|\\*\\*\\|\\*\\|=\\|&\\|abs\\|mod\\|rem\\|and\\|not\\|or\\|xor\\|<=\\|<\\|>=\\|>" | 214 | "\\+\\|-\\|/\\|\\*\\*\\|\\*\\|=\\|&\\|abs\\|mod\\|rem\\|and\\|not\\|or\\|xor\\|<=\\|<\\|>=\\|>" |
| @@ -218,11 +218,11 @@ we need to use `/d' or the drive is never changed.") | |||
| 218 | "Associative list of project files with properties. | 218 | "Associative list of project files with properties. |
| 219 | It has the format: (project project ...) | 219 | It has the format: (project project ...) |
| 220 | A project has the format: (project-file . project-plist) | 220 | A project has the format: (project-file . project-plist) |
| 221 | \(See 'apropos plist' for operations on property lists). See | 221 | \(See 'apropos plist' for operations on property lists). |
| 222 | ada-xref-set-default-prj-values for the list of valid properties. The | 222 | See `ada-xref-set-default-prj-values' for the list of valid properties. |
| 223 | current project is retrieved with ada-xref-current-project. Properties | 223 | The current project is retrieved with `ada-xref-current-project'. |
| 224 | are retrieved with ada-xref-get-project-field, set with | 224 | Properties are retrieved with `ada-xref-get-project-field', set with |
| 225 | ada-xref-set-project-field. If project properties are accessed with no | 225 | `ada-xref-set-project-field'. If project properties are accessed with no |
| 226 | project file, a (nil . default-properties) entry is created.") | 226 | project file, a (nil . default-properties) entry is created.") |
| 227 | 227 | ||
| 228 | 228 | ||
| @@ -257,7 +257,7 @@ project file, a (nil . default-properties) entry is created.") | |||
| 257 | ;; ----------------------------------------------------------------------- | 257 | ;; ----------------------------------------------------------------------- |
| 258 | 258 | ||
| 259 | (defun ada-quote-cmd (cmd) | 259 | (defun ada-quote-cmd (cmd) |
| 260 | "Duplicate all \\ characters in CMD so that it can be passed to `compile'." | 260 | "Duplicate all `\\' characters in CMD so that it can be passed to `compile'." |
| 261 | (mapconcat 'identity (split-string cmd "\\\\") "\\\\")) | 261 | (mapconcat 'identity (split-string cmd "\\\\") "\\\\")) |
| 262 | 262 | ||
| 263 | (defun ada-find-executable (exec-name) | 263 | (defun ada-find-executable (exec-name) |
| @@ -418,8 +418,8 @@ replaced by the name including the extension." | |||
| 418 | Project variables are substituted. | 418 | Project variables are substituted. |
| 419 | 419 | ||
| 420 | Note that for src_dir and obj_dir, you should rather use | 420 | Note that for src_dir and obj_dir, you should rather use |
| 421 | `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field' which will in | 421 | `ada-xref-get-src-dir-field' or `ada-xref-get-obj-dir-field' |
| 422 | addition return the default paths." | 422 | which will in addition return the default paths." |
| 423 | 423 | ||
| 424 | (let* ((project-plist (cdr (ada-xref-current-project))) | 424 | (let* ((project-plist (cdr (ada-xref-current-project))) |
| 425 | value) | 425 | value) |
| @@ -1166,7 +1166,7 @@ If ARG is not nil, ask for user confirmation." | |||
| 1166 | "Recompile the current file. | 1166 | "Recompile the current file. |
| 1167 | If ARG is not nil, ask for user confirmation of the command. | 1167 | If ARG is not nil, ask for user confirmation of the command. |
| 1168 | PRJ-FIELD is the name of the field to use in the project file to get the | 1168 | PRJ-FIELD is the name of the field to use in the project file to get the |
| 1169 | command, and should be either comp_cmd (default) or check_cmd." | 1169 | command, and should be either `comp_cmd' (default) or `check_cmd'." |
| 1170 | (interactive "P") | 1170 | (interactive "P") |
| 1171 | (ada-require-project-file) | 1171 | (ada-require-project-file) |
| 1172 | (let* ((field (if prj-field prj-field 'comp_cmd)) | 1172 | (let* ((field (if prj-field prj-field 'comp_cmd)) |
| @@ -1368,8 +1368,8 @@ project file." | |||
| 1368 | "Update the cross-references for FILE. | 1368 | "Update the cross-references for FILE. |
| 1369 | This in fact recompiles FILE to create ALI-FILE-NAME. | 1369 | This in fact recompiles FILE to create ALI-FILE-NAME. |
| 1370 | This function returns the name of the file that was recompiled to generate | 1370 | This function returns the name of the file that was recompiled to generate |
| 1371 | the cross-reference information. Note that the ali file can then be deduced by | 1371 | the cross-reference information. Note that the ali file can then be deduced |
| 1372 | replacing the file extension with `.ali'." | 1372 | by replacing the file extension with `.ali'." |
| 1373 | ;; kill old buffer | 1373 | ;; kill old buffer |
| 1374 | (if (and ali-file-name | 1374 | (if (and ali-file-name |
| 1375 | (get-file-buffer ali-file-name)) | 1375 | (get-file-buffer ali-file-name)) |
| @@ -1539,8 +1539,8 @@ the project file." | |||
| 1539 | 1539 | ||
| 1540 | (defun ada-get-ada-file-name (file original-file) | 1540 | (defun ada-get-ada-file-name (file original-file) |
| 1541 | "Create the complete file name (+directory) for FILE. | 1541 | "Create the complete file name (+directory) for FILE. |
| 1542 | The original file (where the user was) is ORIGINAL-FILE. Search in project | 1542 | The original file (where the user was) is ORIGINAL-FILE. |
| 1543 | file for possible paths." | 1543 | Search in project file for possible paths." |
| 1544 | 1544 | ||
| 1545 | (save-excursion | 1545 | (save-excursion |
| 1546 | 1546 | ||
| @@ -1940,9 +1940,8 @@ This function attempts to find the possible declarations for the identifier | |||
| 1940 | anywhere in the object path. | 1940 | anywhere in the object path. |
| 1941 | This command requires the external `egrep' program to be available. | 1941 | This command requires the external `egrep' program to be available. |
| 1942 | 1942 | ||
| 1943 | This works well when one is using an external librarie and wants | 1943 | This works well when one is using an external librarie and wants to find |
| 1944 | to find the declaration and documentation of the subprograms one is | 1944 | the declaration and documentation of the subprograms one is using." |
| 1945 | is using." | ||
| 1946 | ;; FIXME: what does this function do? | 1945 | ;; FIXME: what does this function do? |
| 1947 | (let (list | 1946 | (let (list |
| 1948 | (dirs (ada-xref-get-obj-dir-field)) | 1947 | (dirs (ada-xref-get-obj-dir-field)) |
| @@ -2274,7 +2273,7 @@ This function typically is to be hooked into `ff-file-created-hook'." | |||
| 2274 | (defun ada-xref-initialize () | 2273 | (defun ada-xref-initialize () |
| 2275 | "Function called by `ada-mode-hook' to initialize the ada-xref.el package. | 2274 | "Function called by `ada-mode-hook' to initialize the ada-xref.el package. |
| 2276 | For instance, it creates the gnat-specific menus, sets some hooks for | 2275 | For instance, it creates the gnat-specific menus, sets some hooks for |
| 2277 | `find-file'..." | 2276 | `find-file'." |
| 2278 | (remove-hook 'ff-file-created-hook 'ada-make-body) ; from global hook | 2277 | (remove-hook 'ff-file-created-hook 'ada-make-body) ; from global hook |
| 2279 | (remove-hook 'ff-file-created-hook 'ada-make-body t) ; from local hook | 2278 | (remove-hook 'ff-file-created-hook 'ada-make-body t) ; from local hook |
| 2280 | (add-hook 'ff-file-created-hook 'ada-make-body-gnatstub nil t) | 2279 | (add-hook 'ff-file-created-hook 'ada-make-body-gnatstub nil t) |