diff options
| author | Siri Hansen <[email protected]> | 2013-07-11 11:27:29 +0200 |
|---|---|---|
| committer | Dan Gudmundsson <[email protected]> | 2014-01-27 15:52:52 +0100 |
| commit | e2d565532d25024c1c0552d8eaaddf90eed88629 (patch) | |
| tree | ca6f09ddf4bde35b10868746f4ee2a33e3edea7e /lib/observer/doc/src/crashdump.xml | |
| parent | 7d4e5e2458e0627882f49078b9757dd6ae21a6fe (diff) | |
| download | otp-e2d565532d25024c1c0552d8eaaddf90eed88629.tar.gz otp-e2d565532d25024c1c0552d8eaaddf90eed88629.tar.bz2 otp-e2d565532d25024c1c0552d8eaaddf90eed88629.zip | |
observer: add wx version of crashdump_viewer
The old web base crashdump_viewer is now removed.
Diffstat (limited to 'lib/observer/doc/src/crashdump.xml')
| -rw-r--r-- | lib/observer/doc/src/crashdump.xml | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index 5b58a52739..27e42e83b7 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -31,13 +31,14 @@ <checked></checked> <date>2003-03-10</date> <rev>PA1</rev> - <file>crashdump.sgml</file> + <file>crashdump.xml</file> </header> <module>crashdump_viewer</module> - <modulesummary>A HTML based tool for browsing Erlang crashdumps.</modulesummary> + <modulesummary>A WxWidgets based tool for browsing Erlang + crashdumps.</modulesummary> <description> - <p>The Crashdump Viewer is an HTML based tool for browsing Erlang - crashdumps. Crashdump Viewer runs under the WebTool application.</p> + <p>The Crashdump Viewer is a WxWidgets based tool for browsing Erlang + crashdumps.</p> <p>See the <seealso marker="crashdump_ug">user's guide</seealso> for more information about how to get started with the Crashdump @@ -46,16 +47,26 @@ <funcs> <func> <name>start() -> ok</name> + <name>start(File) -> ok</name> <fsummary>Start the crashdump_viewer</fsummary> + <type> + <v>File = string()</v> + <d>The file name of the crashdump.</d> + </type> <desc> - <p>This function starts the <c>crashdump_viewer</c>.</p> + <p>This function starts the <c>crashdump_viewer</c> GUI and + loads the given crashdump.</p> + + <p>If <c>File</c> is not given, a file dialog will be opened + where the crashdump can be selected.</p> </desc> </func> <func> <name>stop() -> ok</name> <fsummary>Stop the crashdump_viewer</fsummary> <desc> - <p>This function stops the <c>crashdump_viewer</c>.</p> + <p>This function stops the <c>crashdump_viewer</c> and closes + all GUI windows.</p> </desc> </func> </funcs> |