A TAGS
file is used by Emacs to find function and variable
definitions in any source file in large projects. This module can
generate a TAGS
file from Erlang source files. It recognises
functions, records, and macro definitions.
Create a TAGS
file for the file File
.
Create a TAGS file for the files in the list
FileList
.
Create a TAGS file for all files in directory
Dir
.
Create a TAGS file for all files in any directory in
DirList
.
Descend recursively down the directory Dir
and
create a TAGS
file based on all files found.
Descend recursively down all the directories in
DirList
and create a TAGS
file based on all
files found.
Create a TAGS
file covering all files in
the Erlang distribution.
The functions above have an optional argument, Options
. It is a
list which can contain the following elements:
{outfile, NameOfTAGSFile}
Create a TAGS
file named
NameOfTAGSFile
.
{outdir, NameOfDirectory}
Create a file named
TAGS
in the directory NameOfDirectory
.The default behaviour is to create a file named TAGS
in the current
directory.
tags:root([{outfile, "root.TAGS"}]).
root.TAGS
in the current
directory. The file will contain references to all Erlang source
files in the Erlang distribution.tags:files(["foo.erl", "bar.erl", "baz.erl"],
[{outdir, "../projectdir"}]).
TAGS
placed it in the directory
../projectdir
. The file contains information about the
functions, records, and macro definitions of the three files.