patch-docs_man3_qbhdb_h_3 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. --- libqb-0.16.0.orig/docs/man3/qbhdb.h.3 2013-07-25 20:16:18.000000000 +0200
  2. +++ libqb-0.16.0/docs/man3/qbhdb.h.3 2013-09-09 05:26:31.447810868 +0200
  3. @@ -1,4 +1,4 @@
  4. -.TH "qbhdb.h" 3 "Thu Jul 25 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  5. +.TH "qbhdb.h" 3 "Mon Sep 9 2013" "Version 0.16.0" "libqb" \" -*- nroff -*-
  6. .ad l
  7. .nh
  8. .SH NAME
  9. @@ -28,7 +28,7 @@ The handle database is for reference cou
  10. .RI "struct \fBqb_hdb\fP"
  11. .br
  12. .in -1c
  13. -.SS "Macros"
  14. +.SS "Defines"
  15. .in +1c
  16. .ti -1c
  17. @@ -108,14 +108,11 @@ The handle database is for reference cou
  18. The handle database is for reference counting objects\&.
  19. -.SH "Macro Definition Documentation"
  20. +.SH "Define Documentation"
  21. .PP
  22. -.SS "#define _GNU_SOURCE"
  23. -
  24. -.SS "#define QB_HDB_D_FORMAT '%'PRIu64"
  25. -
  26. -.SS "#define QB_HDB_DECLARE(database_name, destructor_function)"
  27. -\fBValue:\fP
  28. +.SS "#define \fB_GNU_SOURCE\fP"
  29. +.SS "#define \fBQB_HDB_D_FORMAT\fP '%'PRIu64"
  30. +.SS "#define \fBQB_HDB_DECLARE\fP(database_name, destructor_function)"\fBValue:\fP
  31. .PP
  32. .nf
  33. static struct qb_hdb (database_name) = { \
  34. @@ -129,24 +126,20 @@ static struct qb_hdb (database_name) = {
  35. .PP
  36. Convience macro for declaring a file scoped handle database\&. .PP
  37. .nf
  38. -QB_HDB_DECLARE(my_handle_database, NULL);
  39. + QB_HDB_DECLARE(my_handle_database, NULL);
  40. .fi
  41. .PP
  42. -.SS "#define QB_HDB_X_FORMAT '%'PRIx64"
  43. -
  44. +.SS "#define \fBQB_HDB_X_FORMAT\fP '%'PRIx64"
  45. .SH "Typedef Documentation"
  46. .PP
  47. .SS "typedef uint64_t \fBqb_handle_t\fP"
  48. -
  49. .PP
  50. Generic handle type is 64 bits\&.
  51. .SH "Function Documentation"
  52. .PP
  53. -.SS "uint32_t qb_hdb_base_convert (\fBqb_handle_t\fPhandle)"
  54. -
  55. -.SS "void qb_hdb_create (struct \fBqb_hdb\fP *hdb)"
  56. -
  57. +.SS "uint32_t \fBqb_hdb_base_convert\fP (\fBqb_handle_t\fPhandle)"
  58. +.SS "void \fBqb_hdb_create\fP (struct \fBqb_hdb\fP *hdb)"
  59. .PP
  60. Create a new database\&. \fBParameters:\fP
  61. .RS 4
  62. @@ -154,8 +147,7 @@ Create a new database\&. \fBParameters:\
  63. .RE
  64. .PP
  65. -.SS "void qb_hdb_destroy (struct \fBqb_hdb\fP *hdb)"
  66. -
  67. +.SS "void \fBqb_hdb_destroy\fP (struct \fBqb_hdb\fP *hdb)"
  68. .PP
  69. Destroy a handle database\&. \fBParameters:\fP
  70. .RS 4
  71. @@ -163,8 +155,7 @@ Destroy a handle database\&. \fBParamete
  72. .RE
  73. .PP
  74. -.SS "int32_t qb_hdb_handle_create (struct \fBqb_hdb\fP *hdb, int32_tinstance_size, \fBqb_handle_t\fP *handle_id_out)"
  75. -
  76. +.SS "int32_t \fBqb_hdb_handle_create\fP (struct \fBqb_hdb\fP *hdb, int32_tinstance_size, \fBqb_handle_t\fP *handle_id_out)"
  77. .PP
  78. Create a new handle\&. \fBParameters:\fP
  79. .RS 4
  80. @@ -181,8 +172,7 @@ Create a new handle\&. \fBParameters:\fP
  81. .RE
  82. .PP
  83. -.SS "int32_t qb_hdb_handle_destroy (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in)"
  84. -
  85. +.SS "int32_t \fBqb_hdb_handle_destroy\fP (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in)"
  86. .PP
  87. Request the destruction of the object\&. When the refcount is 0, it will be destroyed\&.
  88. .PP
  89. @@ -199,8 +189,7 @@ Request the destruction of the object\&.
  90. .RE
  91. .PP
  92. -.SS "int32_t qb_hdb_handle_get (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in, void **instance)"
  93. -
  94. +.SS "int32_t \fBqb_hdb_handle_get\fP (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in, void **instance)"
  95. .PP
  96. Get the instance associated with this handle and increase it's refcount\&. \fBParameters:\fP
  97. .RS 4
  98. @@ -217,8 +206,7 @@ Get the instance associated with this ha
  99. .RE
  100. .PP
  101. -.SS "int32_t qb_hdb_handle_get_always (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in, void **instance)"
  102. -
  103. +.SS "int32_t \fBqb_hdb_handle_get_always\fP (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in, void **instance)"
  104. .PP
  105. Get the instance associated with this handle and increase it's refcount\&. \fBParameters:\fP
  106. .RS 4
  107. @@ -235,8 +223,7 @@ Get the instance associated with this ha
  108. .RE
  109. .PP
  110. -.SS "int32_t qb_hdb_handle_put (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in)"
  111. -
  112. +.SS "int32_t \fBqb_hdb_handle_put\fP (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in)"
  113. .PP
  114. Put the instance associated with this handle and decrease it's refcount\&. \fBParameters:\fP
  115. .RS 4
  116. @@ -251,8 +238,7 @@ Put the instance associated with this ha
  117. .RE
  118. .PP
  119. -.SS "int32_t qb_hdb_handle_refcount_get (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in)"
  120. -
  121. +.SS "int32_t \fBqb_hdb_handle_refcount_get\fP (struct \fBqb_hdb\fP *hdb, \fBqb_handle_t\fPhandle_in)"
  122. .PP
  123. Get the current refcount\&. \fBParameters:\fP
  124. .RS 4
  125. @@ -267,8 +253,7 @@ Get the current refcount\&. \fBParameter
  126. .RE
  127. .PP
  128. -.SS "int32_t qb_hdb_iterator_next (struct \fBqb_hdb\fP *hdb, void **instance, \fBqb_handle_t\fP *handle)"
  129. -
  130. +.SS "int32_t \fBqb_hdb_iterator_next\fP (struct \fBqb_hdb\fP *hdb, void **instance, \fBqb_handle_t\fP *handle)"
  131. .PP
  132. Get the next object and increament it's refcount\&. Remember to call \fBqb_hdb_handle_put()\fP
  133. .PP
  134. @@ -287,8 +272,7 @@ Get the next object and increament it's
  135. .RE
  136. .PP
  137. -.SS "void qb_hdb_iterator_reset (struct \fBqb_hdb\fP *hdb)"
  138. -
  139. +.SS "void \fBqb_hdb_iterator_reset\fP (struct \fBqb_hdb\fP *hdb)"
  140. .PP
  141. Reset the iterator\&. \fBParameters:\fP
  142. .RS 4
  143. @@ -296,8 +280,7 @@ Reset the iterator\&. \fBParameters:\fP
  144. .RE
  145. .PP
  146. -.SS "uint64_t qb_hdb_nocheck_convert (uint32_thandle)"
  147. -
  148. +.SS "uint64_t \fBqb_hdb_nocheck_convert\fP (uint32_thandle)"
  149. .SH "Author"
  150. .PP
  151. Generated automatically by Doxygen for libqb from the source code\&.