diff options
author | Matt Jordan <mjordan@digium.com> | 2016-08-13 20:16:58 -0500 |
---|---|---|
committer | Matt Jordan <mjordan@digium.com> | 2016-08-13 22:03:56 -0500 |
commit | 4facaac4083573e509052dbecf29c28019145600 (patch) | |
tree | c1c4060eb212f90505113be94841c256a2091834 /main | |
parent | 232d4fe24f29d4eb831c9fe1948faedd68c39b5d (diff) |
manager: Add <see-also> tags to relate interrelated events/actions together
Change-Id: Idbac539205aa732bf786c4f765577d8e9ff28ba4
Diffstat (limited to 'main')
-rw-r--r-- | main/manager.c | 83 | ||||
-rw-r--r-- | main/stasis_bridges.c | 6 |
2 files changed, 89 insertions, 0 deletions
diff --git a/main/manager.c b/main/manager.c index cdbf5fb18..0ca84b2ca 100644 --- a/main/manager.c +++ b/main/manager.c @@ -149,6 +149,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Logoff the current manager session.</para> </description> + <see-also> + <ref type="manager">Login</ref> + </see-also> </manager> <manager name="Login" language="en_US"> <synopsis> @@ -168,6 +171,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Login Manager.</para> </description> + <see-also> + <ref type="manager">Logoff</ref> + </see-also> </manager> <manager name="Challenge" language="en_US"> <synopsis> @@ -321,6 +327,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>If a channel name is not provided then the variable is considered global.</para> </note> </description> + <see-also> + <ref type="manager">Getvar</ref> + </see-also> </manager> <manager name="Getvar" language="en_US"> <synopsis> @@ -341,6 +350,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>If a channel name is not provided then the variable is considered global.</para> </note> </description> + <see-also> + <ref type="manager">Setvar</ref> + </see-also> </manager> <manager name="GetConfig" language="en_US"> <synopsis> @@ -373,6 +385,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") In the case where a category name is non-unique, a filter may be specified to match only categories with matching variable values.</para> </description> + <see-also> + <ref type="manager">GetConfigJSON</ref> + <ref type="manager">UpdateConfig</ref> + <ref type="manager">CreateConfig</ref> + <ref type="manager">ListCategories</ref> + </see-also> </manager> <manager name="GetConfigJSON" language="en_US"> <synopsis> @@ -397,6 +415,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") In the case where a category name is non-unique, a filter may be specified to match only categories with matching variable values.</para> </description> + <see-also> + <ref type="manager">GetConfig</ref> + <ref type="manager">UpdateConfig</ref> + <ref type="manager">CreateConfig</ref> + <ref type="manager">ListCategories</ref> + </see-also> </manager> <manager name="UpdateConfig" language="en_US"> <synopsis> @@ -488,6 +512,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>This action will modify, create, or delete configuration elements in Asterisk configuration files.</para> </description> + <see-also> + <ref type="manager">GetConfig</ref> + <ref type="manager">GetConfigJSON</ref> + <ref type="manager">CreateConfig</ref> + <ref type="manager">ListCategories</ref> + </see-also> </manager> <manager name="CreateConfig" language="en_US"> <synopsis> @@ -504,6 +534,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") directory. This action is intended to be used before an UpdateConfig action.</para> </description> + <see-also> + <ref type="manager">GetConfig</ref> + <ref type="manager">GetConfigJSON</ref> + <ref type="manager">UpdateConfig</ref> + <ref type="manager">ListCategories</ref> + </see-also> </manager> <manager name="ListCategories" language="en_US"> <synopsis> @@ -518,6 +554,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>This action will dump the categories in a given file.</para> </description> + <see-also> + <ref type="manager">GetConfig</ref> + <ref type="manager">GetConfigJSON</ref> + <ref type="manager">UpdateConfig</ref> + <ref type="manager">CreateConfig</ref> + </see-also> </manager> <manager name="Redirect" language="en_US"> <synopsis> @@ -553,6 +595,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Redirect (transfer) a call.</para> </description> + <see-also> + <ref type="manager">BlindTransfer</ref> + </see-also> </manager> <manager name="Atxfer" language="en_US"> <synopsis> @@ -573,6 +618,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Attended transfer.</para> </description> + <see-also> + <ref type="managerEvent">AttendedTransfer</ref> + </see-also> </manager> <manager name="Originate" language="en_US"> <synopsis> @@ -697,6 +745,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Will return an <literal>Extension Status</literal> message. The response will include the hint for the extension and the status.</para> </description> + <see-also> + <ref type="managerEvent">ExtensionStatus</ref> + </see-also> </manager> <manager name="PresenceState" language="en_US"> <synopsis> @@ -713,6 +764,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Will return a <literal>Presence State</literal> message. The response will include the presence state and, if set, a presence subtype and custom message.</para> </description> + <see-also> + <ref type="managerEvent">PresenceStatus</ref> + </see-also> </manager> <manager name="AbsoluteTimeout" language="en_US"> <synopsis> @@ -750,6 +804,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Waiting: <literal>0</literal> if messages waiting, <literal>1</literal> if no messages waiting.</para> </description> + <see-also> + <ref type="manager">MailboxCount</ref> + </see-also> </manager> <manager name="MailboxCount" language="en_US"> <synopsis> @@ -770,6 +827,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>NewMessages: <replaceable>count</replaceable></para> <para>OldMessages: <replaceable>count</replaceable></para> </description> + <see-also> + <ref type="manager">MailboxStatus</ref> + </see-also> </manager> <manager name="ListCommands" language="en_US"> <synopsis> @@ -875,6 +935,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Send a reload event.</para> </description> + <see-also> + <ref type="manager">ModuleLoad</ref> + </see-also> </manager> <managerEvent language="en_US" name="CoreShowChannel"> <managerEventInstance class="EVENT_FLAG_CALL"> @@ -987,6 +1050,10 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <description> <para>Loads, unloads or reloads an Asterisk module in a running system.</para> </description> + <see-also> + <ref type="manager">Reload</ref> + <ref type="manager">ModuleCheck</ref> + </see-also> </manager> <manager name="ModuleCheck" language="en_US"> <synopsis> @@ -1002,6 +1069,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Checks if Asterisk module is loaded. Will return Success/Failure. For success returns, the module revision number is included.</para> </description> + <see-also> + <ref type="manager">ModuleLoad</ref> + </see-also> </manager> <manager name="AOCMessage" language="en_US"> <synopsis> @@ -1171,6 +1241,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") this command can be used to create filters that may bypass filters defined in manager.conf</para> </description> + <see-also> + <ref type="manager">FilterList</ref> + </see-also> </manager> <manager name="FilterList" language="en_US"> <synopsis> @@ -1180,6 +1253,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>The filters displayed are for the current session. Only those filters defined in manager.conf will be present upon starting a new session.</para> </description> + <see-also> + <ref type="manager">Filter</ref> + </see-also> </manager> <manager name="BlindTransfer" language="en_US"> <synopsis> @@ -1198,6 +1274,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </description> <see-also> <ref type="manager">Redirect</ref> + <ref type="managerEvent">BlindTransfer</ref> </see-also> </manager> <managerEvent name="ExtensionStatus" language="en_US"> @@ -1275,6 +1352,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") </enumlist> </parameter> </syntax> + <see-also> + <ref type="manager">ExtensionState</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent name="PresenceStatus" language="en_US"> @@ -1288,6 +1368,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <parameter name="Subtype" /> <parameter name="Message" /> </syntax> + <see-also> + <ref type="manager">PresenceState</ref> + </see-also> </managerEventInstance> </managerEvent> ***/ diff --git a/main/stasis_bridges.c b/main/stasis_bridges.c index 183855773..3688a46ad 100644 --- a/main/stasis_bridges.c +++ b/main/stasis_bridges.c @@ -79,6 +79,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para>Destination extension for the blind transfer.</para> </parameter> </syntax> + <see-also> + <ref type="manager">BlindTransfer</ref> + </see-also> </managerEventInstance> </managerEvent> <managerEvent language="en_US" name="AttendedTransfer"> @@ -131,6 +134,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <para> <replaceable>SecondTransfererChannel</replaceable>: Alice's channel in the bridge with Bob.</para> <para> <replaceable>SecondBridgeUniqueid</replaceable>: The bridge between Alice and Bob.</para> </description> + <see-also> + <ref type="manager">AtxFer</ref> + </see-also> </managerEventInstance> </managerEvent> ***/ |