* progmodes/ada-mode.el (ada-batch-reformat): Doc fix.
(ada-create-case-exception): Fix typo in docstring.
(ada-no-auto-case): Return nil, not the docstring.
(ada-indent-current): Reflow docstring.
* progmodes/ada-prj.el (ada-prj-edit, ada-prj-initialize-values)
(ada-prj-save-specific-option, ada-prj-field): Fix typos in docstrings.
(ada-prj-load-from-file): Reflow docstring.
(ada-prj-display-page): Fix typo in widget.
* progmodes/ada-stmt.el (ada-case, ada-package-body, ada-private):
Fix typos in docstrings.
* progmodes/ada-xref.el (ada-find-executable, ada-gnat-parse-gpr)
(ada-compile-current, ada-check-current, ada-run-application)
(ada-get-ali-file-name): Fix typos in docstrings.
(ada-xref-confirm-compile, ada-find-references)
(ada-find-local-references, ada-find-any-references): Doc fixes.
(ada-get-all-references): Fix typo in error message.
(ada-xref-current-project): Use `let', not `let*'.
(ada-do-file-completion, ada-xref-change-buffer): Reflow docstring.
+2008-07-29 Juanma Barranquero <lekktu@gmail.com>
+
+ * progmodes/ada-mode.el (ada-batch-reformat): Doc fix.
+ (ada-create-case-exception): Fix typo in docstring.
+ (ada-no-auto-case): Return nil, not the docstring.
+ (ada-indent-current): Reflow docstring.
+
+ * progmodes/ada-prj.el (ada-prj-edit, ada-prj-initialize-values)
+ (ada-prj-save-specific-option, ada-prj-field): Fix typos in docstrings.
+ (ada-prj-load-from-file): Reflow docstring.
+ (ada-prj-display-page): Fix typo in widget.
+
+ * progmodes/ada-stmt.el (ada-case, ada-package-body, ada-private):
+ Fix typos in docstrings.
+
+ * progmodes/ada-xref.el (ada-find-executable, ada-gnat-parse-gpr)
+ (ada-compile-current, ada-check-current, ada-run-application)
+ (ada-get-ali-file-name): Fix typos in docstrings.
+ (ada-xref-confirm-compile, ada-find-references)
+ (ada-find-local-references, ada-find-any-references): Doc fixes.
+ (ada-get-all-references): Fix typo in error message.
+ (ada-xref-current-project): Use `let', not `let*'.
+ (ada-do-file-completion, ada-xref-change-buffer): Reflow docstring.
+
2008-07-28 Vinicius Jose Latorre <viniciusjl@ig.com.br>
* whitespace.el (whitespace-newline): Change initialization to have a
(defun ada-create-case-exception (&optional word)
"Define WORD as an exception for the casing system.
If WORD is not given, then the current word in the buffer is used instead.
-The new words is added to the first file in `ada-case-exception-file'.
+The new word is added to the first file in `ada-case-exception-file'.
The standard casing rules will no longer apply to this word."
(interactive)
(let ((previous-syntax-table (syntax-table))
instance use it for `ada-case-identifier' if you don't want any special
auto-casing for identifiers, whereas keywords have to be lower-cased.
See also `ada-auto-case' to disable auto casing altogether."
- )
+ nil)
(defun ada-capitalize-word (&optional arg)
"Upcase first letter and letters following '_', lower case other letters.
(defun ada-batch-reformat ()
"Re-indent and re-case all the files found on the command line.
-This function should be used from the Unix/Windows command line, with a
+This function should be used from the command line, with a
command like:
emacs -batch -l ada-mode -f ada-batch-reformat file1 file2 ..."
(defun ada-indent-current ()
"Indent current line as Ada code.
-Return the calculation that was done, including the reference point and the
-offset."
+Return the calculation that was done, including the reference point
+and the offset."
(interactive)
(let ((previous-syntax-table (syntax-table))
(orgpoint (point-marker))
(defun ada-prj-edit ()
"Editing the project file associated with the current Ada buffer.
-If there is none, opens a new project file"
+If there is none, opens a new project file."
(interactive)
(if ada-prj-default-project-file
(ada-customize)
(defun ada-prj-initialize-values (symbol ada-buffer filename)
"Set SYMBOL to the property list of the project file FILENAME.
-If FILENAME is null, read the file associated with ADA-BUFFER. If no
-project file is found, returns the default values."
+If FILENAME is null, read the file associated with ADA-BUFFER.
+If no project file is found, return the default values."
;; FIXME: rationalize arguments; make ada-buffer optional?
(if (and filename
(not (string= filename ""))
(defun ada-prj-save-specific-option (field)
"Return the string to print in the project file to save FIELD.
-If the current value of FIELD is the default value, returns an empty string."
+If the current value of FIELD is the default value, return an empty string."
(if (string= (plist-get ada-prj-current-values field)
(plist-get ada-prj-default-values field))
""
)
(defun ada-prj-load-from-file (symbol)
- "Load SYMBOL value from file. One item per line should be found in the file."
+ "Load SYMBOL value from file.
+One item per line should be found in the file."
(save-excursion
(let ((file (read-file-name "File name: " nil nil t))
(buffer (current-buffer))
((= tab-num 4)
(widget-insert "/_____________\\/______________\\/______________\\/ \\/______________\\\n")
(widget-insert
-"All the fields below can use variable substitution The syntax is ${name},
+"All the fields below can use variable substitution. The syntax is ${name},
where name is the name that appears after the Help buttons in this buffer. As
a special case, ${current} is replaced with the name of the file currently
edited, with directory name but no extension, whereas ${full_current} is
"Create a widget to edit FIELD in the current buffer.
TEXT is a short explanation of what the field means, whereas HELP-TEXT
is the text displayed when the user pressed the help button.
-If IS-LIST is non-nil, the field contains a list. Otherwise, it contains
+If IS-LIST is non-nil, the field contains a list. Otherwise, it contains
a single string.
-if IS-PATHS is true, some special buttons are added to load paths,...
+If IS-PATHS is true, some special buttons are added to load paths,...
AFTER-TEXT is inserted just after the widget."
(let ((value (plist-get ada-prj-current-values field))
(inhibit-read-only t)
(define-skeleton ada-case
"Build skeleton case statement.
-Prompt for the selector expression. Also builds the first when clause."
+Prompt for the selector expression. Also builds the first when clause."
"[selector expression]: "
"case " str " is" \n
> "when " ("discrete choice: " str " | ") -3 " =>" \n
(define-skeleton ada-package-body
- "Insert a skeleton package body -- includes a begin statement."
+ "Insert a skeleton package body -- includes a begin statement."
"[package name]: "
"package body " str " is" \n
> _ \n
(define-skeleton ada-private
- "Undent and start a private section of a package spec. Reindent."
+ "Undent and start a private section of a package spec. Reindent."
()
< "private" \n
>)
:type 'boolean :group 'ada)
(defcustom ada-xref-confirm-compile nil
- "*Non-nil means ask for confirmation before compiling or running the application."
+ "*If non-nil, ask for confirmation before compiling or running the application."
:type 'boolean :group 'ada)
(defcustom ada-krunch-args "0"
(defun ada-find-executable (exec-name)
"Find the full path to the executable file EXEC-NAME.
If not found, throw an error.
-On Windows systems, this will properly handle .exe extension as well"
+On Windows systems, this will properly handle .exe extension as well."
(let ((result (or (ada-find-file-in-dir exec-name exec-path)
(ada-find-file-in-dir (concat exec-name ".exe") exec-path))))
(if result
(defun ada-gnat-parse-gpr (plist gpr-file)
"Set gpr_file, src_dir and obj_dir properties in PLIST by parsing GPR-FILE.
-Returns new value of PLIST.
+Return new value of PLIST.
GPR_FILE must be full path to file, normalized.
src_dir, obj_dir will include compiler runtime.
Assumes environment variable ADA_PROJECT_PATH is set properly."
(defun ada-do-file-completion (string predicate flag)
"Completion function when reading a file from the minibuffer.
-Completion is attempted in all the directories in the source path, as
-defined in the project file."
+Completion is attempted in all the directories in the source path,
+as defined in the project file."
;; FIXME: doc arguments
;; This function is not itself interactive, but it is called as part
(defun ada-xref-current-project ()
"Return the current project.
Call `ada-require-project-file' first to ensure a project exists."
- (let* ((file-name (ada-xref-current-project-file)))
+ (let ((file-name (ada-xref-current-project-file)))
(assoc file-name ada-xref-project-files)))
(defun ada-show-current-project ()
(defun ada-find-references (&optional pos arg local-only)
"Find all references to the entity under POS.
Calls gnatfind to find the references.
-If ARG is t, the contents of the old *gnatfind* buffer is preserved.
-If LOCAL-ONLY is t, only the declarations in the current file are returned."
+If ARG is non-nil, the contents of the old *gnatfind* buffer is preserved.
+If LOCAL-ONLY is non-nil, only declarations in the current file are returned."
(interactive "d\nP")
(ada-require-project-file)
(defun ada-find-local-references (&optional pos arg)
"Find all references to the entity under POS.
Calls `gnatfind' to find the references.
-If ARG is t, the contents of the old *gnatfind* buffer is preserved."
+If ARG is non-nil, the contents of the old *gnatfind* buffer is preserved."
(interactive "d\nP")
(ada-find-references pos arg t))
(entity &optional file line column local-only append)
"Search for references to any entity whose name is ENTITY.
ENTITY was first found the location given by FILE, LINE and COLUMN.
-If LOCAL-ONLY is t, then list only the references in FILE, which
-is much faster.
-If APPEND is t, then append the output of the command to the existing
-buffer `*gnatfind*', if there is one."
+If LOCAL-ONLY is non-nil, then list only the references in FILE,
+which is much faster.
+If APPEND is non-nil, then append the output of the command to the
+existing buffer `*gnatfind*', if there is one."
(interactive "sEntity name: ")
(ada-require-project-file)
(defun ada-compile-current (&optional arg prj-field)
"Recompile the current file.
-If ARG is not nil, ask for user confirmation of the command.
+If ARG is non-nil, ask for user confirmation of the command.
PRJ-FIELD is the name of the field to use in the project file to get the
command, and should be either `comp_cmd' (default) or `check_cmd'."
(interactive "P")
(defun ada-check-current (&optional arg)
"Check the current file for syntax errors.
-If ARG is not nil, ask for user confirmation of the command."
+If ARG is non-nil, ask for user confirmation of the command."
(interactive "P")
(ada-compile-current arg 'check_cmd))
(defun ada-run-application (&optional arg)
"Run the application.
-if ARG is not-nil, ask for user confirmation."
+If ARG is non-nil, ask for user confirmation."
(interactive)
(ada-require-project-file)
(ada-find-file-in-dir file (ada-xref-get-src-dir-field)))
(defun ada-get-ali-file-name (file)
- "Create the ali file name for the ada-file FILE.
+ "Create the ali file name for the Ada file FILE.
The file is searched for in every directory shown in the obj_dir lines of
the project file."
(progn
(kill-buffer ali-buffer)
- (error "No declaration of %s found." (ada-name-of identlist))
+ (error "No declaration of %s found" (ada-name-of identlist))
)))
)
(defun ada-xref-change-buffer
(file line column identlist &optional other-frame)
"Select and display FILE, at LINE and COLUMN.
-If we do not end on the same identifier as IDENTLIST, find the closest
-match. Kills the .ali buffer at the end.
+If we do not end on the same identifier as IDENTLIST, find the
+closest match. Kills the .ali buffer at the end.
If OTHER-FRAME is non-nil, creates a new frame to show the file."
(let (declaration-buffer)
HCoop / bpt / emacs.git / commitdiff