erl_recomment

erl_recomment

Module

erl_recomment

Module summary

Inserting comments into abstract Erlang syntax trees.

Description

Inserting comments into abstract Erlang syntax trees

This module contains functions for inserting comments, described by position, indentation and text, as attachments on an abstract syntax tree, at the correct places.

Exports

quick_recomment_forms(Tree::Forms, Comments::[Comment]) -> syntaxTree()

Types:

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

Like recomment_forms/2, but only inserts top-level comments. Comments within function definitions or declarations ("forms") are simply ignored.

recomment_forms(Tree::Forms, Comments