diff options
| author | tmanevik <[email protected]> | 2015-11-23 18:27:25 +0100 |
|---|---|---|
| committer | Dan Gudmundsson <[email protected]> | 2016-02-22 09:38:19 +0100 |
| commit | e6b2edc8027c40db4c12f8f081648cda4634f9f7 (patch) | |
| tree | f0ec5f7b023f51c62ab6a383fa650cacbd85770a /lib/observer/doc/src/crashdump.xml | |
| parent | 82a835d94be7ee5e98d101a29999fedaf6cd75fe (diff) | |
| download | otp-e6b2edc8027c40db4c12f8f081648cda4634f9f7.tar.gz otp-e6b2edc8027c40db4c12f8f081648cda4634f9f7.tar.bz2 otp-e6b2edc8027c40db4c12f8f081648cda4634f9f7.zip | |
Observer: Editorial changes in documentation
Diffstat (limited to 'lib/observer/doc/src/crashdump.xml')
| -rw-r--r-- | lib/observer/doc/src/crashdump.xml | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index 76deee45f6..27e88d07e5 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -25,7 +25,7 @@ </legalnotice> <title>crashdump_viewer</title> - <prepared>Siri hansen</prepared> + <prepared>Siri Hansen</prepared> <responsible></responsible> <docno>1</docno> <approved></approved> @@ -41,32 +41,31 @@ <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 - Viewer.</p> + <p>For details about how to get started with the Crashdump Viewer, see the + <seealso marker="crashdump_ug"><c>User's Guide</c></seealso>.</p> </description> <funcs> <func> <name>start() -> ok</name> <name>start(File) -> ok</name> - <fsummary>Start the crashdump_viewer</fsummary> + <fsummary>Start the Crashdump Viewer.</fsummary> <type> <v>File = string()</v> - <d>The file name of the crashdump.</d> + <d>The filename of the crashdump.</d> </type> <desc> - <p>This function starts the <c>crashdump_viewer</c> GUI and - loads the given crashdump.</p> + <p>Starts the Crashdump Viewer GUI and + loads the specified crashdump.</p> - <p>If <c>File</c> is not given, a file dialog will be opened + <p>If <c>File</c> is not specified, a file dialog is opened where the crashdump can be selected.</p> </desc> </func> <func> <name>stop() -> ok</name> - <fsummary>Stop the crashdump_viewer</fsummary> + <fsummary>Terminate the Crashdump Viewer.</fsummary> <desc> - <p>This function stops the <c>crashdump_viewer</c> and closes + <p>Terminates the Crashdump Viewer and closes all GUI windows.</p> </desc> </func> |