[sr-dev] git:master:6b39875c: usrloc: doxygen docs fixes

Module: kamailio Branch: master Commit: 6b39875c2f0d6f475171232890e0c80c09685787 URL: https://github.com/kamailio/kamailio/commit/6b39875c2f0d6f475171232890e0c80… Author: Henning Westerholt <hw(a)kamailio.org> Committer: Henning Westerholt <hw(a)kamailio.org> Date: 2018-03-21T22:04:57+01:00 usrloc: doxygen docs fixes --- Modified: src/modules/usrloc/dlist.c Modified: src/modules/usrloc/dlist.h Modified: src/modules/usrloc/udomain.c Modified: src/modules/usrloc/urecord.c --- Diff: https://github.com/kamailio/kamailio/commit/6b39875c2f0d6f475171232890e0c80… Patch: https://github.com/kamailio/kamailio/commit/6b39875c2f0d6f475171232890e0c80… --- diff --git a/src/modules/usrloc/dlist.c b/src/modules/usrloc/dlist.c index 48b3ee1ef3..f649130a98 100644 --- a/src/modules/usrloc/dlist.c +++ b/src/modules/usrloc/dlist.c @@ -85,7 +85,7 @@ static inline int find_dlist(str* _n, dlist_t** _d) * \param flags contact flags * \param part_idx part index * \param part_max maximal part - * \param GAU options + * \param options options * \return 0 on success, positive if buffer size was not sufficient, negative on failure */ static inline int get_all_db_ucontacts(void *buf, int len, unsigned int flags, @@ -333,7 +333,7 @@ static inline int get_all_db_ucontacts(void *buf, int len, unsigned int flags, * \param flags contact flags * \param part_idx part index * \param part_max maximal part - * \param GAU options + * \param options options * \return 0 on success, positive if buffer size was not sufficient, negative on failure */ static inline int get_all_mem_ucontacts(void *buf, int len, unsigned int flags, @@ -483,7 +483,7 @@ static inline int get_all_mem_ucontacts(void *buf, int len, unsigned int flags, * \param flags contact flags * \param part_idx part index * \param part_max maximal part - * \param GAU options + * \param options options * \return 0 on success, positive if buffer size was not sufficient, negative on failure */ int get_all_ucontacts(void *buf, int len, unsigned int flags, diff --git a/src/modules/usrloc/dlist.h b/src/modules/usrloc/dlist.h index 2ad223120e..2f496b2631 100644 --- a/src/modules/usrloc/dlist.h +++ b/src/modules/usrloc/dlist.h @@ -109,7 +109,7 @@ int synchronize_all_udomains(int istart, int istep); * \param flags contact flags * \param part_idx part index * \param part_max maximal part - * \param GAU options + * \param options options * \return 0 on success, positive if buffer size was not sufficient, negative on failure */ int get_all_ucontacts(void *buf, int len, unsigned int flags, diff --git a/src/modules/usrloc/udomain.c b/src/modules/usrloc/udomain.c index aacca0513b..054f781818 100644 --- a/src/modules/usrloc/udomain.c +++ b/src/modules/usrloc/udomain.c @@ -764,7 +764,7 @@ urecord_t* db_load_urecord(db1_con_t* _c, udomain_t* _d, str *_aor) * \brief Loads from DB all contacts for a RUID * \param _c database connection * \param _d domain - * \param _aor address of record + * \param _ruid record unique id * \return pointer to the record on success, 0 on errors or if nothing is found */ urecord_t* db_load_urecord_by_ruid(db1_con_t* _c, udomain_t* _d, str *_ruid) @@ -1010,8 +1010,10 @@ void mem_delete_urecord(udomain_t* _d, struct urecord* _r) /*! - * \brief Run timer handler for given domain + * \brief Run timer handler for given domain, delete urecords * \param _d domain + * \param istart start of run + * \param istep loop steps */ void mem_timer_udomain(udomain_t* _d, int istart, int istep) { diff --git a/src/modules/usrloc/urecord.c b/src/modules/usrloc/urecord.c index 482c14efcf..598cbd88fe 100644 --- a/src/modules/usrloc/urecord.c +++ b/src/modules/usrloc/urecord.c @@ -735,7 +735,7 @@ static inline struct ucontact* contact_path_match( ucontact_t* ptr, str* _c, str /*! * \brief Match a contact record to a Call-ID only * \param ptr contact record - * \param _c contact string + * \param _callid callid string * \return ptr on successfull match, 0 when they not match */ static inline struct ucontact* contact_match_callidonly( ucontact_t* ptr, str* _callid)