[svn-commits] dhubbard: branch dhubbard/pinecowbell r166257 - /team/dhubbard/pinecowbell/ch...

[SVN commits to the Digium repositories]

Author: dhubbard
Date: Sun Dec 21 20:11:52 2008
New Revision: 166257

URL: http://svn.digium.com/view/asterisk?view=rev&rev=166257
Log:
doxygenize

Modified:
    team/dhubbard/pinecowbell/channels/chan_dahdi.c

Modified: team/dhubbard/pinecowbell/channels/chan_dahdi.c
URL: http://svn.digium.com/view/asterisk/team/dhubbard/pinecowbell/channels/chan_dahdi.c?view=diff&rev=166257&r1=166256&r2=166257
==============================================================================
--- team/dhubbard/pinecowbell/channels/chan_dahdi.c (original)
+++ team/dhubbard/pinecowbell/channels/chan_dahdi.c Sun Dec 21 20:11:52 2008
@@ -261,11 +261,19 @@
 #ifdef HAVE_PRI_SERVICE_MESSAGES
 /*! \brief Persistent Service State */
 #define SRVST_DBKEY "service-state"
+/*! \brief The out-of-service SERVICE state */
 #define SRVST_TYPE_OOS "O"
-/* the reason for the service state */
+/*! \brief SRVST_NOREASON is used to indicate a channel being out-of-service 
+ *  The SRVST_NOREASON is mostly used maintain backwards compatibility but also may
+ *  mean that the channel has not yet received a RESTART message.  If a channel is
+ *  out-of-service with this reason a RESTART message will result in the channel
+ *  being put into service. */
 #define SRVST_NOREASON 0
+/*! \brief SRVST_NEAREND is used to indicate that the near end was put out-of-service */
 #define SRVST_NEAREND  (1 << 0)
+/*! \brief SRVST_FAREND is used to indicate that the far end was taken out-of-service */
 #define SRVST_FAREND   (1 << 1)
+/*! \brief SRVST_BOTH is used to indicate that both sides of the channel are out-of-service */
 #define SRVST_BOTH (SRVST_NEAREND | SRVST_FAREND)
 
 /*! \brief The AstDB family */