diff options
| author | Kinsey Moore <kmoore@digium.com> | 2013-08-01 17:07:52 +0000 |
|---|---|---|
| committer | Kinsey Moore <kmoore@digium.com> | 2013-08-01 17:07:52 +0000 |
| commit | 03090a88bab15b94843e3850df68b37ff8948b54 (patch) | |
| tree | b32e51b384941143881c82dbb1a2d90e8de3536f /main/core_local.c | |
| parent | 5601b0f50cf30fd05c97a44ff7e18c20f58fc947 (diff) | |
Fix documentation replication issues
This prevents XML documentation duplication by expanding channel and
bridge snapshot tags into channel and bridge snapshot parameter sets
with a given prefix or defaulting to no prefix. This also prevents
documentation from becoming fractured and out of date by keeping all
variations of the documentation in template form such that it only
needs to be updated once and keeps maintenance to a minimum.
Review: https://reviewboard.asterisk.org/r/2708/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@395985 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'main/core_local.c')
| -rw-r--r-- | main/core_local.c | 86 |
1 files changed, 6 insertions, 80 deletions
diff --git a/main/core_local.c b/main/core_local.c index 961a28096..3cdff9503 100644 --- a/main/core_local.c +++ b/main/core_local.c @@ -72,82 +72,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <managerEventInstance class="EVENT_FLAG_CALL"> <synopsis>Raised when two halves of a Local Channel form a bridge.</synopsis> <syntax> - <parameter name="LocalOneChannel"> - </parameter> - <parameter name="LocalOneChannelState"> - <para>A numeric code for the channel's current state, related to ChannelStateDesc</para> - </parameter> - <parameter name="LocalOneChannelStateDesc"> - <enumlist> - <enum name="Down"/> - <enum name="Rsrvd"/> - <enum name="OffHook"/> - <enum name="Dialing"/> - <enum name="Ring"/> - <enum name="Ringing"/> - <enum name="Up"/> - <enum name="Busy"/> - <enum name="Dialing Offhook"/> - <enum name="Pre-ring"/> - <enum name="Unknown"/> - </enumlist> - </parameter> - <parameter name="LocalOneCallerIDNum"> - </parameter> - <parameter name="LocalOneCallerIDName"> - </parameter> - <parameter name="LocalOneConnectedLineNum"> - </parameter> - <parameter name="LocalOneConnectedLineName"> - </parameter> - <parameter name="LocalOneAccountCode"> - </parameter> - <parameter name="LocalOneContext"> - </parameter> - <parameter name="LocalOneExten"> - </parameter> - <parameter name="LocalOnePriority"> - </parameter> - <parameter name="LocalOneUniqueid"> - </parameter> - <parameter name="LocalTwoChannel"> - </parameter> - <parameter name="LocalTwoChannelState"> - <para>A numeric code for the channel's current state, related to ChannelStateDesc</para> - </parameter> - <parameter name="LocalTwoChannelStateDesc"> - <enumlist> - <enum name="Down"/> - <enum name="Rsrvd"/> - <enum name="OffHook"/> - <enum name="Dialing"/> - <enum name="Ring"/> - <enum name="Ringing"/> - <enum name="Up"/> - <enum name="Busy"/> - <enum name="Dialing Offhook"/> - <enum name="Pre-ring"/> - <enum name="Unknown"/> - </enumlist> - </parameter> - <parameter name="LocalTwoCallerIDNum"> - </parameter> - <parameter name="LocalTwoCallerIDName"> - </parameter> - <parameter name="LocalTwoConnectedLineNum"> - </parameter> - <parameter name="LocalTwoConnectedLineName"> - </parameter> - <parameter name="LocalTwoAccountCode"> - </parameter> - <parameter name="LocalTwoContext"> - </parameter> - <parameter name="LocalTwoExten"> - </parameter> - <parameter name="LocalTwoPriority"> - </parameter> - <parameter name="LocalTwoUniqueid"> - </parameter> + <channel_snapshot prefix="LocalOne"/> + <channel_snapshot prefix="LocalTwo"/> <parameter name="Context"> <para>The context in the dialplan that Channel2 starts in.</para> </parameter> @@ -168,8 +94,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <synopsis>Raised when two halves of a Local Channel begin to optimize themselves out of the media path.</synopsis> <syntax> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='LocalBridge']/managerEventInstance/syntax/parameter[contains(@name, 'LocalOne')])" /> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='LocalBridge']/managerEventInstance/syntax/parameter[contains(@name, 'LocalTwo')])" /> + <channel_snapshot prefix="LocalOne"/> + <channel_snapshot prefix="LocalTwo"/> </syntax> <see-also> <ref type="managerEvent">LocalOptimizationEnd</ref> @@ -182,8 +108,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") <synopsis>Raised when two halves of a Local Channel have finished optimizing themselves out of the media path.</synopsis> <syntax> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='LocalBridge']/managerEventInstance/syntax/parameter[contains(@name, 'LocalOne')])" /> - <xi:include xpointer="xpointer(/docs/managerEvent[@name='LocalBridge']/managerEventInstance/syntax/parameter[contains(@name, 'LocalTwo')])" /> + <channel_snapshot prefix="LocalOne"/> + <channel_snapshot prefix="LocalTwo"/> </syntax> <see-also> <ref type="managerEvent">LocalOptimizationBegin</ref> |