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: http://svn.digium.com/svn/asterisk/trunk@180719 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 18 insertions, 9 deletions

diff --git a/include/asterisk/enum.h b/include/asterisk/enum.h
index d19368905..877c0c3cf 100644
--- a/include/asterisk/enum.h
+++ b/include/asterisk/enum.h
@@ -53,7 +53,7 @@ struct enum_context {
 };
 
 
-/*! \brief Lookup entry in ENUM 
+/*! \brief Lookup entry in ENUM
 	\param chan	Channel
 	\param number   E164 number with or without the leading +
 	\param location Number returned	(or SIP uri)
@@ -76,16 +76,25 @@ struct enum_context {
 	\retval 0 if not found
 	\retval -1 on hangup
 */
-int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, 
+int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology,
 		int maxtech, char* suffix, char* options, unsigned int record, struct enum_context **argcontext);
 
-/*!	\brief Lookup DNS TXT record (used by app TXTCIDnum
-	\param chan	Channel
-	\param number   E164 number with or without the leading +
-	\param txt	Text string (return value)
-	\param maxtxt	Max length of "txt"
-	\param suffix	Zone suffix
-*/
+/*!	\brief Lookup DNS TXT record (used by app TXTCIDnum)
+ *
+ * Really has nothing to do with enum, but anyway...
+ * Actually, there is now an internet-draft which describes how callerID should
+ * be stored in ENUM domains: draft-ietf-enum-cnam-04.txt
+ * The algorithm implemented here will thus be obsolete soon.
+ *
+ * \param chan	Channel
+ * \param number   E164 number with or without the leading +
+ * \param txt	Text string (return value)
+ * \param maxtxt	Max length of "txt"
+ * \param suffix	Zone suffix
+ * \version 1.6.1 new suffix parameter to take into account caller ids that aren't in e164.arpa
+ * \version 1.6.1 removed parameters location, maxloc, technology, maxtech as all the information
+ * is stored the txt string
+ */
 int ast_get_txt(struct ast_channel *chan, const char *number, char *txt, int maxtxt, char *suffix);
 
 int ast_enum_init(void);