Commit 11ee272d authored by Glenn Morris's avatar Glenn Morris
Browse files

(c-tab-always-indent, c-insert-tab-function): Doc fix. (Bug#1368)

parent 84da0f17
...@@ -284,18 +284,13 @@ nil." ...@@ -284,18 +284,13 @@ nil."
"*Controls the operation of the TAB key. "*Controls the operation of the TAB key.
If t, hitting TAB always just indents the current line. If nil, hitting If t, hitting TAB always just indents the current line. If nil, hitting
TAB indents the current line if point is at the left margin or in the TAB indents the current line if point is at the left margin or in the
line's indentation, otherwise it inserts a `real' tab character \(see line's indentation, otherwise it calls `c-insert-tab-function' to
note\). If some other value (not nil or t), then tab is inserted only insert a `real' tab character. If some other value (neither nil nor t),
within literals \(comments and strings), but the line is always then inserts a tab only within literals (comments and strings), but
reindented. always reindents the line.
Note: The value of `indent-tabs-mode' will determine whether a real Note: the variable `c-comment-only-line-offset' also controls the
tab character will be inserted, or the equivalent number of spaces. indentation of lines containing only comments."
When inserting a tab, actually the function stored in the variable
`c-insert-tab-function' is called.
Note: indentation of lines containing only comments is also controlled
by the `c-comment-only-line-offset' variable."
:type '(radio :type '(radio
(const :tag "TAB key always indents, never inserts TAB" t) (const :tag "TAB key always indents, never inserts TAB" t)
(const :tag "TAB key indents in left margin, otherwise inserts TAB" nil) (const :tag "TAB key indents in left margin, otherwise inserts TAB" nil)
...@@ -305,7 +300,9 @@ by the `c-comment-only-line-offset' variable." ...@@ -305,7 +300,9 @@ by the `c-comment-only-line-offset' variable."
(defcustom c-insert-tab-function 'insert-tab (defcustom c-insert-tab-function 'insert-tab
"*Function used when inserting a tab for \\[c-indent-command]. "*Function used when inserting a tab for \\[c-indent-command].
Only used when `c-tab-always-indent' indicates a `real' tab character Only used when `c-tab-always-indent' indicates a `real' tab character
should be inserted. Value must be a function taking no arguments." should be inserted. Value must be a function taking no arguments.
The default, `insert-tab', inserts either a tab or the equivalent
number of spaces depending on the value of `indent-tabs-mode'."
:type 'function :type 'function
:group 'c) :group 'c)
......
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