From 1ba422f4e4a18dd9874c9704b73cbf38b4252fa7 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang.org>
Date: Fri, 13 May 2016 10:28:22 +0200
Subject: erts: Fix erl_tracer xml doc errors

---
 erts/doc/src/erl_tracer.xml | 62 ++++++++++++++++-----------------------------
 1 file changed, 22 insertions(+), 40 deletions(-)

(limited to 'erts')

diff --git a/erts/doc/src/erl_tracer.xml b/erts/doc/src/erl_tracer.xml
index 7fd5512b33..d4c8bbad31 100644
--- a/erts/doc/src/erl_tracer.xml
+++ b/erts/doc/src/erl_tracer.xml
@@ -67,7 +67,7 @@
       <desc>
 	<p>The different trace tags that the tracer will be called with.
         Each trace tag is described in greater detail in
-        <seealso marker="#trace">Module:trace/6</seealso>
+        <seealso marker="#Module:trace/6">Module:trace/6</seealso>
         </p>
       </desc>
     </datatype>
@@ -81,7 +81,7 @@
     <datatype>
       <name name="trace_opts" />
       <desc>
-	<p>The options for the tracee.
+	<p>The options for the tracee.</p>
         <taglist>
           <tag><c>timestamp</c></tag>
           <item>If not set to <c>undefined</c>, the tracer has been requested to
@@ -93,7 +93,6 @@
           <item>Set to a number if the scheduler id is to be included by the tracer.
           Otherwise it is set to <c>undefined</c>.</item>
         </taglist>
-        </p>
       </desc>
     </datatype>
     <datatype>
@@ -114,30 +113,30 @@
     <p>The following functions
       should be exported from a <c>erl_tracer</c> callback module.</p>
    <taglist>
-       <tag><seealso marker="#enabled"><c>Module:enabled/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled/3"><c>Module:enabled/3</c></seealso></tag>
        <item>Mandatory</item>
-       <tag><seealso marker="#trace"><c>Module:trace/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace/6"><c>Module:trace/6</c></seealso></tag>
        <item>Mandatory</item>
-       <tag><seealso marker="#enabled_procs"><c>Module:enabled_procs/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_procs/3"><c>Module:enabled_procs/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_procs"><c>Module:trace_procs/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_procs/6"><c>Module:trace_procs/6</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#enabled_ports"><c>Module:enabled_ports/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_ports/3"><c>Module:enabled_ports/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_ports"><c>Module:trace_ports/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_ports/6"><c>Module:trace_ports/6</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#enabled_running_ports"><c>Module:enabled_running_ports/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_running_ports/3"><c>Module:enabled_running_ports/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_running_ports"><c>Module:trace_running_ports/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_running_ports/6"><c>Module:trace_running_ports/6</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#enabled_running_procs"><c>Module:enabled_running_procs/3</c></seealso></tag>
+       <tag><seealso marker="#Module:enabled_running_procs/3"><c>Module:enabled_running_procs/3</c></seealso></tag>
        <item>Optional</item>
-       <tag><seealso marker="#trace_running_procs"><c>Module:trace_running_procs/6</c></seealso></tag>
+       <tag><seealso marker="#Module:trace_running_procs/6"><c>Module:trace_running_procs/6</c></seealso></tag>
        <item>Optional</item>
    </taglist>
 
   </section>
-  <marker id="enabled"></marker>
+
   <funcs>
     <func>
       <name>Module:enabled(TraceTag, TracerState, Tracee) -> Result</name>
@@ -166,7 +165,6 @@
         is important that it is both fast and side effect free.</p>
       </desc>
     </func>
-    <marker id="trace"></marker>
     <func>
       <name>Module:trace(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
       <fsummary>Check if a trace event should be generated.</fsummary>
@@ -181,7 +179,7 @@
       </type>
       <desc>
         <p>This callback will be called when a tracepoint is triggered and
-        the <seealso marker="#enabled">Module:enabled/3</seealso>
+        the <seealso marker="#Module:enabled/3">Module:enabled/3</seealso>
         callback returned <c>trace</c>. In it any side effects needed by
         the tracer should be done. The tracepoint payload is located in
         the <c>FirstTraceTerm</c> and <c>SecondTraceTerm</c>. The content
@@ -212,7 +210,6 @@
       </desc>
     </func>
 
-    <marker id="enabled_procs"></marker>
     <func>
         <name>Module:enabled_procs(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -230,7 +227,6 @@
         </desc>
     </func>
 
-    <marker id="trace_procs"></marker>
     <func>
         <name>Module:trace_procs(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -245,13 +241,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_procs">Module:enabled_procs/3</seealso>
+                the <seealso marker="#Module:enabled_procs/3">Module:enabled_procs/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_procs/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_ports"></marker>
     <func>
         <name>Module:enabled_ports(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -269,7 +264,6 @@
         </desc>
     </func>
 
-    <marker id="trace_ports"></marker>
     <func>
         <name>Module:trace_ports(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -284,13 +278,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_ports">Module:enabled_ports/3</seealso>
+                the <seealso marker="#Module:enabled_ports/3">Module:enabled_ports/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_ports/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_running_procs"></marker>
     <func>
         <name>Module:enabled_running_procs(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -308,7 +301,6 @@
         </desc>
     </func>
 
-    <marker id="trace_running_procs"></marker>
     <func>
         <name>Module:trace_running_procs(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -323,13 +315,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_running_procs">Module:enabled_running_procs/3</seealso>
+                the <seealso marker="#Module:enabled_running_procs/3">Module:enabled_running_procs/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_running_procs/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_running_ports"></marker>
     <func>
         <name>Module:enabled_running_ports(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -347,7 +338,6 @@
         </desc>
     </func>
 
-    <marker id="trace_running_ports"></marker>
     <func>
         <name>Module:trace_running_ports(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -362,13 +352,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_running_ports">Module:enabled_running_ports/3</seealso>
+                the <seealso marker="#Module:enabled_running_ports/3">Module:enabled_running_ports/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_running_ports/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_call"></marker>
     <func>
         <name>Module:enabled_call(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -386,7 +375,6 @@
         </desc>
     </func>
 
-    <marker id="trace_call"></marker>
     <func>
         <name>Module:trace_call(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -401,13 +389,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_call">Module:enabled_call/3</seealso>
+                the <seealso marker="#Module:enabled_call/3">Module:enabled_call/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_call/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_send"></marker>
     <func>
         <name>Module:enabled_send(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -425,7 +412,6 @@
         </desc>
     </func>
 
-    <marker id="trace_send"></marker>
     <func>
         <name>Module:trace_send(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -440,13 +426,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_send">Module:enabled_send/3</seealso>
+                the <seealso marker="#Module:enabled_send/3">Module:enabled_send/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_send/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_receive"></marker>
     <func>
         <name>Module:enabled_receive(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -464,7 +449,6 @@
         </desc>
     </func>
 
-    <marker id="trace_receive"></marker>
     <func>
         <name>Module:trace_receive(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -479,13 +463,12 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_receive">Module:enabled_receive/3</seealso>
+                the <seealso marker="#Module:enabled_receive/3">Module:enabled_receive/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_receive/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
     </func>
 
-    <marker id="enabled_garbage_collection"></marker>
     <func>
         <name>Module:enabled_garbage_collection(TraceTag, TracerState, Tracee) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -503,7 +486,6 @@
         </desc>
     </func>
 
-    <marker id="trace_garbage_collection"></marker>
     <func>
         <name>Module:trace_garbage_collection(TraceTag, TracerState, Tracee, FirstTraceTerm, SecondTraceTerm, Opts) -> Result</name>
         <fsummary>Check if a trace event should be generated.</fsummary>
@@ -518,7 +500,7 @@
         </type>
         <desc>
             <p>This callback will be called when a tracepoint is triggered and
-                the <seealso marker="#enabled_garbage_collection">Module:enabled_garbage_collection/3</seealso>
+                the <seealso marker="#Module:enabled_garbage_collection/3">Module:enabled_garbage_collection/3</seealso>
                 callback returned <c>trace</c>.</p>
             <p>If <c>trace_garbage_collection/6</c> is not defined <c>trace/6</c> will be called instead.</p>
         </desc>
-- 
cgit v1.2.3