Continuation Lines and Filling
------------------------------
In IDL, a newline character terminates a statement unless preceded
by a `$'. If you would like to start a continuation line, use
`M-<RET>' which calls the command `idlwave-split-line'. It inserts a
`$' to indicate that the following line is a continuation of the
current line, terminates the line with a newline and indents the new
line. The command `M-<RET>' can also be used in the middle of a line
to split the line at that point. When used inside a long string
constant, the string is split with the `+' concatenation operator.
When filling comment paragraphs, IDLWAVE overloads the normal filling
functions and uses a function which creates hanging paragraphs as they
are customary in the IDL routine headers. When `auto-fill-mode' is
turned on (toggle with `C-c C-a'), comments will be auto-filled. If
the first line of a paragraph is matched by
`idlwave-hang-indent-regexp', subsequent lines are indented to after
the position of this match, as in the following example.
; INPUTS:
; x - an array containing
; lots of interesting numbers.
;
; y - another variable where
; a hanging paragraph is used
; to describe it.
You also refill a comment paragraph with `M-q'.
- User Option: idlwave-fill-comment-line-only (`t')
Non-`nil' means auto fill will only operate on comment lines.
- User Option: idlwave-auto-fill-split-string (`t')
Non-`nil' means auto fill will split strings with the IDL `+'
operator.
- User Option: idlwave-split-line-string (`t')
Non-`nil' means `idlwave-split-line' will split strings with `+'.
- User Option: idlwave-hanging-indent (`t')
Non-`nil' means comment paragraphs are indented under the hanging
indent given by `idlwave-hang-indent-regexp' match in the first
line of the paragraph.
- User Option: idlwave-hang-indent-regexp
Regular expression matching the position of the hanging indent in
the first line of a comment paragraph.
- User Option: idlwave-use-last-hang-indent (`nil')
Non-`nil' means use last match on line for `idlwave-indent-regexp'.