[asterisk-addons-commits] mnicholson: branch mnicholson/chan-mobile-refactor r803 - /team/mnicholson/ch...

SVN commits to the Asterisk addons project asterisk-addons-commits at lists.digium.com
Fri Mar 13 11:29:24 CDT 2009


Author: mnicholson
Date: Fri Mar 13 11:29:19 2009
New Revision: 803

URL: http://svn.digium.com/svn-view/asterisk-addons?view=rev&rev=803
Log:
cleaned up doxygen docs

Modified:
    team/mnicholson/chan-mobile-refactor/channels/chan_mobile.c

Modified: team/mnicholson/chan-mobile-refactor/channels/chan_mobile.c
URL: http://svn.digium.com/svn-view/asterisk-addons/team/mnicholson/chan-mobile-refactor/channels/chan_mobile.c?view=diff&rev=803&r1=802&r2=803
==============================================================================
--- team/mnicholson/chan-mobile-refactor/channels/chan_mobile.c (original)
+++ team/mnicholson/chan-mobile-refactor/channels/chan_mobile.c Fri Mar 13 11:29:19 2009
@@ -274,7 +274,7 @@
 #define HFP_CIND_CALLSETUP_OUTGOING	2
 #define HFP_CIND_CALLSETUP_ALERTING	3
 
-/*
+/*!
  * \brief This struct holds HFP features that we support.
  */
 struct hfp_hf {
@@ -287,7 +287,7 @@
 	int control:1;	/*!< enhanced call control*/
 };
 
-/*
+/*!
  * \brief This struct holds HFP features the AG supports.
  */
 struct hfp_ag {
@@ -302,7 +302,7 @@
 	int errors:1;	/*!< extended error result codes*/
 };
 
-/*
+/*!
  * \brief This struct holds mappings for indications.
  */
 struct hfp_cind {
@@ -316,7 +316,7 @@
 };
 
 
-/*
+/*!
  * \brief This struct holds state information about the current hfp connection.
  */
 struct hfp_pvt {
@@ -1224,7 +1224,7 @@
 
 }
 
-/*
+/*!
  * \brief Write to an rfcomm socket.
  * \param rsock the socket to write to
  * \param buf the null terminated buffer to write
@@ -1241,7 +1241,7 @@
 }
 
 
-/*
+/*!
  * \brief Write to an rfcomm socket.
  * \param rsock the socket to write to
  * \param buf the buffer to write
@@ -1271,7 +1271,7 @@
 	return 0;
 }
 
-/*
+/*!
  * \brief Wait for activity on an rfcomm socket.
  * \param rsock the socket to watch
  * \param ms a pointer to an int containing a timeout in ms
@@ -1710,7 +1710,7 @@
  * Hayes AT command helpers.
  */
 
-/*
+/*!
  * \brief Match the given buffer with the given prefix.
  * \param buf the buffer to match
  * \param prefix the prefix to match
@@ -1720,7 +1720,7 @@
 	return !strncmp(buf, prefix, strlen(prefix));
 }
 
-/*
+/*!
  * \brief Read an AT message and clasify it.
  * \param rsock an rfcomm socket
  * \param buf the buffer to store the result in
@@ -1769,7 +1769,7 @@
 	}
 }
 
-/*
+/*!
  * \brief Read an AT message and clasify it.
  * \param rsock an rfcomm socket
  * \return the type of message received
@@ -1845,7 +1845,7 @@
  * bluetooth handsfree profile helpers
  */
 
-/*
+/*!
  * \brief Initilize an HFP service level connection.
  * \param pvt an hfp_pvt struct
  *
@@ -1941,7 +1941,7 @@
 }
 
 
-/*
+/*!
  * \brief Wait a default timeout.
  * \return zero on timeout and non zero on data
  */
@@ -1951,7 +1951,7 @@
 	return rfcomm_wait(pvt->rsock, &ms);
 }
 
-/*
+/*!
  * \brief Parse a CIEV event.
  * \param pvt an hfp_pvt struct
  * \param buf the buffer to parse (null terminated)
@@ -1979,7 +1979,7 @@
 	return pvt->cind_index[i];
 }
 
-/*
+/*!
  * \brief Parse a CLIP event.
  * \param pvt an hfp_pvt struct
  * \param buf the buffer to parse (null terminated)
@@ -2025,7 +2025,7 @@
 	return clip;
 }
 
-/*
+/*!
  * \brief Parse a CMTI notification.
  * \param pvt an hfp_pvt struct
  * \param buf the buffer to parse (null terminated)
@@ -2047,7 +2047,7 @@
 	return index;
 }
 
-/*
+/*!
  * \brief Parse a CMGR message.
  * \param pvt an hfp_pvt struct
  * \param buf the buffer to parse (null terminated)
@@ -2113,8 +2113,10 @@
 	return 0;
 }
 
-/*
+/*!
  * \brief Convert a hfp_hf struct to a BRSF int.
+ * \param hf an hfp_hf brsf object
+ * \return an integer representing the given brsf struct
  */
 static int hfp_brsf2int(struct hfp_hf *hf)
 {
@@ -2131,8 +2133,12 @@
 	return brsf;
 }
 
-/*
+/*!
  * \brief Convert a BRSF int to an hfp_ag struct.
+ * \param brsf a brsf integer
+ * \param ag a AG (hfp_ag) brsf object
+ * \return a pointer to the given hfp_ag object populated with the values from
+ * the given brsf integer
  */
 static struct hfp_ag *hfp_int2brsf(int brsf, struct hfp_ag *ag)
 {
@@ -2150,7 +2156,7 @@
 }
 
 
-/*
+/*!
  * \brief Send a BRSF request.
  * \param pvt an hfp_pvt struct
  * \param brsf an hfp_hf brsf struct
@@ -2165,7 +2171,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send the CIND read command.
  * \param pvt an hfp_pvt struct
  */
@@ -2174,7 +2180,7 @@
 	return rfcomm_write(pvt->rsock, "AT+CIND?\r");
 }
 
-/*
+/*!
  * \brief Send the CIND test command.
  * \param pvt an hfp_pvt struct
  */
@@ -2183,7 +2189,7 @@
 	return rfcomm_write(pvt->rsock, "AT+CIND=?\r");
 }
 
-/*
+/*!
  * \brief Enable or disable indicator events reporting.
  * \param pvt an hfp_pvt struct
  * \param status enable or disable events reporting (should be 1 or 0)
@@ -2195,7 +2201,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send the current speaker gain level.
  * \param pvt an hfp_pvt struct
  * \param value the value to send (must be between 0 and 15)
@@ -2208,7 +2214,7 @@
 }
 
 #if 0
-/*
+/*!
  * \brief Send the current microphone gain level.
  * \param pvt an hfp_pvt struct
  * \param value the value to send (must be between 0 and 15)
@@ -2221,7 +2227,7 @@
 }
 #endif
 
-/*
+/*!
  * \brief Enable or disable calling line identification.
  * \param pvt an hfp_pvt struct
  * \param status enable or disable calling line identification (should be 1 or
@@ -2234,7 +2240,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send a DTMF command.
  * \param pvt an hfp_pvt struct
  * \param digit the dtmf digit to send
@@ -2264,7 +2270,7 @@
 	}
 }
 
-/*
+/*!
  * \brief Set the SMS mode.
  * \param pvt an hfp_pvt struct
  * \param mode the sms mode (0 = PDU, 1 = Text)
@@ -2276,7 +2282,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Setup SMS new message indication.
  * \param pvt an hfp_pvt struct
  */
@@ -2285,7 +2291,7 @@
 	return rfcomm_write(pvt->rsock, "AT+CNMI=2,1,0,1,0\r");
 }
 
-/*
+/*!
  * \brief Read an SMS message.
  * \param pvt an hfp_pvt struct
  * \param index the location of the requested message
@@ -2297,7 +2303,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Start sending an SMS message.
  * \param pvt an hfp_pvt struct
  * \param number the destination of the message
@@ -2309,7 +2315,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send the text of an SMS message.
  * \param pvt an hfp_pvt struct
  * \param message the text of the message
@@ -2321,7 +2327,7 @@
 	return rfcomm_write(pvt->rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send AT+CHUP.
  * \param pvt an hfp_pvt struct
  */
@@ -2351,7 +2357,7 @@
 	return rfcomm_write(pvt->rsock, "ATA\r");
 }
 
-/*
+/*!
  * \brief Read BRSF data.
  * \param pvt an hfp_pvt struct
  */
@@ -2376,7 +2382,7 @@
 	return 0;
 }
 
-/*
+/*!
  * \brief Parse and store the given indicator.
  * \param pvt an hfp_pvt struct
  * \param group the indicator group
@@ -2401,7 +2407,7 @@
 	return 0;
 }
 
-/*
+/*!
  * \brief Read the result of the AT+CIND? command.
  * \param pvt an hfp_pvt struct
  * \note hfp_send_cind_test() and hfp_read_cind_test() should be called at
@@ -2460,7 +2466,7 @@
 	return 0;
 }
 
-/*
+/*!
  * \brief Read the result of the AT+CIND=? command.
  * \param pvt an hfp_pvt struct
  */
@@ -2574,7 +2580,7 @@
  * Bluetooth Headset Profile helpers
  */
 
-/*
+/*!
  * \brief Send an OK AT response.
  * \param rsock the rfcomm socket to use
  */
@@ -2583,7 +2589,7 @@
 	return rfcomm_write(rsock, "\r\nOK\r\n");
 }
 
-/*
+/*!
  * \brief Send an ERROR AT response.
  * \param rsock the rfcomm socket to use
  */
@@ -2592,7 +2598,7 @@
 	return rfcomm_write(rsock, "\r\nERROR\r\n");
 }
 
-/*
+/*!
  * \brief Send a speaker gain unsolicited AT response
  * \param rsock the rfcomm socket to use
  * \param gain the speaker gain value
@@ -2604,7 +2610,7 @@
 	return rfcomm_write(rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send a microphone gain unsolicited AT response
  * \param rsock the rfcomm socket to use
  * \param gain the microphone gain value
@@ -2616,7 +2622,7 @@
 	return rfcomm_write(rsock, cmd);
 }
 
-/*
+/*!
  * \brief Send a RING unsolicited AT response.
  * \param rsock the rfcomm socket to use
  */
@@ -3823,7 +3829,7 @@
 	return 0;
 }
 
-/*
+/*!
  * \brief Check if the module is unloading.
  * \retval 0 not unloading
  * \retval 1 unloading
@@ -3838,7 +3844,7 @@
 	return res;
 }
 
-/*
+/*!
  * \brief Set the unloading flag.
  */
 static inline void set_unloading()




More information about the asterisk-addons-commits mailing list