[asterisk-commits] mmichelson: branch group/issue8824 r186170 - /team/group/issue8824/include/as...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Thu Apr 2 16:14:40 CDT 2009
Author: mmichelson
Date: Thu Apr 2 16:14:37 2009
New Revision: 186170
URL: http://svn.digium.com/svn-view/asterisk?view=rev&rev=186170
Log:
Add doxygen \since tags to new API calls.
Modified:
team/group/issue8824/include/asterisk/callerid.h
team/group/issue8824/include/asterisk/channel.h
Modified: team/group/issue8824/include/asterisk/callerid.h
URL: http://svn.digium.com/svn-view/asterisk/team/group/issue8824/include/asterisk/callerid.h?view=diff&rev=186170&r1=186169&r2=186170
==============================================================================
--- team/group/issue8824/include/asterisk/callerid.h (original)
+++ team/group/issue8824/include/asterisk/callerid.h Thu Apr 2 16:14:37 2009
@@ -395,6 +395,7 @@
};
/*!
+ * \since 1.6.3
* \brief Convert redirecting reason text code to value (used in config file parsing)
*
* \param data text string from config file
@@ -405,6 +406,7 @@
int ast_redirecting_reason_parse(const char *data);
/*!
+ * \since 1.6.3
* \brief Convert redirecting reason value to explanatory string
*
* \param data Q931_REDIRECTING_REASON from callerid.h
@@ -414,6 +416,7 @@
const char *ast_redirecting_reason_describe(int data);
/*!
+ * \since 1.6.3
* \brief Convert redirecting reason value to text code
*
* \param data Q931_REDIRECTING_REASON from callerid.h
@@ -439,6 +442,7 @@
};
/*!
+ * \since 1.6.3
* \brief Convert connected line update source text code to value (used in config file parsing)
*
* \param data text string from config file
@@ -449,6 +453,7 @@
int ast_connected_line_source_parse(const char *data);
/*!
+ * \since 1.6.3
* \brief Convert connected line update source value to explanatory string
*
* \param data AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
@@ -458,6 +463,7 @@
const char *ast_connected_line_source_describe(int data);
/*!
+ * \since 1.6.3
* \brief Convert connected line update source value to text code
*
* \param data AST_CONNECTED_LINE_UPDATE_SOURCE from callerid.h
Modified: team/group/issue8824/include/asterisk/channel.h
URL: http://svn.digium.com/svn-view/asterisk/team/group/issue8824/include/asterisk/channel.h?view=diff&rev=186170&r1=186169&r2=186170
==============================================================================
--- team/group/issue8824/include/asterisk/channel.h (original)
+++ team/group/issue8824/include/asterisk/channel.h Thu Apr 2 16:14:37 2009
@@ -262,6 +262,7 @@
};
/*!
+ * \since 1.6.3
* \brief Information needed to identify an endpoint in a call.
* \note All string fields here are malloc'ed, so they need to be
* freed when the structure is deleted.
@@ -282,6 +283,7 @@
};
/*!
+ * \since 1.6.3
* \brief Connected Line/Party information.
* \note All string fields here are malloc'ed, so they need to be
* freed when the structure is deleted.
@@ -312,6 +314,7 @@
};
/*!
+ * \since 1.6.3
* \brief Redirecting Line information.
* RDNIS (Redirecting Directory Number Information Service)
* Where a call diversion or transfer was invoked.
@@ -2017,6 +2020,7 @@
/*!
+ * \since 1.6.3
* \brief Copy the source caller information to the destination caller.
*
* \param dest Destination caller
@@ -2027,6 +2031,7 @@
void ast_party_caller_copy(struct ast_callerid *dest, const struct ast_callerid *src);
/*!
+ * \since 1.6.3
* \brief Initialize the given connected line structure.
*
* \param init Connected line structure to initialize.
@@ -2036,6 +2041,7 @@
void ast_party_connected_line_init(struct ast_party_connected_line *init);
/*!
+ * \since 1.6.3
* \brief Copy the source connected line information to the destination connected line.
*
* \param dest Destination connected line
@@ -2046,6 +2052,7 @@
void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
/*!
+ * \since 1.6.3
* \brief Initialize the given connected line structure using the given
* guide for a set update operation.
*
@@ -2064,6 +2071,7 @@
void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
/*!
+ * \since 1.6.3
* \brief Set the connected line information based on another connected line source
*
* This is similar to ast_party_connected_line_copy, except that NULL values for
@@ -2077,6 +2085,7 @@
void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
/*!
+ * \since 1.6.3
* \brief Collect the caller party information into a connected line structure.
*
* \param connected Collected caller information for the connected line
@@ -2091,6 +2100,7 @@
void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_callerid *cid);
/*!
+ * \since 1.6.3
* \brief Destroy the connected line information contents
*
* \param doomed The connected line information to destroy.
@@ -2100,6 +2110,7 @@
void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
/*!
+ * \since 1.6.3
* \brief Copy the source redirecting information to the destination redirecting.
*
* \param dest Destination redirecting
@@ -2110,6 +2121,7 @@
void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
/*!
+ * \since 1.6.3
* \brief Initialize the given redirecting id structure using the given guide
* for a set update operation.
*
@@ -2128,6 +2140,7 @@
void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
/*!
+ * \since 1.6.3
* \brief Destroy the redirecting information contents
*
* \param doomed The redirecting information to destroy.
@@ -2137,6 +2150,7 @@
void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
/*!
+ * \since 1.6.3
* \brief Copy the caller information to the connected line information.
*
* \param dest Destination connected line information
@@ -2149,6 +2163,7 @@
void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_callerid *src);
/*!
+ * \since 1.6.3
* \brief Copy the connected line information to the caller information.
*
* \param dest Destination caller information
@@ -2161,6 +2176,7 @@
void ast_connected_line_copy_to_caller(struct ast_callerid *dest, const struct ast_party_connected_line *src);
/*!
+ * \since 1.6.3
* \brief Set the connected line information in the Asterisk channel
*
* \param chan Asterisk channel to set connected line information
@@ -2173,7 +2189,7 @@
void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected);
/*!
- * \internal
+ * \since 1.6.3
* \brief Build the connected line information data frame.
*
* \param data Buffer to fill with the frame data
@@ -2186,6 +2202,7 @@
int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected);
/*!
+ * \since 1.6.3
* \brief Parse connected line indication frame data
*
* \param data Buffer with the frame data to parse
@@ -2204,6 +2221,7 @@
int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
/*!
+ * \since 1.6.3
* \brief Indicate that the connected line information has changed
*
* \param chan Asterisk channel to indicate connected line information
@@ -2214,6 +2232,7 @@
void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected);
/*!
+ * \since 1.6.3
* \brief Queue a connected line update frame on a channel
*
* \param chan Asterisk channel to indicate connected line information
@@ -2224,6 +2243,7 @@
void ast_channel_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected);
/*!
+ * \since 1.6.3
* \brief Set the redirecting id information in the Asterisk channel
*
* \param chan Asterisk channel to set redirecting id information
@@ -2236,6 +2256,7 @@
void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
/*!
+ * \since 1.6.3
* \brief Build the redirecting id data frame.
*
* \param data Buffer to fill with the frame data
@@ -2248,6 +2269,7 @@
int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting);
/*!
+ * \since 1.6.3
* \brief Parse redirecting indication frame data
*
* \param data Buffer with the frame data to parse
@@ -2265,6 +2287,7 @@
int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
/*!
+ * \since 1.6.3
* \brief Indicate that the redirecting id has changed
*
* \param chan Asterisk channel to indicate redirecting id information
@@ -2275,6 +2298,7 @@
void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
/*!
+ * \since 1.6.3
* \brief Queue a redirecting update frame on a channel
*
* \param chan Asterisk channel to indicate redirecting id information
More information about the asterisk-commits
mailing list