Cleanup: correct unbalanced doxygen groups

Also add groups in some files.
This commit is contained in:
2021-12-14 15:49:31 +11:00
parent c1f5d8d023
commit c097c7b855
160 changed files with 948 additions and 311 deletions

View File

@@ -43,6 +43,10 @@ extern "C" {
# endif
#endif
/* -------------------------------------------------------------------- */
/** \name GHash Types
* \{ */
typedef unsigned int (*GHashHashFP)(const void *key);
/** returns false when equal */
typedef bool (*GHashCmpFP)(const void *a, const void *b);
@@ -74,6 +78,8 @@ enum {
#endif
};
/** \} */
/* -------------------------------------------------------------------- */
/** \name GHash API
*
@@ -340,12 +346,11 @@ BLI_INLINE bool BLI_ghashIterator_done(const GHashIterator *ghi)
/** \} */
/* -------------------------------------------------------------------- */
/** \name GSet API
/** \name GSet Types
* A 'set' implementation (unordered collection of unique elements).
*
* Internally this is a 'GHash' without any keys,
* which is why this API's are in the same header & source file.
*
* \{ */
typedef struct GSet GSet;
@@ -357,10 +362,13 @@ typedef GHashKeyCopyFP GSetKeyCopyFP;
typedef GHashIterState GSetIterState;
/** \} */
/** \name GSet Public API
*
* Use ghash API to give 'set' functionality
* \{ */
GSet *BLI_gset_new_ex(GSetHashFP hashfp,
GSetCmpFP cmpfp,
const char *info,
@@ -521,6 +529,7 @@ double BLI_gset_calc_quality_ex(GSet *gs,
double BLI_ghash_calc_quality(GHash *gh);
double BLI_gset_calc_quality(GSet *gs);
#endif /* GHASH_INTERNAL_API */
/** \} */
/* -------------------------------------------------------------------- */