Skip to content

Commit 77d5550

Browse files
docs: Add version information to manager event instance XML elements
* Do a git blame on the embedded XML managerEvent elements. * From the commit hash, grab the summary line. * Do a git log --grep <summary> to find the cherry-pick commits in all branches that match. * Do a git patch-id to ensure the commits are all related and didn't get a false match on the summary. * Do a git tag --contains <commit> to find the tags that contain each commit. * Weed out all tags not ..0. * Sort and discard any .0.0 and following tags where the commit appeared in an earlier branch. * The result is a single tag for each branch where the application or function was defined. The events defined in res/res_pjsip/pjsip_manager.xml were done by hand because the XML was extracted from the C source file relatively recently. Two bugs were fixed along the way... * The get_documentation awk script was exiting after it processed the first DOCUMENTATION block it found in a file. We have at least 1 source file with multiple DOCUMENTATION blocks so only the first one in them was being processed. The awk script was changed to continue searching rather than exiting after the first block. * Fixing the awk script revealed an issue in logger.c where the third DOCUMENTATION block contained a XML fragment that consisted only of a managerEventInstance element that wasn't wrapped in a managerEvent element. Since logger_doc.xml already existed, the remaining fragments in logger.c were moved to it and properly organized.
1 parent 53e7401 commit 77d5550

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+197
-26
lines changed

apps/app_agent_pool.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@
181181
</manager>
182182
<managerEvent language="en_US" name="Agents">
183183
<managerEventInstance class="EVENT_FLAG_AGENT">
184+
<since><version>12.0.0</version></since>
184185
<synopsis>
185186
Response event in a series to the Agents AMI action containing
186187
information about a defined agent.
@@ -226,6 +227,7 @@
226227
</managerEvent>
227228
<managerEvent language="en_US" name="AgentsComplete">
228229
<managerEventInstance class="EVENT_FLAG_AGENT">
230+
<since><version>12.0.0</version></since>
229231
<synopsis>
230232
Final response event in a series of events to the Agents AMI action.
231233
</synopsis>

apps/app_confbridge.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,7 @@
322322
</manager>
323323
<managerEvent language="en_US" name="ConfbridgeList">
324324
<managerEventInstance class="EVENT_FLAG_REPORTING">
325+
<since><version>13.20.0</version><version>15.3.0</version></since>
325326
<synopsis>Raised as part of the ConfbridgeList action response list.</synopsis>
326327
<syntax>
327328
<parameter name="Conference">
@@ -401,6 +402,7 @@
401402
</manager>
402403
<managerEvent language="en_US" name="ConfbridgeListRooms">
403404
<managerEventInstance class="EVENT_FLAG_REPORTING">
405+
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
404406
<synopsis>Raised as part of the ConfbridgeListRooms action response list.</synopsis>
405407
<syntax>
406408
<parameter name="Conference">

apps/app_meetme.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -506,6 +506,7 @@
506506
</manager>
507507
<managerEvent language="en_US" name="MeetmeJoin">
508508
<managerEventInstance class="EVENT_FLAG_CALL">
509+
<since><version>12.0.0</version></since>
509510
<synopsis>Raised when a user joins a MeetMe conference.</synopsis>
510511
<syntax>
511512
<parameter name="Meetme">
@@ -524,6 +525,7 @@
524525
</managerEvent>
525526
<managerEvent language="en_US" name="MeetmeLeave">
526527
<managerEventInstance class="EVENT_FLAG_CALL">
528+
<since><version>12.0.0</version></since>
527529
<synopsis>Raised when a user leaves a MeetMe conference.</synopsis>
528530
<syntax>
529531
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@@ -539,6 +541,7 @@
539541
</managerEvent>
540542
<managerEvent language="en_US" name="MeetmeEnd">
541543
<managerEventInstance class="EVENT_FLAG_CALL">
544+
<since><version>12.0.0</version></since>
542545
<synopsis>Raised when a MeetMe conference ends.</synopsis>
543546
<syntax>
544547
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
@@ -550,6 +553,7 @@
550553
</managerEvent>
551554
<managerEvent language="en_US" name="MeetmeTalkRequest">
552555
<managerEventInstance class="EVENT_FLAG_CALL">
556+
<since><version>12.0.0</version></since>
553557
<synopsis>Raised when a MeetMe user has started talking.</synopsis>
554558
<syntax>
555559
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@@ -568,6 +572,7 @@
568572
</managerEvent>
569573
<managerEvent language="en_US" name="MeetmeTalking">
570574
<managerEventInstance class="EVENT_FLAG_CALL">
575+
<since><version>12.0.0</version></since>
571576
<synopsis>Raised when a MeetMe user begins or ends talking.</synopsis>
572577
<syntax>
573578
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@@ -578,6 +583,7 @@
578583
</managerEvent>
579584
<managerEvent language="en_US" name="MeetmeMute">
580585
<managerEventInstance class="EVENT_FLAG_CALL">
586+
<since><version>12.0.0</version></since>
581587
<synopsis>Raised when a MeetMe user is muted or unmuted.</synopsis>
582588
<syntax>
583589
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@@ -588,6 +594,7 @@
588594
</managerEvent>
589595
<managerEvent language="en_US" name="MeetmeList">
590596
<managerEventInstance class="EVENT_FLAG_CALL">
597+
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
591598
<synopsis>Raised in response to a MeetmeList command.</synopsis>
592599
<syntax>
593600
<parameter name="Conference">
@@ -635,6 +642,7 @@
635642
</managerEvent>
636643
<managerEvent language="en_US" name="MeetmeListRooms">
637644
<managerEventInstance class="EVENT_FLAG_CALL">
645+
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
638646
<synopsis>Raised in response to a MeetmeListRooms command.</synopsis>
639647
<syntax>
640648
<parameter name="Conference">

apps/app_minivm.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,7 @@
503503
</function>
504504
<managerEvent language="en_US" name="MiniVoiceMail">
505505
<managerEventInstance class="EVENT_FLAG_CALL">
506+
<since><version>12.0.0</version></since>
506507
<synopsis>Raised when a notification is sent out by a MiniVoiceMail application</synopsis>
507508
<syntax>
508509
<channel_snapshot/>

apps/app_mixmonitor.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,7 @@
319319
</function>
320320
<managerEvent language="en_US" name="MixMonitorStart">
321321
<managerEventInstance class="EVENT_FLAG_CALL">
322+
<since><version>16.17.0</version><version>18.3.0</version></since>
322323
<synopsis>Raised when monitoring has started on a channel.</synopsis>
323324
<syntax>
324325
<channel_snapshot/>
@@ -332,6 +333,7 @@
332333
</managerEvent>
333334
<managerEvent language="en_US" name="MixMonitorStop">
334335
<managerEventInstance class="EVENT_FLAG_CALL">
336+
<since><version>16.17.0</version><version>18.3.0</version></since>
335337
<synopsis>Raised when monitoring has stopped on a channel.</synopsis>
336338
<syntax>
337339
<channel_snapshot/>
@@ -345,6 +347,7 @@
345347
</managerEvent>
346348
<managerEvent language="en_US" name="MixMonitorMute">
347349
<managerEventInstance class="EVENT_FLAG_CALL">
350+
<since><version>16.17.0</version><version>18.3.0</version></since>
348351
<synopsis>Raised when monitoring is muted or unmuted on a channel.</synopsis>
349352
<syntax>
350353
<channel_snapshot/>

apps/app_queue.c

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1134,6 +1134,7 @@
11341134
11351135
<managerEvent language="en_US" name="QueueParams">
11361136
<managerEventInstance class="EVENT_FLAG_AGENT">
1137+
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
11371138
<synopsis>Raised in response to the QueueStatus action.</synopsis>
11381139
<syntax>
11391140
<parameter name="Max">
@@ -1172,6 +1173,7 @@
11721173
</managerEvent>
11731174
<managerEvent language="en_US" name="QueueEntry">
11741175
<managerEventInstance class="EVENT_FLAG_AGENT">
1176+
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
11751177
<synopsis>Raised in response to the QueueStatus action.</synopsis>
11761178
<syntax>
11771179
<parameter name="Queue">
@@ -1213,6 +1215,7 @@
12131215
</managerEvent>
12141216
<managerEvent language="en_US" name="QueueMemberStatus">
12151217
<managerEventInstance class="EVENT_FLAG_AGENT">
1218+
<since><version>12.0.0</version></since>
12161219
<synopsis>Raised when a Queue member's status has changed.</synopsis>
12171220
<syntax>
12181221
<parameter name="Queue">
@@ -1293,6 +1296,7 @@
12931296
</managerEvent>
12941297
<managerEvent language="en_US" name="QueueMemberAdded">
12951298
<managerEventInstance class="EVENT_FLAG_AGENT">
1299+
<since><version>12.0.0</version></since>
12961300
<synopsis>Raised when a member is added to the queue.</synopsis>
12971301
<syntax>
12981302
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1305,6 +1309,7 @@
13051309
</managerEvent>
13061310
<managerEvent language="en_US" name="QueueMemberRemoved">
13071311
<managerEventInstance class="EVENT_FLAG_AGENT">
1312+
<since><version>12.0.0</version></since>
13081313
<synopsis>Raised when a member is removed from the queue.</synopsis>
13091314
<syntax>
13101315
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1317,6 +1322,7 @@
13171322
</managerEvent>
13181323
<managerEvent language="en_US" name="QueueMemberPause">
13191324
<managerEventInstance class="EVENT_FLAG_AGENT">
1325+
<since><version>12.2.0</version></since>
13201326
<synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
13211327
<syntax>
13221328
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1329,6 +1335,7 @@
13291335
</managerEvent>
13301336
<managerEvent language="en_US" name="QueueMemberPenalty">
13311337
<managerEventInstance class="EVENT_FLAG_AGENT">
1338+
<since><version>12.0.0</version></since>
13321339
<synopsis>Raised when a member's penalty is changed.</synopsis>
13331340
<syntax>
13341341
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1340,6 +1347,7 @@
13401347
</managerEvent>
13411348
<managerEvent language="en_US" name="QueueMemberRinginuse">
13421349
<managerEventInstance class="EVENT_FLAG_AGENT">
1350+
<since><version>12.0.0</version></since>
13431351
<synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
13441352
<syntax>
13451353
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1351,6 +1359,7 @@
13511359
</managerEvent>
13521360
<managerEvent language="en_US" name="QueueCallerJoin">
13531361
<managerEventInstance class="EVENT_FLAG_AGENT">
1362+
<since><version>12.0.0</version></since>
13541363
<synopsis>Raised when a caller joins a Queue.</synopsis>
13551364
<syntax>
13561365
<channel_snapshot/>
@@ -1370,6 +1379,7 @@
13701379
</managerEvent>
13711380
<managerEvent language="en_US" name="QueueCallerLeave">
13721381
<managerEventInstance class="EVENT_FLAG_AGENT">
1382+
<since><version>12.0.0</version></since>
13731383
<synopsis>Raised when a caller leaves a Queue.</synopsis>
13741384
<syntax>
13751385
<channel_snapshot/>
@@ -1384,6 +1394,7 @@
13841394
</managerEvent>
13851395
<managerEvent language="en_US" name="QueueCallerAbandon">
13861396
<managerEventInstance class="EVENT_FLAG_AGENT">
1397+
<since><version>12.0.0</version></since>
13871398
<synopsis>Raised when a caller abandons the queue.</synopsis>
13881399
<syntax>
13891400
<channel_snapshot/>
@@ -1400,6 +1411,7 @@
14001411
</managerEvent>
14011412
<managerEvent language="en_US" name="AgentCalled">
14021413
<managerEventInstance class="EVENT_FLAG_AGENT">
1414+
<since><version>12.0.0</version></since>
14031415
<synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
14041416
<syntax>
14051417
<channel_snapshot/>
@@ -1417,6 +1429,7 @@
14171429
</managerEvent>
14181430
<managerEvent language="en_US" name="AgentRingNoAnswer">
14191431
<managerEventInstance class="EVENT_FLAG_AGENT">
1432+
<since><version>12.0.0</version></since>
14201433
<synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
14211434
<syntax>
14221435
<channel_snapshot/>
@@ -1435,6 +1448,7 @@
14351448
</managerEvent>
14361449
<managerEvent language="en_US" name="AgentComplete">
14371450
<managerEventInstance class="EVENT_FLAG_AGENT">
1451+
<since><version>12.0.0</version></since>
14381452
<synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
14391453
<syntax>
14401454
<channel_snapshot/>
@@ -1462,6 +1476,7 @@
14621476
</managerEvent>
14631477
<managerEvent language="en_US" name="AgentDump">
14641478
<managerEventInstance class="EVENT_FLAG_AGENT">
1479+
<since><version>12.0.0</version></since>
14651480
<synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
14661481
<syntax>
14671482
<channel_snapshot/>
@@ -1478,6 +1493,7 @@
14781493
</managerEvent>
14791494
<managerEvent language="en_US" name="AgentConnect">
14801495
<managerEventInstance class="EVENT_FLAG_AGENT">
1496+
<since><version>12.0.0</version></since>
14811497
<synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
14821498
<syntax>
14831499
<channel_snapshot/>

apps/app_stack.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@
205205
</agi>
206206
<managerEvent language="en_US" name="VarSet">
207207
<managerEventInstance class="EVENT_FLAG_DIALPLAN">
208+
<since><version>12.0.0</version></since>
208209
<synopsis>Raised when a variable local to the gosub stack frame is set due to a subroutine call.</synopsis>
209210
<syntax>
210211
<channel_snapshot/>

apps/app_voicemail.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -573,6 +573,7 @@
573573
</manager>
574574
<managerEvent language="en_US" name="VoicemailPasswordChange">
575575
<managerEventInstance class="EVENT_FLAG_USER">
576+
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
576577
<synopsis>Raised in response to a mailbox password change.</synopsis>
577578
<syntax>
578579
<parameter name="Context">

apps/confbridge/confbridge_manager.c

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
/*** DOCUMENTATION
4040
<managerEvent language="en_US" name="ConfbridgeStart">
4141
<managerEventInstance class="EVENT_FLAG_CALL">
42+
<since><version>12.0.0</version></since>
4243
<synopsis>Raised when a conference starts.</synopsis>
4344
<syntax>
4445
<parameter name="Conference">
@@ -54,6 +55,7 @@
5455
</managerEvent>
5556
<managerEvent language="en_US" name="ConfbridgeEnd">
5657
<managerEventInstance class="EVENT_FLAG_CALL">
58+
<since><version>12.0.0</version></since>
5759
<synopsis>Raised when a conference ends.</synopsis>
5860
<syntax>
5961
<parameter name="Conference">
@@ -69,6 +71,7 @@
6971
</managerEvent>
7072
<managerEvent language="en_US" name="ConfbridgeJoin">
7173
<managerEventInstance class="EVENT_FLAG_CALL">
74+
<since><version>12.0.0</version></since>
7275
<synopsis>Raised when a channel joins a Confbridge conference.</synopsis>
7376
<syntax>
7477
<parameter name="Conference">
@@ -99,6 +102,7 @@
99102
</managerEvent>
100103
<managerEvent language="en_US" name="ConfbridgeLeave">
101104
<managerEventInstance class="EVENT_FLAG_CALL">
105+
<since><version>12.0.0</version></since>
102106
<synopsis>Raised when a channel leaves a Confbridge conference.</synopsis>
103107
<syntax>
104108
<parameter name="Conference">
@@ -122,6 +126,7 @@
122126
</managerEvent>
123127
<managerEvent language="en_US" name="ConfbridgeRecord">
124128
<managerEventInstance class="EVENT_FLAG_CALL">
129+
<since><version>12.0.0</version></since>
125130
<synopsis>Raised when a conference starts recording.</synopsis>
126131
<syntax>
127132
<parameter name="Conference">
@@ -137,6 +142,7 @@
137142
</managerEvent>
138143
<managerEvent language="en_US" name="ConfbridgeStopRecord">
139144
<managerEventInstance class="EVENT_FLAG_CALL">
145+
<since><version>12.0.0</version></since>
140146
<synopsis>Raised when a conference that was recording stops recording.</synopsis>
141147
<syntax>
142148
<parameter name="Conference">
@@ -152,6 +158,7 @@
152158
</managerEvent>
153159
<managerEvent language="en_US" name="ConfbridgeMute">
154160
<managerEventInstance class="EVENT_FLAG_CALL">
161+
<since><version>12.0.0</version></since>
155162
<synopsis>Raised when a Confbridge participant mutes.</synopsis>
156163
<syntax>
157164
<parameter name="Conference">
@@ -175,6 +182,7 @@
175182
</managerEvent>
176183
<managerEvent language="en_US" name="ConfbridgeUnmute">
177184
<managerEventInstance class="EVENT_FLAG_CALL">
185+
<since><version>12.0.0</version></since>
178186
<synopsis>Raised when a confbridge participant unmutes.</synopsis>
179187
<syntax>
180188
<parameter name="Conference">
@@ -198,6 +206,7 @@
198206
</managerEvent>
199207
<managerEvent language="en_US" name="ConfbridgeTalking">
200208
<managerEventInstance class="EVENT_FLAG_CALL">
209+
<since><version>12.0.0</version></since>
201210
<synopsis>Raised when a confbridge participant begins or ends talking.</synopsis>
202211
<syntax>
203212
<parameter name="Conference">

build_tools/get_documentation

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
/\/\*\*\* DOCUMENTATION/ {printit=1; next}
2-
/\*\*\*\// {if (printit) exit}
2+
/\*\*\*\// {if (printit) printit=0}
33
{if (printit) print}

cdr/cdr_manager.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
/*** DOCUMENTATION
4242
<managerEvent language="en_US" name="Cdr">
4343
<managerEventInstance class="EVENT_FLAG_CDR">
44+
<since><version>13.2.0</version></since>
4445
<synopsis>Raised when a CDR is generated.</synopsis>
4546
<syntax>
4647
<parameter name="AccountCode">

cel/cel_manager.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
/*** DOCUMENTATION
3737
<managerEvent language="en_US" name="CEL">
3838
<managerEventInstance class="EVENT_FLAG_CEL">
39+
<since><version>13.2.0</version></since>
3940
<synopsis>Raised when a Channel Event Log is generated for a channel.</synopsis>
4041
<syntax>
4142
<parameter name="EventName">

0 commit comments

Comments
 (0)