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/xref.xml | 64 +++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 32 deletions(-) (limited to 'lib/tools/doc/src/xref.xml') 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