erl_comment_scan

erl_comment_scan

Module

erl_comment_scan

Module summary

Functions for reading comment lines from Erlang source code.

Description

Functions for reading comment lines from Erlang source code.

Data types

comment() = {Line::integer(), Column::integer(), Indentation::integer(), Text::[string()]}

Exports

file(FileName::file:filename()) -> [Comment]

Types:

Comment = {Line, Column, Indentation, Text}
Line = integer()
Column = integer()
Indentation = integer()
Text = [string()]

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 t