path: root/lib/observer/doc/src/crashdump.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<erlref>
  <header>
    <copyright>
      <year>2003</year>
      <year>2013</year>
      <holder>Ericsson AB, All Rights Reserved</holder>
    </copyright>
    <legalnotice>
  The contents of this file are subject to the Erlang Public License,
  Version 1.1, (the "License"); you may not use this file except in
  compliance with the License. You should have received a copy of the
  Erlang Public License along with this software. If not, it can be
  retrieved online at http://www.erlang.org/.

  Software distributed under the License is distributed on an "AS IS"
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  the License for the specific language governing rights and limitations
  under the License.

  The Initial Developer of the Original Code is Ericsson AB.
    </legalnotice>

    <title>crashdump_viewer</title>
    <prepared>Siri hansen</prepared>
    <responsible></responsible>
    <docno>1</docno>
    <approved></approved>
    <checked></checked>
    <date>2003-03-10</date>
    <rev>PA1</rev>
    <file>crashdump.xml</file>
  </header>
  <module>crashdump_viewer</module>
  <modulesummary>A WxWidgets based tool for browsing Erlang
  crashdumps.</modulesummary>
  <description>
    <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>
  </description>
  <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> 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> and closes
        all GUI windows.</p>
      </desc>
    </func>
  </funcs>
</erlref>