diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-05-20 05:54:45 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-05-20 07:12:22 +0300 |
commit | 5d30c23c35aafba3a9bc772b4e66dd70b1ed84de (patch) | |
tree | 0657f4c3878153e715d8bbc3cda20734655498ca /source/blender/blenlib | |
parent | 922d5ed939139d578d4f9fdc55e891e0a23f7709 (diff) |
doxygen: corrections/updates
Also add depsgraph & physics
Diffstat (limited to 'source/blender/blenlib')
-rw-r--r-- | source/blender/blenlib/intern/BLI_dynstr.c | 8 | ||||
-rw-r--r-- | source/blender/blenlib/intern/convexhull2d.c | 2 | ||||
-rw-r--r-- | source/blender/blenlib/intern/edgehash.c | 8 | ||||
-rw-r--r-- | source/blender/blenlib/intern/gsqueue.c | 8 | ||||
-rw-r--r-- | source/blender/blenlib/intern/string_utf8.c | 10 | ||||
-rw-r--r-- | source/blender/blenlib/intern/timecode.c | 1 |
6 files changed, 18 insertions, 19 deletions
diff --git a/source/blender/blenlib/intern/BLI_dynstr.c b/source/blender/blenlib/intern/BLI_dynstr.c index 8617132e988..80cbce7e256 100644 --- a/source/blender/blenlib/intern/BLI_dynstr.c +++ b/source/blender/blenlib/intern/BLI_dynstr.c @@ -258,11 +258,11 @@ int BLI_dynstr_get_len(DynStr *ds) /** * Get a DynStr's contents as a c-string. - * <i> The str argument must be allocated to be at - * least the size of BLI_dynstr_get_len(ds) + 1. </i> + * he \a rets argument must be allocated to be at + * least the size of ``BLI_dynstr_get_len(ds) + 1``. * - * \param ds The DynStr of interest. - * \param str The string to fill. + * \param ds: The DynStr of interest. + * \param rets: The string to fill. */ void BLI_dynstr_get_cstring_ex(DynStr *__restrict ds, char *__restrict rets) { diff --git a/source/blender/blenlib/intern/convexhull2d.c b/source/blender/blenlib/intern/convexhull2d.c index f77beac1982..740f3cce4a4 100644 --- a/source/blender/blenlib/intern/convexhull2d.c +++ b/source/blender/blenlib/intern/convexhull2d.c @@ -239,7 +239,7 @@ int BLI_convexhull_2d(const float (*points)[2], const int n, int r_points[]) * * Intended to be used with #BLI_convexhull_2d * - * \param points Ordered hull points + * \param points_hull Ordered hull points * (result of #BLI_convexhull_2d mapped to a contiguous array). * * \note we could return the index of the best edge too if its needed. diff --git a/source/blender/blenlib/intern/edgehash.c b/source/blender/blenlib/intern/edgehash.c index edf70a1f188..cde4a8bf59d 100644 --- a/source/blender/blenlib/intern/edgehash.c +++ b/source/blender/blenlib/intern/edgehash.c @@ -454,9 +454,9 @@ void *BLI_edgehash_lookup_default(EdgeHash *eh, unsigned int v0, unsigned int v1 } /** - * Remove \a key from \a eh, or return false if the key wasn't found. + * Remove \a key (v0, v1) from \a eh, or return false if the key wasn't found. * - * \param key The key to remove. + * \param v0, v1: The key to remove. * \param valfreefp Optional callback to free the value. * \return true if \a key was removed from \a eh. */ @@ -480,9 +480,9 @@ bool BLI_edgehash_remove(EdgeHash *eh, unsigned int v0, unsigned int v1, EdgeHas /* same as above but return the value, * no free value argument since it will be returned */ /** - * Remove \a key from \a eh, returning the value or NULL if the key wasn't found. + * Remove \a key (v0, v1) from \a eh, returning the value or NULL if the key wasn't found. * - * \param key The key to remove. + * \param v0, v1: The key to remove. * \return the value of \a key int \a eh or NULL. */ void *BLI_edgehash_popkey(EdgeHash *eh, unsigned int v0, unsigned int v1) diff --git a/source/blender/blenlib/intern/gsqueue.c b/source/blender/blenlib/intern/gsqueue.c index 94d18ce3c77..f1aff76b358 100644 --- a/source/blender/blenlib/intern/gsqueue.c +++ b/source/blender/blenlib/intern/gsqueue.c @@ -96,8 +96,8 @@ int BLI_gsqueue_size(GSQueue *gq) * Access the item at the head of the queue * without removing it. * - * \param item_r A pointer to an appropriately - * sized structure (the size passed to BLI_gsqueue_new) + * \param r_item: A pointer to an appropriately + * sized structure (the size passed to #BLI_gsqueue_new) */ void BLI_gsqueue_peek(GSQueue *gq, void *r_item) { @@ -108,8 +108,8 @@ void BLI_gsqueue_peek(GSQueue *gq, void *r_item) * Access the item at the head of the queue * and remove it. * - * \param item_r A pointer to an appropriately - * sized structure (the size passed to BLI_gsqueue_new). + * \param r_item: A pointer to an appropriately + * sized structure (the size passed to #BLI_gsqueue_new). * Can be NULL if desired. */ void BLI_gsqueue_pop(GSQueue *gq, void *r_item) diff --git a/source/blender/blenlib/intern/string_utf8.c b/source/blender/blenlib/intern/string_utf8.c index 67ff532cb6f..22f44a38c7a 100644 --- a/source/blender/blenlib/intern/string_utf8.c +++ b/source/blender/blenlib/intern/string_utf8.c @@ -329,8 +329,8 @@ size_t BLI_strnlen_utf8_ex(const char *strc, const size_t maxlen, size_t *r_len_ } /** - * \param start the string to measure the length. - * \param maxlen the string length (in bytes) + * \param strc: the string to measure the length. + * \param maxlen: the string length (in bytes) * \return the unicode length (not in bytes!) */ size_t BLI_strnlen_utf8(const char *strc, const size_t maxlen) @@ -599,14 +599,14 @@ unsigned int BLI_str_utf8_as_unicode_step(const char *__restrict p, size_t *__re /* was g_unichar_to_utf8 */ /** * BLI_str_utf8_from_unicode: - * @c a Unicode character code - * \param outbuf output buffer, must have at least 6 bytes of space. + * \param c: a Unicode character code + * \param outbuf: output buffer, must have at least 6 bytes of space. * If %NULL, the length will be computed and returned * and nothing will be written to outbuf. * * Converts a single character to UTF-8. * - * Return value: number of bytes written + * \return number of bytes written **/ size_t BLI_str_utf8_from_unicode(unsigned int c, char *outbuf) { diff --git a/source/blender/blenlib/intern/timecode.c b/source/blender/blenlib/intern/timecode.c index 7b98d7830ee..39ffbcd7ebe 100644 --- a/source/blender/blenlib/intern/timecode.c +++ b/source/blender/blenlib/intern/timecode.c @@ -196,7 +196,6 @@ size_t BLI_timecode_string_from_time( * \param power special setting for #View2D grid drawing, * used to specify how detailed we need to be * \param time_seconds time total time in seconds - * \param seconds time in seconds. * \return length of \a str * * \note in some cases this is used to print non-seconds values. |