file(Name::
file:filename()
) -> [
comment()
]
file:filename()
) -> [
comment()
]
Extracts comments from an Erlang source code file. Returns a list of entries representing multi-line comments, listed in order of increasing line-numbers. For each entry, Text
is a list of strings representing the consecutive comment lines in top-down order; the strings contain all characters following (but not including) the first comment-introducing %
character on the line, up to (but not including) the line-terminating newline.
Furthermore, Line
is the line number and Column
the left column of the comment (i.e., the column of the comment-introducing %
character). Indent
is the indentation (or padding), measured in character positions between the last non-whitespace character before the comment (or the left margin), and the left column of the comment. Line
and Column
are always positive integers, and Indentation
is a nonnegative integer.
Evaluation exits with reason {read, Reason}
if a read error occurred, where Reason
is an atom corresponding to a Posix error code; see the module file(3)
for details.