Ignore:
Timestamp:
Dec 4, 2013 3:01:20 AM (10 years ago)
Author:
bennylp
Message:

Re #1519: doxygen fixes and other minor fixes

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/persistent.hpp

    r4657 r4672  
    2828#include <string> 
    2929#include <vector> 
     30 
     31/** PJSUA2 API is inside pj namespace */ 
     32namespace pj 
     33{ 
    3034 
    3135/** 
    … …  
    4145 */ 
    4246 
    43 /** PJSUA2 API is inside pj namespace */ 
    44 namespace pj 
    45 { 
    4647using std::string; 
    4748using std::vector; 
    … …  
    262263     * 
    263264     * @param name      The name for the value in the container. 
    264      * @param value     The value to be written. 
     265     * @param num       The value to be written. 
    265266     */ 
    266267    void                writeNumber(const string &name, 
    … …  
    271272     * 
    272273     * @param name      The name for the value in the container. 
    273      * @param value     The value to be written. 
     274     * @param num       The value to be written. 
    274275     */ 
    275276    void                writeInt(const string &name, 
    … …  
    298299     * 
    299300     * @param name      The name for the value in the container. 
    300      * @param array     The vector to be written. 
     301     * @param arr       The vector to be written. 
    301302     */ 
    302303    void                writeStringVector(const string &name, 
    303                                           const StringVector &value) 
     304                                          const StringVector &arr) 
    304305                                          throw(Error); 
    305306 
    … …  
    348349struct container_node_internal_data 
    349350{ 
    350     void        *doc; 
    351     void        *data1; 
    352     void        *data2; 
     351    void        *doc;           /**< The document.      */ 
     352    void        *data1;         /**< Internal data 1    */ 
     353    void        *data2;         /**< Internal data 2    */ 
    353354}; 
    354355 
    … …  
    524525     * 
    525526     * @param name      The name for the value in the container. 
    526      * @param value     The value to be written. 
     527     * @param num       The value to be written. 
    527528     */ 
    528529    void                writeNumber(const string &name, 
    … …  
    533534     * 
    534535     * @param name      The name for the value in the container. 
    535      * @param value     The value to be written. 
     536     * @param num       The value to be written. 
    536537     */ 
    537538    void                writeInt(const string &name, 
    … …  
    560561     * 
    561562     * @param name      The name for the value in the container. 
    562      * @param array     The vector to be written. 
     563     * @param arr       The vector to be written. 
    563564     */ 
    564565    void                writeStringVector(const string &name, 
    565                                           const StringVector &value) 
     566                                          const StringVector &arr) 
    566567                                          throw(Error); 
    567568 
    … …  
    598599public: 
    599600    /* internal data */ 
    600     container_node_op *op; 
    601     container_node_internal_data data; 
     601    container_node_op *op;              /**< Method table.      */ 
     602    container_node_internal_data data;  /**< Internal data      */ 
    602603}; 
    603604 
    … …  
    607608 * implementation notes for more info. 
    608609 */ 
     610//! @cond Doxygen_Suppress 
    609611struct container_node_op 
    610612{ 
    … …  
    652654                                         const string &name) 
    653655                                         throw(Error); 
    654  
    655656}; 
    656  
    657657 
    658658/* 
    … …  
    677677#define NODE_WRITE_OBJ(node,item)       node.writeObject(item) 
    678678 
     679//! @endcond 
     680 
     681/** 
     682 * @}  PJSUA2 
     683 */ 
    679684 
    680685} // namespace pj 
    681686 
    682 /** 
    683  * @}  PJSUA2 
    684  */ 
    685  
    686687 
    687688 
Note: See TracChangeset for help on using the changeset viewer.