Commit 7644aa97 authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

lisp/net/*.el, lisp/progmodes/*.el: Fix docstring typos.

* net/socks.el (socks, socks-override-functions)
(socks-find-services-entry): FT
* progmodes/hideif.el (hif-set-var, hif-nexttoken, hif-comma)
(hif-find-ifdef-block):
* progmodes/modula2.el (m2-indent): Fix docstring typos.

* net/tls.el (tls-program): Reflow docstring.

* progmodes/opascal.el (opascal-compound-block-indent)
(opascal-case-label-indent): Fix docstring typos.
(opascal-mode): Fix typos; let defined-derived-mode document mode hook.

* progmodes/pascal.el (pascal-mode-abbrev-table)
(pascal-imenu-generic-expression, pascal-auto-endcomments)
(pascal-mark-defun, pascal-comment-area, pascal-indent-level)
(pascal-outline-mode): Fix docstring typos.
(pascal-mode): Let define-derived-mode document mode hook.
(pascal-uncomment-area): Reflow.
(pascal-exclude-str-start, pascal-exclude-str-end): Add docstring.
parent 1f44df94
2014-03-14 Juanma Barranquero <lekktu@gmail.com>
* net/socks.el (socks, socks-override-functions)
(socks-find-services-entry): FT
* progmodes/hideif.el (hif-set-var, hif-nexttoken, hif-comma)
(hif-find-ifdef-block):
* progmodes/modula2.el (m2-indent): Fix docstring typos.
* net/tls.el (tls-program): Reflow docstring.
* progmodes/pascal.el (pascal-mode-abbrev-table)
(pascal-imenu-generic-expression, pascal-auto-endcomments)
(pascal-mark-defun, pascal-comment-area, pascal-indent-level)
(pascal-outline-mode): Fix docstring typos.
(pascal-mode): Let define-derived-mode document mode hook.
(pascal-uncomment-area): Reflow.
(pascal-exclude-str-start, pascal-exclude-str-end): Add docstring.
* progmodes/opascal.el (opascal-compound-block-indent)
(opascal-case-label-indent): Fix docstring typos.
(opascal-mode): Fix typos; let defined-derived-mode document mode hook.
2014-03-13 Dmitry Gutov <dgutov@yandex.ru>
 
* progmodes/ruby-mode.el (ruby-font-lock-keywords): Fontify
......
......@@ -102,7 +102,7 @@ If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
;;; Customization support
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defgroup socks nil
"SOCKS Support"
"SOCKS support."
:version "22.2"
:prefix "socks-"
:group 'processes)
......@@ -347,7 +347,7 @@ If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
;; could get a wrapper hook, or defer to open-network-stream-function.
(defvar socks-override-functions nil
"Whether to overwrite the open-network-stream function with the SOCKSified
"Whether to overwrite the `open-network-stream' function with the SOCKSified
version.")
(require 'network-stream)
......@@ -533,7 +533,7 @@ version.")
socks-tcp-services))))))
(defun socks-find-services-entry (service &optional udp)
"Return the port # associated with SERVICE"
"Return the port # associated with SERVICE."
(if (= (hash-table-count socks-tcp-services) 0)
(socks-parse-services))
(gethash (downcase service)
......
......@@ -80,8 +80,7 @@ and `gnutls-cli' (version 2.0.1) output."
"List of strings containing commands to start TLS stream to a host.
Each entry in the list is tried until a connection is successful.
%h is replaced with server hostname, %p with port to connect to.
The program should read input on stdin and write output to
stdout.
The program should read input on stdin and write output to stdout.
See `tls-checktrust' on how to check trusted root certs.
......
......@@ -327,7 +327,7 @@ that form should be displayed.")
(defun hif-set-var (var value)
"Prepend (var value) pair to hide-ifdef-env."
"Prepend (var value) pair to `hide-ifdef-env'."
(setq hide-ifdef-env (cons (cons var value) hide-ifdef-env)))
(declare-function semantic-c-hideif-lookup "semantic/bovine/c" (var))
......@@ -479,7 +479,7 @@ that form should be displayed.")
;; | Comma | , | left-to-right |
(defsubst hif-nexttoken ()
"Pop the next token from token-list into the let variable \"hif-token\"."
"Pop the next token from token-list into the let variable `hif-token'."
(setq hif-token (pop hif-token-list)))
(defun hif-parse-if-exp (token-list)
......@@ -712,7 +712,7 @@ that form should be displayed.")
(defun hif-comma (&rest expr)
"Evaluate a list of expr, return the result of the last item"
"Evaluate a list of expr, return the result of the last item."
(let ((result nil))
(dolist (e expr)
(ignore-errors
......@@ -1118,7 +1118,7 @@ Turn off hiding by calling `show-ifdefs'."
(defun hif-find-ifdef-block ()
"Utility for hide and show `ifdef-block'.
"Utility to hide and show ifdef block.
Return as (TOP . BOTTOM) the extent of ifdef block."
(let (max-bottom)
(cons (save-excursion
......
......@@ -104,7 +104,7 @@
"Keymap used in Modula-2 mode.")
(defcustom m2-indent 5
"This variable gives the indentation in Modula-2-Mode."
"This variable gives the indentation in Modula-2 mode."
:type 'integer
:group 'modula2)
(put 'm2-indent 'safe-local-variable
......
......@@ -73,7 +73,7 @@ end;"
(define-obsolete-variable-alias
'delphi-compound-block-indent 'opascal-compound-block-indent "24.4")
(defcustom opascal-compound-block-indent 0
"Extra indentation for blocks in compound statements. E.g.
"Extra indentation for blocks in compound statements. E.g.
// block indent = 0 vs // block indent = 2
if b then if b then
......@@ -87,7 +87,7 @@ end; else
(define-obsolete-variable-alias
'delphi-case-label-indent 'opascal-case-label-indent "24.4")
(defcustom opascal-case-label-indent opascal-indent-level
"Extra indentation for case statement labels. E.g.
"Extra indentation for case statement labels. E.g.
// case indent = 0 vs // case indent = 3
case value of case value of
......@@ -1744,7 +1744,7 @@ comment block. If not in a // comment, just does a normal newline."
(define-obsolete-function-alias 'delphi-mode 'opascal-mode "24.4")
;;;###autoload
(define-derived-mode opascal-mode prog-mode "OPascal"
"Major mode for editing OPascal code. \\<opascal-mode-map>
"Major mode for editing OPascal code.\\<opascal-mode-map>
\\[opascal-find-unit]\t- Search for a OPascal source file.
\\[opascal-fill-comment]\t- Fill the current comment.
\\[opascal-new-comment-line]\t- If in a // comment, do a new comment line.
......@@ -1766,11 +1766,8 @@ Customization:
Coloring:
`opascal-keyword-face' (default font-lock-keyword-face)
Face used to color OPascal keywords.
Turning on OPascal mode calls the value of the variable `opascal-mode-hook'
with no args, if that value is non-nil."
`opascal-keyword-face' (default `font-lock-keyword-face')
Face used to color OPascal keywords."
;; Buffer locals:
(setq-local indent-line-function #'opascal-indent-line)
......
......@@ -64,7 +64,7 @@
:group 'languages)
(defvar pascal-mode-abbrev-table nil
"Abbrev table in use in Pascal-mode buffers.")
"Abbrev table in use in Pascal mode buffers.")
(define-abbrev-table 'pascal-mode-abbrev-table ())
(defvar pascal-mode-map
......@@ -99,7 +99,7 @@
(defvar pascal-imenu-generic-expression
'((nil "^[ \t]*\\(function\\|procedure\\)[ \t\n]+\\([a-zA-Z0-9_.:]+\\)" 2))
"Imenu expression for Pascal-mode. See `imenu-generic-expression'.")
"Imenu expression for Pascal mode. See `imenu-generic-expression'.")
(defvar pascal-keywords
'("and" "array" "begin" "case" "const" "div" "do" "downto" "else" "end"
......@@ -126,8 +126,10 @@
"\\<\\(label\\|var\\|type\\|const\\|until\\|end\\|begin\\|repeat\\|else\\)\\>")
;;; Strings used to mark beginning and end of excluded text
(defconst pascal-exclude-str-start "{-----\\/----- EXCLUDED -----\\/-----")
(defconst pascal-exclude-str-end " -----/\\----- EXCLUDED -----/\\-----}")
(defconst pascal-exclude-str-start "{-----\\/----- EXCLUDED -----\\/-----"
"String used to mark beginning of excluded text.")
(defconst pascal-exclude-str-end " -----/\\----- EXCLUDED -----/\\-----}"
"String used to mark end of excluded text.")
(defvar pascal-mode-syntax-table
(let ((st (make-syntax-table)))
......@@ -227,7 +229,7 @@ and follows non-whitespace text."
(defcustom pascal-auto-endcomments t
"Non-nil means automatically insert comments after certain `end's.
Specifically, this is done after the ends of cases statements and functions.
Specifically, this is done after the ends of case statements and functions.
The name of the function or case is included between the braces."
:type 'boolean
:group 'pascal)
......@@ -314,7 +316,7 @@ are handled in another way, and should not be added to this list."
;;;###autoload
(define-derived-mode pascal-mode prog-mode "Pascal"
"Major mode for editing Pascal code. \\<pascal-mode-map>
"Major mode for editing Pascal code.\\<pascal-mode-map>
TAB indents for Pascal code. Delete converts tabs to spaces as it moves back.
\\[completion-at-point] completes the word around current point with respect \
......@@ -355,10 +357,7 @@ Variables controlling indentation/edit style:
List of contexts where auto lineup of :'s or ='s should be done.
See also the user variables `pascal-type-keywords', `pascal-start-keywords' and
`pascal-separator-keywords'.
Turning on Pascal mode calls the value of the variable pascal-mode-hook with
no args, if that value is non-nil."
`pascal-separator-keywords'."
(setq-local local-abbrev-table pascal-mode-abbrev-table)
(setq-local indent-line-function 'pascal-indent-line)
(setq-local comment-indent-function 'pascal-indent-comment)
......@@ -507,7 +506,7 @@ no args, if that value is non-nil."
(insert " "))
(defun pascal-mark-defun ()
"Mark the current pascal function (or procedure).
"Mark the current Pascal function (or procedure).
This puts the mark at the end, and point at the beginning."
(interactive)
(push-mark (point))
......@@ -518,14 +517,14 @@ This puts the mark at the end, and point at the beginning."
(zmacs-activate-region)))
(defun pascal-comment-area (start end)
"Put the region into a Pascal comment.
"Put the region into a Pascal comment.\\<pascal-mode-map>
The comments that are in this area are \"deformed\":
`*)' becomes `!(*' and `}' becomes `!{'.
These deformed comments are returned to normal if you use
\\[pascal-uncomment-area] to undo the commenting.
The commented area starts with `pascal-exclude-str-start', and ends with
`pascal-include-str-end'. But if you change these variables,
The commented area starts with `pascal-exclude-str-start', and ends
with `pascal-exclude-str-end'. But if you change these variables,
\\[pascal-uncomment-area] won't recognize the comments."
(interactive "r")
(save-excursion
......@@ -553,8 +552,8 @@ The commented area starts with `pascal-exclude-str-start', and ends with
(defun pascal-uncomment-area ()
"Uncomment a commented area; change deformed comments back to normal.
This command does nothing if the pointer is not in a commented
area. See also `pascal-comment-area'."
This command does nothing if the pointer is not in a commented area.
See also `pascal-comment-area'."
(interactive)
(save-excursion
(let ((start (point))
......@@ -938,7 +937,7 @@ Return a list of two elements: (INDENT-TYPE INDENT-LEVEL)."
(defun pascal-indent-level ()
"Return the indent-level the current statement has.
Do not count labels, case-statements or records."
Do not count labels, case statements or records."
(save-excursion
(beginning-of-line)
(if (looking-at "[ \t]*[0-9a-zA-Z]+[ \t]*:[^=]")
......@@ -995,7 +994,7 @@ Do not count labels, case-statements or records."
(defun pascal-indent-paramlist (&optional arg)
"Indent current line in parameterlist.
If optional arg is non-nil, just return the
If optional ARG is non-nil, just return the
indent of the current line in parameterlist."
(save-excursion
(let* ((oldpos (point))
......@@ -1414,7 +1413,7 @@ and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil.
When enabled, portions of the text being edited may be made
invisible. \\<pascal-outline-map>
invisible.\\<pascal-outline-map>
Pascal Outline mode provides some additional commands.
......@@ -1428,7 +1427,7 @@ Pascal Outline mode provides some additional commands.
\\[pascal-show-all]\t- Show the whole buffer.
\\[pascal-hide-other-defuns]\
\t- Hide everything but the current function (function under the cursor).
\\[pascal-outline]\t- Leave pascal-outline-mode."
\\[pascal-outline]\t- Leave Pascal Outline mode."
:init-value nil :lighter " Outl" :keymap pascal-outline-map
(add-to-invisibility-spec '(pascal . t))
(unless pascal-outline-mode
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment