From 33cc284345798e343d52656fb4b158c06938aea3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ricardo=20Catalinas=20Jim=C3=A9nez?= <jimenezrick@gmail.com>
Date: Tue, 28 Feb 2012 18:09:27 +0100
Subject: Add start/0,1 and help/0 to etop's doc

---
 lib/observer/doc/src/etop.xml | 30 ++++++++++++++++++++++++++++++
 lib/observer/src/etop.erl     |  6 +++---
 2 files changed, 33 insertions(+), 3 deletions(-)

(limited to 'lib/observer')

diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml
index 78047caab3..928724846a 100644
--- a/lib/observer/doc/src/etop.xml
+++ b/lib/observer/doc/src/etop.xml
@@ -113,6 +113,36 @@ Default: <c>on</c></item>
 
   </description>
   <funcs>
+    <func>
+      <name>start() -> ok</name>
+      <fsummary>Start etop</fsummary>
+      <desc>
+        <p>This function starts <c>etop</c>.</p>
+      </desc>
+    </func>
+    <func>
+      <name>start(Options) -> ok</name>
+      <fsummary>Start etop</fsummary>
+      <type>
+        <v>Options = [Option]</v>
+        <v>Option = {Key, Value}</v>
+        <v>Key = atom()</v>
+        <v>Value = term()</v>
+      </type>
+      <desc>
+        <p>This function starts <c>etop</c>. Use
+          <seealso marker="#help/0">help/0</seealso> to see a
+          description of the possible options.</p>
+      </desc>
+    </func>
+    <func>
+      <name>help() -> ok</name>
+      <fsummary>Print etop's help</fsummary>
+      <desc>
+        <p>This function prints the help of <c>etop</c> and
+          its options.</p>
+      </desc>
+    </func>
     <func>
       <name>config(Key,Value) -> Result</name>
       <fsummary>Change tool's configuration</fsummary>
diff --git a/lib/observer/src/etop.erl b/lib/observer/src/etop.erl
index 0bf1d68534..7ec0fedbb2 100644
--- a/lib/observer/src/etop.erl
+++ b/lib/observer/src/etop.erl
@@ -31,9 +31,9 @@
 
 help() ->
     io:format(
-      "Usage of the erlang top program~n"
-      "Options are set as command line parameters as in -node a@host -..~n"
-      "or as parameter to etop:start([{node, a@host}, {...}])~n"
+      "Usage of the Erlang top program~n~n"
+      "Options are set as command line parameters as in -node my@host~n"
+      "or as parameters to etop:start([{node, my@host}, {...}]).~n~n"
       "Options are:~n"
       "  node        atom       Required   The erlang node to measure ~n"
       "  port        integer    The used port, NOTE: due to a bug this program~n"
-- 
cgit v1.2.3