From ba2bdc478b9eaad99b6c2a3c860e3dc0fe73a1a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 4 Jan 2022 20:26:22 +0100 Subject: Style: Remove inconsistently used `@author` docstrings Each file in Godot has had multiple contributors who co-authored it over the years, and the information of who was the original person to create that file is not very relevant, especially when used so inconsistently. `git blame` is a much better way to know who initially authored or later modified a given chunk of code, and most IDEs now have good integration to show this information. --- core/io/image.h | 2 -- core/math/a_star.h | 4 +--- core/math/disjoint_set.h | 4 ---- core/object/object.h | 4 ---- core/os/pool_allocator.h | 3 +-- core/templates/hash_map.h | 4 ++-- core/templates/vector.h | 1 - 7 files changed, 4 insertions(+), 18 deletions(-) (limited to 'core') diff --git a/core/io/image.h b/core/io/image.h index dffc5a6a5f..29236a55e5 100644 --- a/core/io/image.h +++ b/core/io/image.h @@ -36,8 +36,6 @@ #include "core/math/rect2.h" /** - * @author Juan Linietsky - * * Image storage class. This is used to store an image in user memory, as well as * providing some basic methods for image manipulation. * Images can be loaded from a file, or registered into the Render object as textures. diff --git a/core/math/a_star.h b/core/math/a_star.h index 1839ec7e04..130c202a61 100644 --- a/core/math/a_star.h +++ b/core/math/a_star.h @@ -37,9 +37,7 @@ #include "core/templates/oa_hash_map.h" /** - A* pathfinding algorithm - - @author Juan Linietsky + A* pathfinding algorithm. */ class AStar : public RefCounted { diff --git a/core/math/disjoint_set.h b/core/math/disjoint_set.h index d16c5d3d62..8657dc068e 100644 --- a/core/math/disjoint_set.h +++ b/core/math/disjoint_set.h @@ -34,10 +34,6 @@ #include "core/templates/map.h" #include "core/templates/vector.h" -/** - @author Marios Staikopoulos -*/ - /* This DisjointSet class uses Find with path compression and Union by rank */ template , class AL = DefaultAllocator> class DisjointSet { diff --git a/core/object/object.h b/core/object/object.h index ab94f2aa00..b988fd0ae3 100644 --- a/core/object/object.h +++ b/core/object/object.h @@ -52,10 +52,6 @@ #define VARIANT_ARGPTRS_PASS *argptr[0], *argptr[1], *argptr[2], *argptr[3], *argptr[4], *argptr[5], *argptr[6]], *argptr[7] #define VARIANT_ARGS_FROM_ARRAY(m_arr) m_arr[0], m_arr[1], m_arr[2], m_arr[3], m_arr[4], m_arr[5], m_arr[6], m_arr[7] -/** -@author Juan Linietsky -*/ - enum PropertyHint { PROPERTY_HINT_NONE, ///< no hint provided. PROPERTY_HINT_RANGE, ///< hint_text = "min,max[,step][,or_greater][,or_lesser][,noslider][,radians][,degrees][,exp][,suffix:] range. diff --git a/core/os/pool_allocator.h b/core/os/pool_allocator.h index 25b5061f62..11a252bc54 100644 --- a/core/os/pool_allocator.h +++ b/core/os/pool_allocator.h @@ -34,13 +34,12 @@ #include "core/typedefs.h" /** - @author Juan Linietsky * Generic Pool Allocator. * This is a generic memory pool allocator, with locking, compacting and alignment. (@TODO alignment) * It used as a standard way to manage allocation in a specific region of memory, such as texture memory, * audio sample memory, or just any kind of memory overall. * (@TODO) abstraction should be greater, because in many platforms, you need to manage a nonreachable memory. -*/ + */ enum { POOL_ALLOCATOR_INVALID_ID = -1 ///< default invalid value. use INVALID_ID( id ) to test diff --git a/core/templates/hash_map.h b/core/templates/hash_map.h index 82b3546f9d..fa5677cc70 100644 --- a/core/templates/hash_map.h +++ b/core/templates/hash_map.h @@ -40,7 +40,6 @@ /** * @class HashMap - * @author Juan Linietsky * * Implementation of a standard Hashing HashMap, for quick lookups of Data associated with a Key. * The implementation provides hashers for the default types, if you need a special kind of hasher, provide @@ -48,7 +47,8 @@ * @param TKey Key, search is based on it, needs to be hasheable. It is unique in this container. * @param TData Data, data associated with the key * @param Hasher Hasher object, needs to provide a valid static hash function for TKey - * @param Comparator comparator object, needs to be able to safely compare two TKey values. It needs to ensure that x == x for any items inserted in the map. Bear in mind that nan != nan when implementing an equality check. + * @param Comparator comparator object, needs to be able to safely compare two TKey values. + * It needs to ensure that x == x for any items inserted in the map. Bear in mind that nan != nan when implementing an equality check. * @param MIN_HASH_TABLE_POWER Miminum size of the hash table, as a power of two. You rarely need to change this parameter. * @param RELATIONSHIP Relationship at which the hash table is resized. if amount of elements is RELATIONSHIP * times bigger than the hash table, table is resized to solve this condition. if RELATIONSHIP is zero, table is always MIN_HASH_TABLE_POWER. diff --git a/core/templates/vector.h b/core/templates/vector.h index 18b731c458..f0da6aa924 100644 --- a/core/templates/vector.h +++ b/core/templates/vector.h @@ -33,7 +33,6 @@ /** * @class Vector - * @author Juan Linietsky * Vector container. Regular Vector Container. Use with care and for smaller arrays when possible. Use Vector for large arrays. */ -- cgit v1.2.3