Cleaned up comment

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@142181 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/main/callerid.c b/main/callerid.c
index 1fcd325cedac905b90dee1e9a521d4d7e6bec1fb..6a086adfc6013ec3720ebc2cb7ba667bf0dfeb3b 100644 (file)
--- a/main/callerid.c
+++ b/main/callerid.c
@@ -994,16 +994,16 @@ int ast_is_shrinkable_phonenumber(const char *exten)
        return ast_is_valid_string(exten, "0123456789*#+()-.");
 }
 
-/*! \brief parse string for caller id information 
-       \return always returns 0, as the code always returns something.
-  XXX note that 'name' is not parsed consistently e.g. we have
-
-       input                   location        name
-       " foo bar " <123>       123             ' foo bar ' (with spaces around)
-       " foo bar "             NULL            'foo bar' (without spaces around)
-       " foo bar  <123>"       123             '" foo bar'
-  The parsing of leading and trailing space/quotes should be more consistent.
-*/
+/*!
+ * \brief Destructively parse instr for caller id information 
+ * \return always returns 0, as the code always returns something.
+ * \note XXX 'name' is not parsed consistently e.g. we have
+ * input                   location        name
+ * " foo bar " <123>       123             ' foo bar ' (with spaces around)
+ * " foo bar "             NULL            'foo bar' (without spaces around)
+ * " foo bar  <123>"       123             '" foo bar'
+ * The parsing of leading and trailing space/quotes should be more consistent.
+ */
 int ast_callerid_parse(char *instr, char **name, char **location)
 {
        char *ns, *ne, *ls, *le;