<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 solid;">
<tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="https://reviewboard.asterisk.org/r/1967/">https://reviewboard.asterisk.org/r/1967/</a>
</td>
</tr>
</table>
<br />
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">I've only reviewed the C changes here. I have not inspected the individual documentation additions, the python, configure, or Makefile changes.</pre>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/1967/diff/1/?file=28584#file28584line49" style="color: black; font-weight: bold; text-decoration: underline;">./include/asterisk/xmldoc.h</a>
<span style="font-weight: normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">struct ast_xml_doc_item {</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">49</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="cm">/*!< The syntax of the item */</span></pre></td>
</tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">I believe that if the doxygen appears above the item in the list, then the < is not necessary. That is only required if you have provided the documentation on the same line as the field.</pre>
</div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/1967/diff/1/?file=28585#file28585line6814" style="color: black; font-weight: bold; text-decoration: underline;">./main/manager.c</a>
<span style="font-weight: normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">static char *handle_manager_show_events(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">6814</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="n">it_events</span> <span class="o">=</span> <span class="n">ao2_callback</span><span class="p">(</span><span class="n">events</span><span class="p">,</span> <span class="n">OBJ_MULTIPLE</span> <span class="o">|</span> <span class="n">OBJ_NOLOCK</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">,</span> <span class="nb">NULL</span><span class="p">)))</span> <span class="p">{</span></pre></td>
</tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Okay, I'm lost. What is the purpose of this? This seems like an expensive way of accomplishing the same thing as ao2_iterator_init().</pre>
</div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/1967/diff/1/?file=28585#file28585line6831" style="color: black; font-weight: bold; text-decoration: underline;">./main/manager.c</a>
<span style="font-weight: normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">static char *handle_manager_show_events(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">6831</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="k">while</span> <span class="p">((</span><span class="n">item</span> <span class="o">=</span> <span class="n">ao2_iterator_next</span><span class="p">(</span><span class="n">it_events</span><span class="p">)))</span> <span class="p">{</span></pre></td>
</tr>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">6832</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="n">items</span><span class="p">[</span><span class="n">totalitems</span><span class="o">++</span><span class="p">]</span> <span class="o">=</span> <span class="n">item</span><span class="p">;</span></pre></td>
</tr>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">6833</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">}</span></pre></td>
</tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">You've got yourself a big ol' ref leak here.</pre>
</div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/1967/diff/1/?file=28585#file28585line6898" style="color: black; font-weight: bold; text-decoration: underline;">./main/manager.c</a>
<span style="font-weight: normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">static char *handle_manager_show_events(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">6898</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="k">if</span> <span class="p">(</span><span class="n">ast_str_strlen</span><span class="p">(</span><span class="n">temp</span><span class="o">-></span><span class="n">synopsis</span><span class="p">)</span> <span class="o">&&</span> <span class="n">strcmp</span><span class="p">(</span><span class="s">"(null)"</span><span class="p">,</span> <span class="n">ast_str_buffer</span><span class="p">(</span><span class="n">temp</span><span class="o">-></span><span class="n">synopsis</span><span class="p">)))</span> <span class="p">{</span></pre></td>
</tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Hm, that "(null)" check there seems odd. Under what circumstance does one of the strings get set to this?</pre>
</div>
<br />
<div>
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/1967/diff/1/?file=28586#file28586line1115" style="color: black; font-weight: bold; text-decoration: underline;">./main/xmldoc.c</a>
<span style="font-weight: normal;">
(Diff revision 1)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">static char *xmldoc_get_syntax_manager(struct ast_xml_node *fixnode, const char *name)</pre></td>
<td colspan="2"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">static char *xmldoc_get_syntax_manager(struct ast_xml_node *fixnode, const char *name, const char *manager_type)</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2">1112</font></th>
<td bgcolor="#fdfebc" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> <span class="s">"<span class="hl">agi</span>"</span><span class="p">,</span> <span class="hl"> </span><span class="n"><span class="hl">COM</span>MAN<span class="hl">D</span>_SYNTAX</span> <span class="p">}</span></pre></td>
<th bgcolor="#e9eaa8" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">1113</font></th>
<td bgcolor="#fdfebc" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> <span class="s">"<span class="hl">managerEvent</span>"</span><span class="p">,</span> <span class="n">MAN<span class="hl">AGER_EVENT</span>_SYNTAX</span> <span class="p">}<span class="hl">,</span></span></pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">1114</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="p">{</span> <span class="s">"agi"</span><span class="p">,</span> <span class="n">COMMAND_SYNTAX</span> <span class="p">}</span></pre></td>
</tr>
</tbody>
</table>
<pre style="margin-left: 2em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Spacing looks odd here. I don't know if it's review board or your changes, though.</pre>
</div>
<br />
<p>- Mark</p>
<br />
<p>On June 6th, 2012, 6:20 p.m., Matt Jordan wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" style="background-image: url('https://reviewboard.asterisk.org/media/rb/images/review_request_box_top_bg.png'); background-position: left top; background-repeat: repeat-x; border: 1px black solid;">
<tr>
<td>
<div>Review request for Asterisk Developers, Mark Michelson and wdoekes.</div>
<div>By Matt Jordan.</div>
<p style="color: grey;"><i>Updated June 6, 2012, 6:20 p.m.</i></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: 1px solid #b8b5a0">
<tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">This patch begins to add AMI event documentation to Asterisk. This patch includes the following:
* Pulling AMI event XML documentation out of the Asterisk source and into the XML documentation produced by the build tools
* Validating the XML when -dev-mode is enabled
* Reading/parsing the XML documentation when Asterisk starts
* Two new CLI commands: 'manager show events' and 'manager show event [event_name]'
* Event documentation for the core applications
So... AMI events are a bit trickier then other things we've attempted to document in the past. There were a number of factors to consider when approaching this:
1. There are a lot of AMI events, and they are located throughout the code base
2. AMI events can occur multiple times with different parameters, but still be the same 'event' type
3. AMI events can occur multiple times, in different implementation files
4. There is a significant amount of repeated information between events
5. Much of the information that a person cares about (AMI event keys) are - more often then not - easily obtained from a method call
To that end, documentation for AMI events is treated a bit differently then other items. There are a few major shifts in how the documentation is extracted:
1. The previous documentation extraction used an awk script that pulled the documentation from a single comment block (delineated by /*** DOCUMENTATION ... ***/). That still exists; however, if you want AMI event documentation, you have to use 'make full'. This calls a different documentation extraction script, written in python. That script lets us do a few things that the awk script did not:
* Documentation can now exist anywhere in the source file
* The documentation for manager events can be co-located with the method calls that raise the event. If the method call is recognized, event parameters are automatically read from the method call and populated in the documentation
* Documentation is combined where appropriate. Thus, if the same event is raised in multiple places, the parameters only need to be defined once.
2. Previously, documentation was registered with the application/function/command that it was associated with. Events are never registered with any controller; requiring them to do so would incur a run-time performance penalty for little gain. Hence, the xmldoc core now allow documentation for an entire source type to be requested at run-time. When requested, the documentation is built from the XML read in.
Example manager events:
Event: ChanSpyStart
[Synopsis]
Raised when a channel has started spying on another channel.
[Syntax]
Event: ChanSpyStart
SpyerChannel: <value>
SpyeeChannel: <value>
[See Also]
ChanSpy(), ExtenSpy(), ChanSpyStop
-----------------------
Event: Dial
[Synopsis]
Raised when a dial action has started.
[Syntax]
Event: Dial
SubEvent: <value>
Channel: <value>
Destination: <value>
CallerIDNum: <value>
CallerIDName: <value>
ConnectedLineNum: <value>
ConnectedLineName: <value>
UniqueID: <value>
DestUniqueID: <value>
Dialstring: <value>
[Arguments]
SubEvent
Begin
End
A sub event type, specifying whether or not the dial action has begun
or ended.
[Synopsis]
Raised when a dial action has ended.
[Syntax]
Event: Dial
DialStatus: <value>
SubEvent: <value>
Channel: <value>
UniqueID: <value>
[Arguments]
DialStatus
The value of the ${DIALSTATUS} channel variable.
SubEvent
Begin
End
A sub event type, specifying whether or not the dial action has begun
or ended.
---------------------------------
Event: QueueMemberStatus
[Synopsis]
Raised when a Queue member's status has changed.
[Syntax]
Event: QueueMemberStatus
Queue: <value>
Location: <value>
MemberName: <value>
StateInterface: <value>
Membership: <value>
Penalty: <value>
CallsTaken: <value>
LastCall: <value>
Status: <value>
Paused: <value>
[Arguments]
Queue
The name of the queue.
Location
The queue member's channel technology or location.
MemberName
The name of the queue member.
StateInterface
Channel technology or location from which to read device state
changes.
Membership
dynamic
realtime
static
Penalty
The penalty associated with the queue member.
CallsTaken
The number of calls this queue member has serviced.
LastCall
The time this member last took call, expressed in seconds since 00:00,
Jan 1, 1970 UTC.
Status
The status of the queue member. This will be a device state value.
Paused
0
1</pre>
</td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>./trunk/apps/app_chanspy.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_confbridge.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_dial.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_meetme.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_queue.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_stack.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_userevent.c <span style="color: grey">(367982)</span></li>
<li>./trunk/apps/app_voicemail.c <span style="color: grey">(367982)</span></li>
<li>./trunk/build_tools/get_documentation.py <span style="color: grey">(PRE-CREATION)</span></li>
<li>./trunk/build_tools/make_version <span style="color: grey">(367982)</span></li>
<li>./trunk/build_tools/post_process_documentation.py <span style="color: grey">(PRE-CREATION)</span></li>
<li>./configure <span style="color: grey">(UNKNOWN)</span></li>
<li>./trunk/Makefile <span style="color: grey">(367982)</span></li>
<li>./trunk/configure.ac <span style="color: grey">(367982)</span></li>
<li>./trunk/doc/appdocsxml.dtd <span style="color: grey">(367982)</span></li>
<li>./trunk/include/asterisk/xmldoc.h <span style="color: grey">(367982)</span></li>
<li>./trunk/main/manager.c <span style="color: grey">(367982)</span></li>
<li>./trunk/main/xmldoc.c <span style="color: grey">(367982)</span></li>
<li>./trunk/makeopts.in <span style="color: grey">(367982)</span></li>
</ul>
<p><a href="https://reviewboard.asterisk.org/r/1967/diff/" style="margin-left: 3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>