kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 03:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Function and Application Relationships to documentation

Browse Source 
Add and extend the see-also sections to the documentation for applications
and functions in an effort to expand the online documentation of the wiki.
Also check for and update any links to moved documentation in the doc folder.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@304913 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Andrew Latham
2011-01-30 00:22:59 +00:00
parent 078f73d697
commit f9c3b26241
6 changed files with 225 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
funcs/func_realtime.c
View File

@@ -67,6 +67,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
If there is no match, NULL will be returned by the function.
On a write, this function will always return NULL.</para>
</description>
<see-also>
<ref type="function">REALTIME_STORE</ref>
<ref type="function">REALTIME_DESTROY</ref>
<ref type="function">REALTIME_FIELD</ref>
<ref type="function">REALTIME_HASH</ref>
</see-also>
</function>
<function name="REALTIME_STORE" language="en_US">
<synopsis>
@@ -84,6 +90,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
creates channel variable named RTSTOREID, which contains value of unique ID.
Currently, a maximum of 30 field/value pairs is supported.</para>
</description>
<see-also>
<ref type="function">REALTIME</ref>
<ref type="function">REALTIME_DESTROY</ref>
<ref type="function">REALTIME_FIELD</ref>
<ref type="function">REALTIME_HASH</ref>
</see-also>
</function>
<function name="REALTIME_DESTROY" language="en_US">
<synopsis>
@@ -100,6 +112,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<para>This function acts in the same way as REALTIME(....) does, except that
it destroys the matched record in the RT engine.</para>
</description>
<see-also>
<ref type="function">REALTIME</ref>
<ref type="function">REALTIME_STORE</ref>
<ref type="function">REALTIME_FIELD</ref>
<ref type="function">REALTIME_HASH</ref>
</see-also>
</function>
<function name="REALTIME_FIELD" language="en_US">
<synopsis>
@@ -117,6 +135,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
<replaceable>value</replaceable>. When written to, the REALTIME_FIELD() function
performs identically to the REALTIME() function.</para>
</description>
<see-also>
<ref type="function">REALTIME</ref>
<ref type="function">REALTIME_STORE</ref>
<ref type="function">REALTIME_DESTROY</ref>
<ref type="function">REALTIME_HASH</ref>
</see-also>
</function>
<function name="REALTIME_HASH" language="en_US">
<synopsis>
@@ -134,6 +158,12 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
it can be assigned to the HASH() function. The HASH() function then provides
a suitable method for retrieving each field value of the record.</para>
</description>
<see-also>
<ref type="function">REALTIME</ref>
<ref type="function">REALTIME_STORE</ref>
<ref type="function">REALTIME_DESTROY</ref>
<ref type="function">REALTIME_FIELD</ref>
</see-also>
</function>
***/