From 26ca7ae1edb42aeb372cc0595c41f100f67d8dd7 Mon Sep 17 00:00:00 2001 From: Chris Mann Date: Tue, 29 Sep 2009 22:56:26 +0930 Subject: [PATCH] Minor improvements to documentation. * wesnoth-mode.el (wesnoth-allow-accurate-validation, wesnoth-element-opening, wesnoth-element): Updated docstring. --- wesnoth-mode.el | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/wesnoth-mode.el b/wesnoth-mode.el index 9e63f28..307b9ca 100644 --- a/wesnoth-mode.el +++ b/wesnoth-mode.el @@ -34,6 +34,7 @@ ;;; History: ;; 1.3.5+git +;; * Add support for ido completion (see `wesnoth-use-alternate-completion') ;; * Add support for WML validation on a directory. ;; * Add support for more accurate WML validation. (See ;; `wesnoth-allow-accurate-validation'.) @@ -243,8 +244,8 @@ level as their parent.") If non-nil, allow a more accurate method (which is able to better determine the current element's parent) to be used. Note that this may cause WML validation to slow significantly when checking -error-prone or messy WML. If clean WML is generally used, it is -recommended to set this to non-nil." +error-prone or messy WML. If WML checked is rarely incorrect it +is recommended to set this to non-nil." :type 'boolean :group 'wesnoth-mode) @@ -375,7 +376,7 @@ If LIMITED is non-nil, return a regexp which matches only the "\\)")) (defun wesnoth-element-opening (&optional limited) - "Return the regexp to match a closing element. + "Return the regexp to match an opening element. If LIMITED is non-nil, return a regexp which matches only the #define preprocessor." (concat "^[\t ]*\\(\\[\\+?\\(\\w\\|_\\)+\\]\\|#define " @@ -388,7 +389,7 @@ If LIMITED is non-nil, return a regexp which matches only the "\\)")) (defun wesnoth-element (&optional limited) - "Return the regexp to match a closing element. + "Return the regexp to match any element. If LIMITED is non-nil, return a regexp which matches only the #define and #enddef preprocessors." (concat "^[\t ]*\\(\\[[+/]?\\(\\w\\|_\\)+\\]?\\|" @@ -457,7 +458,7 @@ element types to find." Return non-nil when an element is found. Otherwise, return nil." (interactive) (if (= (point) (wesnoth-wml-start-pos)) - nil + nil (let ((init-element (save-excursion (wesnoth-next-element))) last-element cur-element) (save-match-data @@ -467,8 +468,8 @@ Return non-nil when an element is found. Otherwise, return nil." (when (car cur-element) (setq last-element cur-element))) (goto-char (or (cadr last-element) (cadr init-element) (point-min)))) - ;; Determine whether currently within a string, and move to its beginning - ;; where necessary. + ;; Determine whether currently within a string, and move to its beginning + ;; where necessary. (save-excursion (let ((details (wesnoth-element-type (point)))) (save-match-data -- 2.11.4.GIT