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>
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions 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>