From e0cb02587012b4b2f4b18363dc7d0a7da2c02093 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 27 Aug 2020 18:18:47 +1000 Subject: Cleanup: mostly comments, use doxy syntax & typos - Use doxy syntax for functions. - Use `pragma once` for header guard. --- source/blender/blenlib/BLI_mpq2.hh | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'source/blender/blenlib/BLI_mpq2.hh') diff --git a/source/blender/blenlib/BLI_mpq2.hh b/source/blender/blenlib/BLI_mpq2.hh index 86a7b0ac3a8..c7d8eaeeeb6 100644 --- a/source/blender/blenlib/BLI_mpq2.hh +++ b/source/blender/blenlib/BLI_mpq2.hh @@ -16,6 +16,10 @@ #pragma once +/** \file + * \ingroup bli + */ + #ifdef WITH_GMP # include "BLI_math_mpq.hh" @@ -76,7 +80,8 @@ struct mpq2 { return &x; } - /* Cannot do this exactly in rational arithmetic! + /** + * Cannot do this exactly in rational arithmetic! * Approximate by going in and out of doubles. */ mpq_class length() const @@ -174,7 +179,7 @@ struct mpq2 { static int incircle(const mpq2 &a, const mpq2 &b, const mpq2 &c, const mpq2 &d); - /* There is a sensible use for hashing on exact arithmetic types. */ + /** There is a sensible use for hashing on exact arithmetic types. */ uint64_t hash() const; }; -- cgit v1.2.3