debugger: Editorial changes in documentation

1 files changed, 62 insertions, 76 deletions

diff --git a/lib/debugger/doc/src/i.xml b/lib/debugger/doc/src/i.xml
index 9ceba94b44..db89f23494 100644
--- a/lib/debugger/doc/src/i.xml
+++ b/lib/debugger/doc/src/i.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1998</year><year>2013</year>
+      <year>1998</year><year>2016</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -29,35 +29,36 @@
     <rev></rev>
   </header>
   <module>i</module>
-  <modulesummary>Debugger/Interpreter Interface</modulesummary>
+  <modulesummary>Debugger/Interpreter Interface.</modulesummary>
   <description>
-    <p>The module <c>i</c> provides short forms for some of
+    <p>The <c>i</c> module provides short forms for some of
       the functions used by the graphical Debugger and some of
-      the functions in the <c>int</c> module, the Erlang interpreter.
-    </p>
+      the functions in module
+      <seealso marker="int"><c>int</c></seealso>, the Erlang interpreter.</p>
 
     <p>This module also provides facilities for displaying status
       information about interpreted processes and break points.</p>
 
     <p>It is possible to attach to interpreted processes by giving
       the corresponding process identity only. By default, an attachment
-      window pops up. Processes at other Erlang nodes can be
+      window is displayed. Processes at other Erlang nodes can be
       attached manually or automatically.</p>
 
-    <p>By preference, these functions can be included in the module
-      <c>shell_default</c>. By default, they are.</p>
+    <p>By preference, these functions can be included in module
+      <seealso marker="stdlib:shell_default"><c>stdlib:shell_default</c></seealso>.
+      By default, they are included in that module.</p>
   </description>
 
   <funcs>
     <func>
       <name>im() -> pid()</name>
-      <fsummary>Start a graphical monitor</fsummary>
+      <fsummary>Start a graphical monitor.</fsummary>
       <desc>
 	<p>Starts a new graphical monitor. This is the Monitor window,
-	  the main window of the Debugger. All of the Debugger and
+	  the main window of Debugger. All the Debugger and
 	  interpreter functionality is accessed from the Monitor window.
-	  The Monitor window displays the status of all processes that 
-	  have been/are executing interpreted modules.</p>
+	  This window displays the status of all processes that 
+	  have been or are executing interpreted modules.</p>
       </desc>
     </func>
 
@@ -66,7 +67,7 @@
       <name>ii(AbsModule) -> {module, Module} | error</name>
       <name>ini(AbsModules) -> ok</name>
       <name>ini(AbsModule) -> {module, Module} | error</name>
-      <fsummary>Interpret a module</fsummary>
+      <fsummary>Interpret a module.</fsummary>
       <type>
 	<v>AbsModules = [AbsModule]</v>
 	<v>AbsModule = Module | File</v>
@@ -85,7 +86,7 @@
     <func>
       <name>iq(AbsModule) -> ok</name>
       <name>inq(AbsModule) -> ok</name>
-      <fsummary>Stop interpreting a module</fsummary>
+      <fsummary>Stop interpreting a module.</fsummary>
       <type>
 	<v>AbsModule = Module | File</v>
 	<v>&nbsp;Module = atom()</v>
@@ -110,28 +111,27 @@
 
     <func>
       <name>ip() -> ok</name>
-      <fsummary>Make a printout of the current status of all interpreted
-	processes</fsummary>
+      <fsummary>Print the current status of all interpreted
+	processes.</fsummary>
       <desc>
-	<p>Makes a printout of the current status of all interpreted 
-	  processes.</p>
+	<p>Prints the current status of all interpreted processes.</p>
       </desc>
     </func>
 
     <func>
       <name>ic() -> ok</name>
       <fsummary>Clear information about processes executing interpreted
-	code</fsummary>
+	code.</fsummary>
       <desc>
 	<p>Clears information about processes executing interpreted code
-	  byt removing all information about terminated processes.</p>
+	  by removing all information about terminated processes.</p>
       </desc>
     </func>
 
     <func>
       <name>iaa(Flags) -> true</name>
       <name>iaa(Flags, Function) -> true</name>
-      <fsummary>Set when and how to attach to a process</fsummary>
+      <fsummary>Set when and how to attach to a process.</fsummary>
       <type>
 	<v>Flags = [init | break | exit]</v>
 	<v>Function = {Module,Name,Args}</v>
@@ -139,42 +139,41 @@
 	<v>&nbsp;Args = [term()]</v>
       </type>
       <desc>
-	<p>Sets when and how to automatically attach to a debugged
-	  process, see
+	<p>Sets when and how to attach to a debugged process
+          automatically, see
 	  <seealso marker="int#auto_attach/0">int:auto_attach/2</seealso>.
 	  <c>Function</c> defaults to the standard function used by
-	  the Debugger.</p>
+	  Debugger.</p>
       </desc>
     </func>
 
     <func>
       <name>ist(Flag) -> true</name>
-      <fsummary>Set how to save call frames</fsummary>
+      <fsummary>Set how to save call frames.</fsummary>
       <type>
 	<v>Flag = all | no_tail | false</v>
       </type>
       <desc>
 	<p>Sets how to save call frames in the stack, see
-	  <seealso marker="int#stack_trace/0">int:stack_trace/1</seealso>.
-	</p>
+	  <seealso marker="int#stack_trace/0">int:stack_trace/1</seealso>.</p>
       </desc>
     </func>
 
     <func>
       <name>ia(Pid) -> ok | no_proc</name>
-      <fsummary>Attach to a process</fsummary>
+      <fsummary>Attache to a process.</fsummary>
       <type>
 	<v>Pid = pid()</v>
       </type>
       <desc>
-	<p>Attaches to the debugged process <c>Pid</c>. A Debugger
+	<p>Attaches to the debugged process <c>Pid</c>. An
 	  Attach Process window is opened for the process.</p>
       </desc>
     </func>
 
     <func>
       <name>ia(X,Y,Z) -> ok | no_proc</name>
-      <fsummary>Attach to a process</fsummary>
+      <fsummary>Attache to a process.</fsummary>
       <type>
 	<v>X = Y = Z = int()</v>
       </type>
@@ -186,7 +185,7 @@
 
     <func>
       <name>ia(Pid, Function) -> ok | no_proc</name>
-      <fsummary>Attach to a process</fsummary>
+      <fsummary>Attache to a process.</fsummary>
       <type>
 	<v>Pid = pid()</v>
 	<v>Function = {Module,Name}</v>
@@ -194,14 +193,14 @@
       </type>
       <desc>
 	<p>Attaches to the debugged process <c>Pid</c>. The interpreter
-	  will call <c>spawn(Module, Name, [Pid])</c> (and ignore
+	  calls <c>spawn(Module, Name, [Pid])</c> (and ignores
 	  the result).</p>
       </desc>
     </func>
 
     <func>
       <name>ia(X,Y,Z, Function) -> ok | no_proc</name>
-      <fsummary>Attach to a process</fsummary>
+      <fsummary>Attache to a process.</fsummary>
       <type>
 	<v>X = Y = Z = int()</v>
 	<v>Function = {Module,Name}</v>
@@ -211,15 +210,15 @@
 	<p>Same as <c>ia(Pid, Function)</c>, where <c>Pid</c> is
 	  the result of calling the shell function <c>pid(X,Y,Z)</c>.
 	  An attached process is expected to call the unofficial
-	  <c>int:attached(Pid)</c> function and to be able to handle
-	  messages from the interpreter, see <c>dbg_wx_trace.erl</c> for
-	  an example.</p>
+	  function <c>int:attached(Pid)</c> and to be able to handle
+	  messages from the interpreter. For an example, see
+	  <c>dbg_wx_trace.erl</c>.</p>
       </desc>
     </func>
 
     <func>
       <name>ib(Module, Line) -> ok | {error, break_exists}</name>
-      <fsummary>Create a breakpoint</fsummary>
+      <fsummary>Create a breakpoint.</fsummary>
       <type>
 	<v>Module = atom()</v>
 	<v>Line = int()</v>
@@ -232,20 +231,20 @@
     <func>
       <name>ib(Module, Name, Arity) -> ok | {error, function_not_found}
       </name>
-      <fsummary>Create breakpoints in the specified function</fsummary>
+      <fsummary>Create breakpoints in the specified function.</fsummary>
       <type>
 	<v>Module = Name = atom()</v>
 	<v>Arity = int()</v>
       </type>
       <desc>
 	<p>Creates breakpoints at the first line of every clause of 
-	  the <c>Module:Name/Arity</c> function.</p>
+	  function <c>Module:Name/Arity</c>.</p>
       </desc>
     </func>
 
     <func>
       <name>ir() -> ok</name>
-      <fsummary>Delete all breakpoints</fsummary>
+      <fsummary>Delete all breakpoints.</fsummary>
       <desc>
 	<p>Deletes all breakpoints.</p>
       </desc>
@@ -253,7 +252,7 @@
 
     <func>
       <name>ir(Module) -> ok</name>
-      <fsummary>Delete all breakpoints in a module</fsummary>
+      <fsummary>Delete all breakpoints in a module.</fsummary>
       <type>
 	<v>Module = atom()</v>
       </type>
@@ -264,61 +263,57 @@
 
     <func>
       <name>ir(Module, Line) -> ok</name>
-      <fsummary>Delete a breakpoint</fsummary>
+      <fsummary>Delete a breakpoint.</fsummary>
       <type>
 	<v>Module = atom()</v>
 	<v>Line = int()</v>
       </type>
       <desc>
-	<p>Deletes the breakpoint located at <c>Line</c> in
-	  <c>Module</c>.</p>
+	<p>Deletes the breakpoint at <c>Line</c> in <c>Module</c>.</p>
       </desc>
     </func>
 
     <func>
       <name>ir(Module, Name, Arity) -> ok | {error, function_not_found}
       </name>
-      <fsummary>Delete breakpoints from the specified function
-      </fsummary>
+      <fsummary>Delete breakpoints from the specified function.</fsummary>
       <type>
 	<v>Module = Name = atom()</v>
 	<v>Arity = int()</v>
       </type>
       <desc>
 	<p>Deletes the breakpoints at the first line of every clause of 
-	  the <c>Module:Name/Arity</c> function.</p>
+	  function <c>Module:Name/Arity</c>.</p>
       </desc>
     </func>
 
     <func>
       <name>ibd(Module, Line) -> ok</name>
-      <fsummary>Make a breakpoint inactive</fsummary>
+      <fsummary>Make a breakpoint inactive.</fsummary>
       <type>
 	<v>Module = atom()</v>
 	<v>Line = int()</v>
       </type>
       <desc>
-	<p>Makes the breakpoint at <c>Line</c> in <c>Module</c>
-	  inactive.</p>
+	<p>Makes the breakpoint at <c>Line</c> in <c>Module</c> inactive.</p>
       </desc>
     </func>
 
     <func>
       <name>ibe(Module, Line) -> ok</name>
-      <fsummary>Make a breakpoint active</fsummary>
+      <fsummary>Make a breakpoint active.</fsummary>
       <type>
 	<v>Module = atom()</v>
 	<v>Line = int()</v>
       </type>
       <desc>
-	<p>Makes the breakpoint at <c>Line</c> in <c>Module</c> active.
-	</p>
+	<p>Makes the breakpoint at <c>Line</c> in <c>Module</c> active.</p>
       </desc>
     </func>
 
     <func>
       <name>iba(Module, Line, Action) -> ok</name>
-      <fsummary>Set the trigger action of a breakpoint</fsummary>
+      <fsummary>Set the trigger action of a breakpoint.</fsummary>
       <type>
 	<v>Module = atom()</v>
 	<v>Line = int()</v>
@@ -332,7 +327,7 @@
 
     <func>
       <name>ibc(Module, Line, Function) -> ok</name>
-      <fsummary>Set the conditional test of a breakpoint</fsummary>
+      <fsummary>Set the conditional test of a breakpoint.</fsummary>
       <type>
 	<v>Module = atom()</v>
 	<v>Line = int()</v>
@@ -346,46 +341,44 @@
 	<p>The conditional test is performed by calling
 	  <c>Module:Name(Bindings)</c>, where <c>Bindings</c> is
 	  the current variable bindings. The function must return
-	  <c>true</c> (break) or <c>false</c> (do not break). Use
-	  <c>int:get_binding(Var, Bindings)</c> to retrieve the value
-	  of a variable <c>Var</c>.</p>
+	  <c>true</c> (break) or <c>false</c> (do not break).
+	  To retrieve the value of a variable <c>Var</c>, use
+	  <seealso marker="int#get_binding/2">int:get_binding(Var, Bindings)</seealso>.</p>
       </desc>
     </func>
 
     <func>
       <name>ipb() -> ok</name>
-      <fsummary>Make a printout of all existing breakpoints</fsummary>
+      <fsummary>Print all existing breakpoints.</fsummary>
       <desc>
-	<p>Makes a printout of all existing breakpoints.</p>
+	<p>Prints all existing breakpoints.</p>
       </desc>
     </func>
 
     <func>
       <name>ipb(Module) -> ok</name>
-      <fsummary>Make a printout of all breakpoints in a module
-      </fsummary>
+      <fsummary>Print all existing breakpoints in a module.</fsummary>
       <type>
 	<v>Module = atom()</v>
       </type>
       <desc>
-	<p>Makes a printout of all existing breakpoints in
-	  <c>Module</c>.</p>
+	<p>Prints all existing breakpoints in <c>Module</c>.</p>
       </desc>
     </func>
 
     <func>
       <name>iv() -> atom()</name>
-      <fsummary>Current version number of the interpreter</fsummary>
+      <fsummary>Return the current version number of the interpreter.
+      </fsummary>
       <desc>
 	<p>Returns the current version number of the interpreter.
-	  The same as the version number of the Debugger application.
-	</p>
+	  Same as the version number of the <c>Debugger</c> application.</p>
       </desc>
     </func>
 
     <func>
       <name>help() -> ok</name>
-      <fsummary>Print help text</fsummary>
+      <fsummary>Print help text.</fsummary>
       <desc>
 	<p>Prints help text.</p>
       </desc>
@@ -393,15 +386,8 @@
   </funcs>
 
   <section>
-    <title>Usage</title>
-
-    <p>Refer to the Debugger User's Guide for information about
-      the Debugger.</p>
-  </section>
-
-  <section>
   <title>See Also</title>
-    <p><c>int(3)</c></p>
+    <p><seealso marker="int"><c>int(3)</c></seealso></p>
   </section>
 </erlref>