mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-07 02:18:15 +00:00
Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
Copied from my review board description: This is a continuation of the API changes documentation started for describing changes between releases. Most of the API changes were pretty simple needing only to be brought to attention via the new "Asterisk API Changes" list. However, if you see anything that needs further explanation feel free to supplement what is there. The current method of documenting is to add (in the header file): \version <ver number> <description of changes> and then to add the function to the change list in doxyref.h on the AstAPIChanges page. I also made sure all the functions that were newly added were tagged with \since 1.6.1. I think this is a good habit to start both for the historical aspect as well as for the future ability to easily add a "New Asterisk API" page. Review: http://reviewboard.digium.com/r/190/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@180719 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
@@ -50,6 +50,7 @@ struct ast_dnsmgr_entry;
|
||||
* is already known.
|
||||
*
|
||||
* \return a DNS manager entry
|
||||
* \version 1.6.1 result changed from struct in_addr to struct sockaddr_in to store port number
|
||||
*/
|
||||
struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct sockaddr_in *result, const char *service);
|
||||
|
||||
@@ -75,6 +76,7 @@ void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry);
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval non-zero failure
|
||||
* \version 1.6.1 result changed from struct in_addr to struct aockaddr_in to store port number
|
||||
*/
|
||||
int ast_dnsmgr_lookup(const char *name, struct sockaddr_in *result, struct ast_dnsmgr_entry **dnsmgr, const char *service);
|
||||
|
||||
@@ -82,7 +84,7 @@ int ast_dnsmgr_lookup(const char *name, struct sockaddr_in *result, struct ast_d
|
||||
* \brief Force a refresh of a dnsmgr entry
|
||||
*
|
||||
* \retval non-zero if the result is different than the previous result
|
||||
* \retval zero if the result is the same as the previous result
|
||||
* \retval zero if the result is the same as the previous result
|
||||
*/
|
||||
int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user