diff options
| author | Dan Gudmundsson <[email protected]> | 2016-02-22 09:46:32 +0100 |
|---|---|---|
| committer | Dan Gudmundsson <[email protected]> | 2016-02-22 09:46:32 +0100 |
| commit | 942aa912cd1f17a7a98fd98f9d39a1374bbac44d (patch) | |
| tree | 2e1720b24addd1e435c4c931ca52c4651d08cd5d /lib/observer/doc/src/crashdump.xml | |
| parent | 83185e95fe92efb2431c1173ac16f26bd40217f7 (diff) | |
| parent | fb39a2dd41a5bb14e1f84935798e09ab3b747c85 (diff) | |
| download | otp-942aa912cd1f17a7a98fd98f9d39a1374bbac44d.tar.gz otp-942aa912cd1f17a7a98fd98f9d39a1374bbac44d.tar.bz2 otp-942aa912cd1f17a7a98fd98f9d39a1374bbac44d.zip | |
Merge remote-tracking branch 'upstream/maint'
* upstream/maint:
debugger: Editorial changes in documentation
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> |