From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/tools/doc/src/cover.xml | 70 ++++++++++++++++++++-------------------- lib/tools/doc/src/cprof.xml | 42 ++++++++++++------------ lib/tools/doc/src/eprof.xml | 22 ++++++------- lib/tools/doc/src/fprof.xml | 50 ++++++++++++++-------------- lib/tools/doc/src/instrument.xml | 2 +- lib/tools/doc/src/make.xml | 10 +++--- lib/tools/doc/src/tags.xml | 16 ++++----- lib/tools/doc/src/xref.xml | 64 ++++++++++++++++++------------------ 8 files changed, 138 insertions(+), 138 deletions(-) (limited to 'lib/tools/doc/src') diff --git a/lib/tools/doc/src/cover.xml b/lib/tools/doc/src/cover.xml index ac49be4652..64c24cea2a 100644 --- a/lib/tools/doc/src/cover.xml +++ b/lib/tools/doc/src/cover.xml @@ -30,7 +30,7 @@ - cover + cover A Coverage Analysis Tool for Erlang

The module cover provides a set of functions for coverage @@ -115,7 +115,7 @@ - start() -> {ok,Pid} | {error,Reason} + start() -> {ok,Pid} | {error,Reason} Start Cover. Pid = pid() @@ -128,7 +128,7 @@ - start(Nodes) -> {ok,StartedNodes} | {error,not_main_node} + start(Nodes) -> {ok,StartedNodes} | {error,not_main_node} Start Cover on remote nodes. Nodes = StartedNodes = [atom()] @@ -139,10 +139,10 @@ - compile(ModFiles) -> Result | [Result] - compile(ModFiles, Options) -> Result | [Result] - compile_module(ModFiles) -> Result | [Result] - compile_module(ModFiles, Options) -> Result | [Result] + compile(ModFiles) -> Result | [Result] + compile(ModFiles, Options) -> Result | [Result] + compile_module(ModFiles) -> Result | [Result] + compile_module(ModFiles, Options) -> Result | [Result] Compile one or more modules for Cover analysis. ModFiles = ModFile | [ModFile] @@ -176,9 +176,9 @@ - compile_directory() -> [Result] | {error,Reason} - compile_directory(Dir) -> [Result] | {error,Reason} - compile_directory(Dir, Options) -> [Result] | {error,Reason} + compile_directory() -> [Result] | {error,Reason} + compile_directory(Dir) -> [Result] | {error,Reason} + compile_directory(Dir, Options) -> [Result] | {error,Reason} Compile all modules in a directory for Cover analysis. Dir = string() @@ -199,7 +199,7 @@ - compile_beam(ModFiles) -> Result | [Result] + compile_beam(ModFiles) -> Result | [Result] Compile one or more modules for Cover analysis, using existing beam(s). ModFiles = ModFile | [ModFile] @@ -241,8 +241,8 @@ - compile_beam_directory() -> [Result] | {error,Reason} - compile_beam_directory(Dir) -> [Result] | {error,Reason} + compile_beam_directory() -> [Result] | {error,Reason} + compile_beam_directory(Dir) -> [Result] | {error,Reason} Compile all .beam files in a directory for Cover analysis. Dir = string() @@ -261,13 +261,13 @@ analyse() -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Analysis) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Level) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Analysis) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} - analyse(Analysis, Level) -> {result,Ok,Fail} | {error,not_main_node} - analyse(Modules, Analysis, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Modules) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Analysis) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Level) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Analysis) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} + analyse(Analysis, Level) -> {result,Ok,Fail} | {error,not_main_node} + analyse(Modules, Analysis, Level) -> OneResult | {result,Ok,Fail} | {error,not_main_node} Analyse one or more Cover compiled modules. Modules = Module | [Module] @@ -306,9 +306,9 @@ analyse_to_file() -> {result,Ok,Fail} | {error,not_main_node} - analyse_to_file(Modules) -> Answer | {result,Ok,Fail} | {error,not_main_node} - analyse_to_file(Options) -> {result,Ok,Fail} | {error,not_main_node} - analyse_to_file(Modules,Options) -> Answer | {result,Ok,Fail} | {error,not_main_node} + analyse_to_file(Modules) -> Answer | {result,Ok,Fail} | {error,not_main_node} + analyse_to_file(Options) -> {result,Ok,Fail} | {error,not_main_node} + analyse_to_file(Modules,Options) -> Answer | {result,Ok,Fail} | {error,not_main_node} Detailed coverage analysis of one or more Cover compiled modules. Modules = Module | [Module] @@ -384,7 +384,7 @@ - modules() -> [Module] | {error,not_main_node} + modules() -> [Module] | {error,not_main_node} Return all Cover compiled modules. Module = atom() @@ -395,7 +395,7 @@ - imported_modules() -> [Module] | {error,not_main_node} + imported_modules() -> [Module] | {error,not_main_node} Return all modules for which there are imported data. Module = atom() @@ -406,7 +406,7 @@ - imported() -> [File] | {error,not_main_node} + imported() -> [File] | {error,not_main_node} Return all imported files. File = string() @@ -416,7 +416,7 @@ - which_nodes() -> [Node] | {error,not_main_node} + which_nodes() -> [Node] | {error,not_main_node} Return all nodes that are part of the coverage analysis. Node = atom() @@ -428,7 +428,7 @@ - is_compiled(Module) -> {file,File} | false | {error,not_main_node} + is_compiled(Module) -> {file,File} | false | {error,not_main_node} Check if a module is Cover compiled. Module = atom() @@ -442,8 +442,8 @@ - reset(Module) -> - reset() -> ok | {error,not_main_node} + reset(Module) -> + reset() -> ok | {error,not_main_node} Reset coverage data for Cover compiled modules. Module = atom() @@ -458,8 +458,8 @@ - export(ExportFile) - export(ExportFile,Module) -> ok | {error,Reason} + export(ExportFile) + export(ExportFile,Module) -> ok | {error,Reason} Reset coverage data for Cover compiled modules. ExportFile = string() @@ -480,7 +480,7 @@ - import(ExportFile) -> ok | {error,Reason} + import(ExportFile) -> ok | {error,Reason} Reset coverage data for Cover compiled modules. ExportFile = string() @@ -504,14 +504,14 @@ - stop() -> ok | {error,not_main_node} + stop() -> ok | {error,not_main_node} Stop Cover.

Stops the Cover server and unloads all Cover compiled code.

- stop(Nodes) -> ok | {error,not_main_node} + stop(Nodes) -> ok | {error,not_main_node} Stop Cover on remote nodes. Nodes = [atom()] diff --git a/lib/tools/doc/src/cprof.xml b/lib/tools/doc/src/cprof.xml index df0acbe617..b6af8b6d28 100644 --- a/lib/tools/doc/src/cprof.xml +++ b/lib/tools/doc/src/cprof.xml @@ -34,7 +34,7 @@ PA1 cprof.sgml - cprof + cprof A simple Call Count Profiling Tool using breakpoints for minimal runtime performance impact.

The cprof module is used to profile a program @@ -65,10 +65,10 @@ - analyse() -> {AllCallCount, ModAnalysisList} - analyse(Limit) -> {AllCallCount, ModAnalysisList} - analyse(Mod) -> ModAnalysis - analyse(Mod, Limit) -> ModAnalysis + analyse() -> {AllCallCount, ModAnalysisList} + analyse(Limit) -> {AllCallCount, ModAnalysisList} + analyse(Mod) -> ModAnalysis + analyse(Mod, Limit) -> ModAnalysis Collect and analyse call counters. Limit = integer() @@ -122,7 +122,7 @@ - pause() -> integer() + pause() -> integer() Pause running call count trace for all functions.

Pause call count tracing for all functions in all modules @@ -137,9 +137,9 @@ - pause(FuncSpec) -> integer() - pause(Mod, Func) -> integer() - pause(Mod, Func, Arity) -> integer() + pause(FuncSpec) -> integer() + pause(Mod, Func) -> integer() + pause(Mod, Func, Arity) -> integer() Pause running call count trace for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -167,10 +167,10 @@ - restart() -> integer() - restart(FuncSpec) -> integer() - restart(Mod, Func) -> integer() - restart(Mod, Func, Arity) -> integer() + restart() -> integer() + restart(FuncSpec) -> integer() + restart(Mod, Func) -> integer() + restart(Mod, Func, Arity) -> integer() Restart existing call counters for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -197,7 +197,7 @@ - start() -> integer() + start() -> integer() Start call count tracing for all functions.

Start call count tracing for all functions in all modules, @@ -212,9 +212,9 @@ - start(FuncSpec) -> integer() - start(Mod, Func) -> integer() - start(Mod, Func, Arity) -> integer() + start(FuncSpec) -> integer() + start(Mod, Func) -> integer() + start(Mod, Func, Arity) -> integer() Start call count tracing for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} @@ -240,7 +240,7 @@ - stop() -> integer() + stop() -> integer() Stop call count tracing for all functions.

Stop call count tracing for all functions in all modules, @@ -255,9 +255,9 @@ - stop(FuncSpec) -> integer() - stop(Mod, Func) -> integer() - stop(Mod, Func, Arity) -> integer() + stop(FuncSpec) -> integer() + stop(Mod, Func) -> integer() + stop(Mod, Func, Arity) -> integer() Stop call count tracing for matching functions. FuncSpec = Mod | {Mod,Func,Arity}, {FS} diff --git a/lib/tools/doc/src/eprof.xml b/lib/tools/doc/src/eprof.xml index 158f61d9e9..c9e4edd991 100644 --- a/lib/tools/doc/src/eprof.xml +++ b/lib/tools/doc/src/eprof.xml @@ -28,7 +28,7 @@ - eprof + eprof A Time Profiling Tool for Erlang

The module eprof provides a set of functions for time @@ -40,7 +40,7 @@ - start() -> {ok,Pid} | {error,Reason} + start() -> {ok,Pid} | {error,Reason} Start Eprof. Pid = pid() @@ -51,7 +51,7 @@ - start_profiling(Rootset) -> profiling | {error, Reason} + start_profiling(Rootset) -> profiling | {error, Reason} start_profiling(Rootset,Pattern) -> profiling | {error, Reason} start_profiling(Rootset,Pattern,Options) -> profiling | {error, Reason} Start profiling. @@ -79,7 +79,7 @@ - stop_profiling() -> profiling_stopped | profiling_already_stopped + stop_profiling() -> profiling_stopped | profiling_already_stopped Stop profiling.

Stops profiling started with start_profiling/1 or @@ -87,12 +87,12 @@ - profile(Fun) -> profiling | {error, Reason} - profile(Fun, Options) -> profiling | {error, Reason} - profile(Rootset) -> profiling | {error, Reason} - profile(Rootset,Fun) -> {ok, Value} | {error,Reason} + profile(Fun) -> profiling | {error, Reason} + profile(Fun, Options) -> profiling | {error, Reason} + profile(Rootset) -> profiling | {error, Reason} + profile(Rootset,Fun) -> {ok, Value} | {error,Reason} profile(Rootset,Fun,Pattern) -> {ok, Value} | {error, Reason} - profile(Rootset,Module,Function,Args) -> {ok, Value} | {error, Reason} + profile(Rootset,Module,Function,Args) -> {ok, Value} | {error, Reason} profile(Rootset,Module,Function,Args,Pattern) -> {ok, Value} | {error, Reason} profile(Rootset,Module,Function,Args,Pattern,Options) -> {ok, Value} | {error, Reason} Start profiling. @@ -152,7 +152,7 @@ - log(File) -> ok + log(File) -> ok Activate logging of eprofprintouts. File = atom() | string() @@ -164,7 +164,7 @@ - stop() -> stopped + stop() -> stopped Stop Eprof.

Stops the Eprof server.

diff --git a/lib/tools/doc/src/fprof.xml b/lib/tools/doc/src/fprof.xml index 1fd828d127..4bb8862016 100644 --- a/lib/tools/doc/src/fprof.xml +++ b/lib/tools/doc/src/fprof.xml @@ -32,7 +32,7 @@ PA1 fprof.sgml - fprof + fprof A Time Profiling Tool using trace to file for minimal runtime performance impact.

This module is used to profile a program @@ -101,7 +101,7 @@ - start() -> {ok, Pid} | {error, {already_started, Pid}} + start() -> {ok, Pid} | {error, {already_started, Pid}} Starts the fprof server. Pid = pid() @@ -117,14 +117,14 @@ - stop() -> ok + stop() -> ok Same as stop(normal).

Same as stop(normal).

 - stop(Reason) -> ok + stop(Reason) -> ok Stops the fprof server. Reason = term() @@ -149,7 +149,7 @@ - apply(Func, Args) -> term() + apply(Func, Args) -> term() Same as apply(Func, Args, []). Func = function() | {Module, Function} @@ -162,7 +162,7 @@ - apply(Module, Function, Args) -> term() + apply(Module, Function, Args) -> term() Same as apply({Module, Function}, Args, []). Args = [term()] @@ -174,7 +174,7 @@ - apply(Func, Args, OptionList) -> term() + apply(Func, Args, OptionList) -> term() Calls erlang:apply(Func, Args)surrounded bytrace([start | OptionList])andtrace(stop). Func = function() | {Module, Function} @@ -210,7 +210,7 @@ - apply(Module, Function, Args, OptionList) -> term() + apply(Module, Function, Args, OptionList) -> term() Same as apply({Module, Function}, Args, OptionList). Module = atom() @@ -228,7 +228,7 @@ - trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(start, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, {file, Filename}]). Reason = term() @@ -238,7 +238,7 @@ - trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(verbose, Filename) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, verbose, {file, Filename}]). Reason = term() @@ -249,7 +249,7 @@ - trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([{OptionName, OptionValue}]). OptionName = atom() @@ -262,7 +262,7 @@ - trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(verbose) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([start, verbose]). Reason = term() @@ -272,7 +272,7 @@ - trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([OptionName]). OptionName = atom() @@ -283,7 +283,7 @@ - trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as trace([{OptionName, OptionValue}]). OptionName = atom() @@ -296,7 +296,7 @@ - trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + trace([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Starts or stops tracing. Option = start | stop | {procs, PidSpec} | {procs, [PidSpec]} | verbose | {verbose, bool()} | file | {file, Filename} | {tracer, Tracer} @@ -360,7 +360,7 @@ - profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([]). Reason = term() @@ -370,7 +370,7 @@ - profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([{OptionName, OptionValue}]). OptionName = atom() @@ -383,7 +383,7 @@ - profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([OptionName]). OptionName = atom() @@ -394,7 +394,7 @@ - profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + profile({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as profile([{OptionName, OptionValue}]). OptionName = atom() @@ -407,7 +407,7 @@ - profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason} + profile([Option]) -> ok | {ok, Tracer} | {error, Reason} | {'EXIT', ServerPid, Reason} Compiles a trace into raw profile data held by the fprof server. Option = file | {file, Filename} | dump | {dump, Dump} | append | start | stop @@ -465,7 +465,7 @@ - analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse() -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([]). Reason = term() @@ -475,7 +475,7 @@ - analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse(OptionName, OptionValue) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([{OptionName, OptionValue}]). OptionName = atom() @@ -488,7 +488,7 @@ - analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse(OptionName) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([OptionName]). OptionName = atom() @@ -499,7 +499,7 @@ - analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse({OptionName, OptionValue}) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Same as analyse([{OptionName, OptionValue}]). OptionName = atom() @@ -512,7 +512,7 @@ - analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} + analyse([Option]) -> ok | {error, Reason} | {'EXIT', ServerPid, Reason} Analyses raw profile data in the fprof server. Option = dest | {dest, Dest} | append | {cols, Cols} | callers | {callers, bool()} | no_callers | {sort, SortSpec} | totals | {totals, bool()} | details | {details, bool()} | no_details diff --git a/lib/tools/doc/src/instrument.xml b/lib/tools/doc/src/instrument.xml index bc1276bdd5..75be22de9b 100644 --- a/lib/tools/doc/src/instrument.xml +++ b/lib/tools/doc/src/instrument.xml @@ -32,7 +32,7 @@ PA1 instrument.sgml - instrument + instrument Analysis and Utility Functions for Instrumentation

The module instrument contains support for studying the resource diff --git a/lib/tools/doc/src/make.xml b/lib/tools/doc/src/make.xml index 123fcd4afc..af2404707f 100644 --- a/lib/tools/doc/src/make.xml +++ b/lib/tools/doc/src/make.xml @@ -30,7 +30,7 @@ - make + make A Make Utility for Erlang

The module make provides a set of functions similar to @@ -38,8 +38,8 @@ - all() -> up_to_date | error - all(Options) -> up_to_date | error + all() -> up_to_date | error + all(Options) -> up_to_date | error Compile a set of modules. Options = [Option] @@ -87,8 +87,8 @@ - files(ModFiles) -> up_to_date | error - files(ModFiles, Options) -> up_to_date | error + files(ModFiles) -> up_to_date | error + files(ModFiles, Options) -> up_to_date | error Compile a set of modules. ModFiles = [Module | File] diff --git a/lib/tools/doc/src/tags.xml b/lib/tools/doc/src/tags.xml index ea0ae5cc4d..90a8b28177 100644 --- a/lib/tools/doc/src/tags.xml +++ b/lib/tools/doc/src/tags.xml @@ -32,7 +32,7 @@ A tags.sgml - tags + tags Generate Emacs TAGS file from Erlang source files

A TAGS file is used by Emacs to find function and variable @@ -42,14 +42,14 @@ - file(File [, Options]) + file(File [, Options]) Create a TAGSfile for the file File.

Create a TAGS file for the file File.

 - files(FileList [, Options]) + files(FileList [, Options]) Create a TAGS file for the files in the listFileList.

Create a TAGS file for the files in the list @@ -57,7 +57,7 @@ - dir(Dir [, Options]) + dir(Dir [, Options]) Create a TAGS file for all files in directoryDir.

Create a TAGS file for all files in directory @@ -65,7 +65,7 @@ - dirs(DirList [, Options]) + dirs(DirList [, Options]) Create a TAGS file for all files in any directory inDirList.

Create a TAGS file for all files in any directory in @@ -73,7 +73,7 @@ - subdir(Dir [, Options]) + subdir(Dir [, Options]) Descend recursively down the directory Dirand create a TAGSfile based on all files found.

Descend recursively down the directory Dir and @@ -81,7 +81,7 @@ - subdirs(DirList [, Options]) + subdirs(DirList [, Options]) Descend recursively down all the directories inDirListand create a TAGSfile based on all files found.

Descend recursively down all the directories in @@ -90,7 +90,7 @@ - root([Options]) + root([Options]) Create a TAGSfile covering all files in the Erlang distribution.

Create a TAGS file covering all files in diff --git a/lib/tools/doc/src/xref.xml b/lib/tools/doc/src/xref.xml index 6f833246ad..ab3641a52f 100644 --- a/lib/tools/doc/src/xref.xml +++ b/lib/tools/doc/src/xref.xml @@ -32,7 +32,7 @@ PA1 xref.sgml - xref + xref A Cross Reference Tool for analyzing dependencies between functions, modules, applications and releases.

Xref is a cross reference tool that can be used for finding @@ -729,7 +729,7 @@ xref() = atom() | pid() - add_application(Xref, Directory [, Options]) -> {ok, application()} | Error + add_application(Xref, Directory [, Options]) -> {ok, application()} | Error Add the modules of an application. Directory = directory() @@ -761,7 +761,7 @@ xref() = atom() | pid() - add_directory(Xref, Directory [, Options]) -> {ok, Modules} | Error + add_directory(Xref, Directory [, Options]) -> {ok, Modules} | Error Add the modules in a directory. Directory = directory() @@ -791,7 +791,7 @@ xref() = atom() | pid() - add_module(Xref, File [, Options]) -> {ok, module()} | Error + add_module(Xref, File [, Options]) -> {ok, module()} | Error Add a module. Error = {error, module(), Reason} @@ -814,7 +814,7 @@ xref() = atom() | pid() - add_release(Xref, Directory [, Options]) -> {ok, release()} | Error + add_release(Xref, Directory [, Options]) -> {ok, release()} | Error Add the modules of a release. Directory = directory() @@ -849,7 +849,7 @@ xref() = atom() | pid() - analyze(Xref, Analysis [, Options]) -> {ok, Answer} | Error + analyze(Xref, Analysis [, Options]) -> {ok, Answer} | Error Evaluate a predefined analysis. Analysis = undefined_function_calls | undefined_functions | locals_not_used | exports_not_used | deprecated_function_calls | {deprecated_function_calls, DeprFlag} | deprecated_functions | {deprecated_functions, DeprFlag} | {call, FuncSpec} | {use, FuncSpec} | {module_call, ModSpec} | {module_use, ModSpec} | {application_call, AppSpec} | {application_use, AppSpec} | {release_call, RelSpec} | {release_use, RelSpec} @@ -939,7 +939,7 @@ Evaluates a predefined analysis. - d(Directory) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + d(Directory) -> [DebugInfoResult] | [NoDebugInfoResult] | Error Check the modules in a directory using the code path. Directory = directory() @@ -979,8 +979,8 @@ Evaluates a predefined analysis. - forget(Xref) -> ok - forget(Xref, Variables) -> ok | Error + forget(Xref) -> ok + forget(Xref, Variables) -> ok | Error Remove user variables and their values. Error = {error, module(), Reason} @@ -994,7 +994,7 @@ Evaluates a predefined analysis. - format_error(Error) -> Chars + format_error(Error) -> Chars Return an English description of an Xref error reply. Error = {error, module(), term()} @@ -1008,8 +1008,8 @@ Evaluates a predefined analysis. - get_default(Xref) -> [{Option, Value}] - get_default(Xref, Option) -> {ok, Value} | Error + get_default(Xref) -> [{Option, Value}] + get_default(Xref, Option) -> {ok, Value} | Error Return the default values of options. Error = {error, module(), Reason} @@ -1023,7 +1023,7 @@ Evaluates a predefined analysis. - get_library_path(Xref) -> {ok, LibraryPath} + get_library_path(Xref) -> {ok, LibraryPath} Return the library path. LibraryPath = library_path() @@ -1034,9 +1034,9 @@ Evaluates a predefined analysis. - info(Xref) -> [Info] - info(Xref, Category) -> [{Item, [Info]}] - info(Xref, Category, Items) -> [{Item, [Info]}] + info(Xref) -> [Info] + info(Xref, Category) -> [{Item, [Info]}] + info(Xref, Category, Items) -> [{Item, [Info]}] Return information about an Xref server. Application = [] | [application()] @@ -1220,8 +1220,8 @@ Evaluates a predefined analysis. - m(Module) -> [DebugInfoResult] | [NoDebugInfoResult] | Error - m(File) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + m(Module) -> [DebugInfoResult] | [NoDebugInfoResult] | Error + m(File) -> [DebugInfoResult] | [NoDebugInfoResult] | Error Check a module using the code path. DebugInfoResult = {deprecated, [funcall()]} | {undefined, [funcall()]} | {unused, [mfa()]} @@ -1263,7 +1263,7 @@ Evaluates a predefined analysis. - q(Xref, Query [, Options]) -> {ok, Answer} | Error + q(Xref, Query [, Options]) -> {ok, Answer} | Error Evaluate a query. Answer = false | [constant()] | [Call] | [Component] | int() | [DefineAt] | [CallAt] | [AllLines] @@ -1322,7 +1322,7 @@ Evaluates a predefined analysis. - remove_application(Xref, Applications) -> ok | Error + remove_application(Xref, Applications) -> ok | Error Remove applications and their modules. Applications = application() | [application()] @@ -1335,7 +1335,7 @@ Evaluates a predefined analysis. - remove_module(Xref, Modules) -> ok | Error + remove_module(Xref, Modules) -> ok | Error Remove analyzed modules. Error = {error, module(), Reason} @@ -1348,7 +1348,7 @@ Evaluates a predefined analysis. - remove_release(Xref, Releases) -> ok | Error + remove_release(Xref, Releases) -> ok | Error Remove releases and their applications and modules. Error = {error, module(), Reason} @@ -1363,7 +1363,7 @@ Evaluates a predefined analysis. - replace_application(Xref, Application, Directory [, Options]) -> {ok, application()} | Error + replace_application(Xref, Application, Directory [, Options]) -> {ok, application()} | Error Replace an application's modules. Application = application() @@ -1384,7 +1384,7 @@ Evaluates a predefined analysis. - replace_module(Xref, Module, File [, Options]) -> {ok, module()} | Error + replace_module(Xref, Module, File [, Options]) -> {ok, module()} | Error Replace an analyzed module. Error = {error, module(), Reason} @@ -1409,8 +1409,8 @@ Evaluates a predefined analysis. - set_default(Xref, Option, Value) -> {ok, OldValue} | Error - set_default(Xref, OptionValues) -> ok | Error + set_default(Xref, Option, Value) -> {ok, OldValue} | Error + set_default(Xref, OptionValues) -> ok | Error Set the default values of options. Error = {error, module(), Reason} @@ -1435,7 +1435,7 @@ Evaluates a predefined analysis. - set_library_path(Xref, LibraryPath [, Options]) -> ok | Error + set_library_path(Xref, LibraryPath [, Options]) -> ok | Error Set the library path and finds the library modules. Error = {error, module(), Reason} @@ -1469,7 +1469,7 @@ Evaluates a predefined analysis. - start(NameOrOptions) -> Return + start(NameOrOptions) -> Return Create an Xref server. NameOrOptions = Name | Options @@ -1487,7 +1487,7 @@ Evaluates a predefined analysis. - start(Name, Options) -> Return + start(Name, Options) -> Return Create an Xref server. Name = atom() @@ -1504,7 +1504,7 @@ Evaluates a predefined analysis. - stop(Xref) + stop(Xref) Delete an Xref server. Xref = xref() @@ -1514,7 +1514,7 @@ Evaluates a predefined analysis. - update(Xref [, Options]) -> {ok, Modules} | Error + update(Xref [, Options]) -> {ok, Modules} | Error Replace newly compiled analyzed modules. Error = {error, module(), Reason} @@ -1534,7 +1534,7 @@ Evaluates a predefined analysis. - variables(Xref [, Options]) -> {ok, [VariableInfo]} + variables(Xref [, Options]) -> {ok, [VariableInfo]} Return the names of variables. Options = [Option] | Option -- cgit v1.2.3