Ignore:
Timestamp:
Jun 17, 2006 4:08:30 AM (18 years ago)
Author:
bennylp
Message:

Modifications all over the place, but mainly only to update Doxygen documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pjproject/trunk/pjsip/include/pjsip/sip_msg.h

    r266 r515  
    2121 
    2222/** 
    23  * @file sip_msg.h 
     23 * @file pjsip/sip_msg.h 
    2424 * @brief SIP Message Structure. 
    2525 */ 
    … …  
    3232 
    3333/** 
    34  * @defgroup PJSIP_MSG SIP Message Structure 
    35  * @ingroup PJSIP 
     34 * @defgroup PJSIP_MSG Messaging Elements 
     35 * @ingroup PJSIP_CORE 
     36 * @brief Various SIP message elements such as methods, headers, URIs, etc. 
    3637 * @{ 
    3738 */ 
    … …  
    155156/////////////////////////////////////////////////////////////////////////////// 
    156157/**  
    157  * @defgroup PJSIP_MSG_HDR Header Fields General Structure. 
    158  * @brief General Header Fields Structure. 
     158 * @defgroup PJSIP_MSG_HDR Header Fields 
     159 * @brief Declarations for various SIP header fields. 
    159160 * @ingroup PJSIP_MSG 
    160161 * @{ 
    … …  
    462463/////////////////////////////////////////////////////////////////////////////// 
    463464/** 
    464  * @addtogroup PJSIP_MSG_MEDIA Media Type 
    465  * @brief Media type definitions and manipulations. 
     465 * @addtogroup PJSIP_MSG_MEDIA Media/MIME Type 
     466 * @brief Media/MIME type declaration and manipulations. 
    466467 * @ingroup PJSIP_MSG 
    467468 * @{ 
    … …  
    655656/** 
    656657 * @defgroup PJSIP_MSG_MSG Message Structure 
    657  * @brief Message structure and operations. 
     658 * @brief SIP message (request and response) structure and operations. 
    658659 * @ingroup PJSIP_MSG 
    659660 * @{ 
    … …  
    846847/////////////////////////////////////////////////////////////////////////////// 
    847848/** 
    848  * @addtogroup PJSIP_MSG_HDR_GEN Header Field: Generic 
    849  * @brief Generic header field which contains header name and value. 
    850  * @ingroup PJSIP_MSG 
     849 * @addtogroup PJSIP_MSG_HDR 
    851850 * @{ 
    852851 */ 
    … …  
    905904 
    906905 
    907 /** 
    908  * @} 
    909  */ 
    910  
    911 /////////////////////////////////////////////////////////////////////////////// 
    912 /** 
    913  * @addtogroup PJSIP_MSG_HDR_GEN_INT Header Field: Generic Integer 
    914  * @brief Generic header field which contains header name and value. 
    915  * @ingroup PJSIP_MSG 
    916  * @{ 
    917  */ 
     906 
     907/////////////////////////////////////////////////////////////////////////////// 
    918908 
    919909/** 
    … …  
    965955                                                            int value ); 
    966956 
    967 /** 
    968  * @} 
    969  */ 
    970  
    971 /////////////////////////////////////////////////////////////////////////////// 
    972 /** 
    973  * @defgroup PJSIP_MSG_HDR_GENERIC_LIST Header Field: Generic string list. 
    974  * @brief Header with list of strings separated with comma 
    975  * @ingroup PJSIP_MSG 
    976  * @{ 
    977  */ 
     957/////////////////////////////////////////////////////////////////////////////// 
    978958 
    979959/** Maximum elements in the header array. */ 
    980960#define PJSIP_GENERIC_ARRAY_MAX_COUNT   32 
    981961 
     962/** 
     963 * Generic array of string header. 
     964 */ 
    982965typedef struct pjsip_generic_array_hdr 
    983966{ 
     967    /** Standard header fields. */ 
    984968    PJSIP_DECL_HDR_MEMBER(struct pjsip_generic_array_hdr); 
    985     unsigned    count;                                  /**< Number of elements. */ 
    986     pj_str_t    values[PJSIP_GENERIC_ARRAY_MAX_COUNT];  /**< Elements.           */ 
     969 
     970    /** Number of tags/elements. */ 
     971    unsigned    count; 
     972 
     973    /**< Tags/elements. */ 
     974    pj_str_t    values[PJSIP_GENERIC_ARRAY_MAX_COUNT]; 
     975 
    987976} pjsip_generic_array_hdr; 
    988977 
    … …  
    10191008 
    10201009 
    1021 /** 
    1022  * @} 
    1023  */ 
    1024  
    1025 /////////////////////////////////////////////////////////////////////////////// 
    1026 /** 
    1027  * @defgroup PJSIP_MSG_HDR_ACCEPT Header Field: Accept 
    1028  * @brief Accept header field. 
    1029  * @ingroup PJSIP_MSG 
    1030  * @{ 
    1031  */ 
     1010/////////////////////////////////////////////////////////////////////////////// 
     1011 
    10321012/** Accept header. */ 
    10331013typedef pjsip_generic_array_hdr pjsip_accept_hdr; 
    … …  
    10621042                                                  void *mem ); 
    10631043 
    1064 /** 
    1065  * @} 
    1066  */ 
    1067  
    1068 /////////////////////////////////////////////////////////////////////////////// 
    1069 /** 
    1070  * @defgroup PJSIP_MSG_HDR_ALLOW Header Field: Allow 
    1071  * @brief Allow header field. 
    1072  * @ingroup PJSIP_MSG 
    1073  * @{ 
     1044 
     1045/////////////////////////////////////////////////////////////////////////////// 
     1046 
     1047/** 
     1048 * Allow header. 
    10741049 */ 
    10751050typedef pjsip_generic_array_hdr pjsip_allow_hdr; 
    … …  
    11031078                                                void *mem ); 
    11041079 
    1105 /** 
    1106  * @} 
    1107  */ 
    1108  
    1109 /////////////////////////////////////////////////////////////////////////////// 
    1110 /** 
    1111  * @defgroup PJSIP_MSG_HDR_CID Header Field: Call-ID 
    1112  * @brief Call-ID header field. 
    1113  * @ingroup PJSIP_MSG 
    1114  * @{ 
    1115  */ 
     1080/////////////////////////////////////////////////////////////////////////////// 
     1081 
    11161082/** 
    11171083 * Call-ID header. 
    … …  
    11521118 
    11531119 
    1154 /** 
    1155  * @} 
    1156  */ 
    1157  
    1158 /////////////////////////////////////////////////////////////////////////////// 
    1159 /** 
    1160  * @defgroup PJSIP_MSG_HDR_CLEN Header Field: Content-Length 
    1161  * @brief Content-Length header field. 
    1162  * @ingroup PJSIP_MSG 
    1163  * @{ 
    1164  */ 
     1120 
     1121/////////////////////////////////////////////////////////////////////////////// 
    11651122/** 
    11661123 * Content-Length header. 
    … …  
    11981155 
    11991156 
    1200 /** 
    1201  * @} 
    1202  */ 
    1203  
    1204 /////////////////////////////////////////////////////////////////////////////// 
    1205 /** 
    1206  * @defgroup PJSIP_MSG_HDR_CSEQ Header Field: CSeq 
    1207  * @brief CSeq header field. 
    1208  * @ingroup PJSIP_MSG 
    1209  * @{ 
    1210  */ 
     1157/////////////////////////////////////////////////////////////////////////////// 
    12111158/** 
    12121159 * CSeq header. 
    … …  
    12441191                                              void *mem ); 
    12451192 
    1246 /** 
    1247  * @} 
    1248  */ 
    1249  
    1250 /////////////////////////////////////////////////////////////////////////////// 
    1251 /** 
    1252  * @defgroup PJSIP_MSG_HDR_CONTACT Header Field: Contact 
    1253  * @brief Contact header field. 
    1254  * @ingroup PJSIP_MSG 
    1255  * @{ 
    1256  */ 
     1193/////////////////////////////////////////////////////////////////////////////// 
    12571194/** 
    12581195 * Contact header. 
    … …  
    12971234                                                    void *mem ); 
    12981235 
    1299 /** 
    1300  * @} 
    1301  */ 
    1302  
    1303 /////////////////////////////////////////////////////////////////////////////// 
    1304 /** 
    1305  * @defgroup PJSIP_MSG_HDR_CTYPE Header Field: Content-Type 
    1306  * @brief Content-Type header field. 
    1307  * @ingroup PJSIP_MSG 
    1308  * @{ 
    1309  */ 
     1236 
     1237/////////////////////////////////////////////////////////////////////////////// 
    13101238/** 
    13111239 * Content-Type. 
    … …  
    13431271                                                void *mem ); 
    13441272 
    1345 /** 
    1346  * @} 
    1347  */ 
    1348  
    1349 /////////////////////////////////////////////////////////////////////////////// 
    1350 /** 
    1351  * @defgroup PJSIP_MSG_HDR_EXPIRES Header Field: Expires 
    1352  * @brief Expires header field. 
    1353  * @ingroup PJSIP_MSG 
    1354  * @{ 
    1355  */ 
     1273/////////////////////////////////////////////////////////////////////////////// 
    13561274/** Expires header. */ 
    13571275typedef pjsip_generic_int_hdr pjsip_expires_hdr; 
    … …  
    13881306 
    13891307 
    1390 /** 
    1391  * @} 
    1392  */ 
    1393  
    1394 /////////////////////////////////////////////////////////////////////////////// 
    1395 /** 
    1396  * @defgroup PJSIP_MSG_HDR_FROMTO Header Field: From/To 
    1397  * @brief From and To header field. 
    1398  * @ingroup PJSIP_MSG 
    1399  * @{ 
    1400  */ 
     1308 
     1309/////////////////////////////////////////////////////////////////////////////// 
    14011310/** 
    14021311 * To or From header. 
    … …  
    14691378 * Convert the header to a From header. 
    14701379 * 
    1471  * @param pool  The pool. 
    1472  * @return      "From" header. 
     1380 * @param hdr       The generic from/to header. 
     1381 * @return          "From" header. 
    14731382 */ 
    14741383PJ_DECL(pjsip_from_hdr*) pjsip_fromto_hdr_set_from( pjsip_fromto_hdr *hdr ); 
    … …  
    14771386 * Convert the header to a To header. 
    14781387 * 
    1479  * @param pool  The pool. 
    1480  * @return      "To" header. 
     1388 * @param hdr       The generic from/to header. 
     1389 * @return          "To" header. 
    14811390 */ 
    14821391PJ_DECL(pjsip_to_hdr*)   pjsip_fromto_hdr_set_to( pjsip_fromto_hdr *hdr ); 
    14831392 
    1484 /** 
    1485  * @} 
    1486  */ 
    1487  
    1488  
    1489 /////////////////////////////////////////////////////////////////////////////// 
    1490 /** 
    1491  * @defgroup PJSIP_MSG_HDR_MAX_FORWARDS Header Field: Max-Forwards 
    1492  * @brief Max-Forwards header field. 
    1493  * @ingroup PJSIP_MSG 
    1494  * @{ 
     1393 
     1394/////////////////////////////////////////////////////////////////////////////// 
     1395/** 
     1396 * Max-Forwards header. 
    14951397 */ 
    14961398typedef pjsip_generic_int_hdr pjsip_max_fwd_hdr; 
    … …  
    15261428pjsip_max_fwd_hdr_init( pj_pool_t *pool, void *mem, int value ); 
    15271429 
    1528 /** 
    1529  * @} 
    1530  */ 
    1531  
    1532  
    1533 /////////////////////////////////////////////////////////////////////////////// 
    1534 /** 
    1535  * @defgroup PJSIP_MSG_HDR_MIN_EXPIRES Header Field: Min-Expires 
    1536  * @brief Min-Expires header field. 
    1537  * @ingroup PJSIP_MSG 
    1538  * @{ 
     1430 
     1431/////////////////////////////////////////////////////////////////////////////// 
     1432/** 
     1433 * Min-Expires header. 
    15391434 */ 
    15401435typedef pjsip_generic_int_hdr pjsip_min_expires_hdr; 
    … …  
    15711466                                                            int value ); 
    15721467 
    1573 /** 
    1574  * @} 
    1575  */ 
    1576  
    1577  
    1578 /////////////////////////////////////////////////////////////////////////////// 
    1579 /** 
    1580  * @defgroup PJSIP_MSG_HDR_ROUTING Header Field: Record-Route/Route 
    1581  * @brief Record-Route and Route header fields. 
    1582  * @ingroup PJSIP_MSG 
    1583  * @{ 
    1584  */ 
     1468 
     1469/////////////////////////////////////////////////////////////////////////////// 
    15851470/** 
    15861471 * Record-Route and Route headers. 
    … …  
    15901475    PJSIP_DECL_HDR_MEMBER(struct pjsip_routing_hdr);  /**< Generic header fields. */ 
    15911476    pjsip_name_addr  name_addr;   /**< The URL in the Route/Record-Route header. */ 
    1592     pjsip_param      other_param; /** Other parameter. */ 
     1477    pjsip_param      other_param; /**< Other parameter. */ 
    15931478} pjsip_routing_hdr; 
    15941479 
    … …  
    16661551PJ_DECL(pjsip_route_hdr*)   pjsip_routing_hdr_set_route( pjsip_routing_hdr *r ); 
    16671552 
    1668 /** 
    1669  * @} 
    1670  */ 
    1671  
    1672 /////////////////////////////////////////////////////////////////////////////// 
    1673 /** 
    1674  * @defgroup PJSIP_MSG_HDR_REQUIRE Header Field: Require 
    1675  * @brief Require header field. 
    1676  * @ingroup PJSIP_MSG 
    1677  * @{ 
     1553/////////////////////////////////////////////////////////////////////////////// 
     1554/** 
     1555 * Require header. 
    16781556 */ 
    16791557typedef pjsip_generic_array_hdr pjsip_require_hdr; 
    … …  
    17051583                                                    void *mem ); 
    17061584 
    1707 /** 
    1708  * @} 
    1709  */ 
    1710  
    1711  
    1712 /////////////////////////////////////////////////////////////////////////////// 
    1713 /** 
    1714  * @defgroup PJSIP_MSG_HDR_RETRY_AFTER Header Field: Retry-After 
    1715  * @brief Retry-After header field. 
    1716  * @ingroup PJSIP_MSG 
    1717  * @{ 
     1585 
     1586/////////////////////////////////////////////////////////////////////////////// 
     1587/** 
     1588 * Retry-After header. 
    17181589 */ 
    17191590typedef pjsip_generic_int_hdr pjsip_retry_after_hdr; 
    … …  
    17451616 
    17461617 
    1747 /** 
    1748  * @} 
    1749  */ 
    1750  
    1751 /////////////////////////////////////////////////////////////////////////////// 
    1752 /** 
    1753  * @defgroup PJSIP_MSG_HDR_SUPPORTED Header Field: Supported 
    1754  * @brief Supported header field. 
    1755  * @ingroup PJSIP_MSG 
    1756  * @{ 
     1618/////////////////////////////////////////////////////////////////////////////// 
     1619/** 
     1620 * Supported header. 
    17571621 */ 
    17581622typedef pjsip_generic_array_hdr pjsip_supported_hdr; 
    … …  
    17791643                                                        void *mem ); 
    17801644 
    1781 /** 
    1782  * @} 
    1783  */ 
    1784  
    1785 /////////////////////////////////////////////////////////////////////////////// 
    1786 /** 
    1787  * @defgroup PJSIP_MSG_HDR_UNSUPPORTED Header Field: Unsupported 
    1788  * @brief Unsupported header field. 
    1789  * @ingroup PJSIP_MSG 
    1790  * @{ 
     1645/////////////////////////////////////////////////////////////////////////////// 
     1646/** 
     1647 * Unsupported header. 
    17911648 */ 
    17921649typedef pjsip_generic_array_hdr pjsip_unsupported_hdr; 
    … …  
    18131670                                                            void *mem ); 
    18141671 
    1815 /** 
    1816  * @} 
    1817  */ 
    1818  
    1819  
    1820 /////////////////////////////////////////////////////////////////////////////// 
    1821 /** 
    1822  * @defgroup PJSIP_MSG_HDR_VIA Header Field: Via 
    1823  * @brief Via header field. 
    1824  * @ingroup PJSIP_MSG 
    1825  * @{ 
    1826  */ 
     1672/////////////////////////////////////////////////////////////////////////////// 
    18271673/** 
    18281674 * SIP Via header. 
    … …  
    18661712                                            void *mem ); 
    18671713 
    1868 /** 
    1869  * @} 
    1870  */ 
    1871  
    1872  
    1873 /////////////////////////////////////////////////////////////////////////////// 
    1874 /** 
    1875  * @defgroup PJSIP_MSG_HDR_WARNING Header Field: Warning 
    1876  * @brief Warning header field. 
    1877  * @ingroup PJSIP_MSG 
    1878  * @{ 
    1879  */ 
     1714/////////////////////////////////////////////////////////////////////////////// 
    18801715/** 
    18811716 * SIP Warning header. 
    … …  
    19181753                                      pj_status_t status); 
    19191754 
    1920 /** 
    1921  * @} 
    1922  */ 
    1923  
    1924 /** 
    1925  * @bug Once a header is put in the message, the header CAN NOT be put in 
    1926  *      other list. Solution: 
    1927  *      - always clone header in the message. 
    1928  *      - create a list node for each header in the message. 
    1929  */ 
    1930  
    1931  
    1932 /////////////////////////////////////////////////////////////////////////////// 
    1933 /** 
    1934  * @defgroup PJSIP_MSG_HDR_UNIMP Unimplemented Header Fields 
    1935  * @brief Unimplemented header fields. 
    1936  * @ingroup PJSIP_MSG 
    1937  * @{ 
    1938  */ 
     1755/////////////////////////////////////////////////////////////////////////////// 
    19391756/** Accept-Encoding header. */ 
    19401757typedef pjsip_generic_string_hdr pjsip_accept_encoding_hdr; 
Note: See TracChangeset for help on using the changeset viewer.