diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-06-24 08:57:33 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-06-24 08:59:34 +0300 |
commit | 1f778dbefcaf825dcad1f70a9cc45e503ad74ed5 (patch) | |
tree | d192550ac77a0f982fb43440d3c64d972cc2d011 /source/blender/freestyle/intern/system | |
parent | 4b9ff3cd42be427e478743648e9951bf8c189a04 (diff) |
Cleanup: use Blender's code style for doxygen commetns in freestyle
Diffstat (limited to 'source/blender/freestyle/intern/system')
-rw-r--r-- | source/blender/freestyle/intern/system/BaseObject.h | 6 | ||||
-rw-r--r-- | source/blender/freestyle/intern/system/Id.h | 26 | ||||
-rw-r--r-- | source/blender/freestyle/intern/system/ProgressBar.h | 2 |
3 files changed, 17 insertions, 17 deletions
diff --git a/source/blender/freestyle/intern/system/BaseObject.h b/source/blender/freestyle/intern/system/BaseObject.h index 76d30aa74e2..8a19100a5c6 100644 --- a/source/blender/freestyle/intern/system/BaseObject.h +++ b/source/blender/freestyle/intern/system/BaseObject.h @@ -39,7 +39,7 @@ class BaseObject { { } - /*! At least makes a release on this. + /** At least makes a release on this. * The BaseObject::destroy method must be explicitly called at the end of any overloaded destroy */ virtual int destroy() @@ -47,13 +47,13 @@ class BaseObject { return release(); } - /*! Increments the reference counter */ + /** Increments the reference counter */ inline int addRef() { return ++_ref_counter; } - /*! Decrements the reference counter */ + /** Decrements the reference counter */ inline int release() { if (_ref_counter) { diff --git a/source/blender/freestyle/intern/system/Id.h b/source/blender/freestyle/intern/system/Id.h index f94e044de29..92ce5f28fb1 100644 --- a/source/blender/freestyle/intern/system/Id.h +++ b/source/blender/freestyle/intern/system/Id.h @@ -27,21 +27,21 @@ namespace Freestyle { -/*! Class used to tag any object by an id. +/** Class used to tag any object by an id. * It is made of two unsigned integers. */ class Id { public: typedef unsigned id_type; - /*! Default constructor */ + /** Default constructor */ Id() { _first = 0; _second = 0; } - /*! Builds an Id from an integer. + /** Builds an Id from an integer. * The second number is set to 0. */ Id(id_type id) @@ -50,21 +50,21 @@ class Id { _second = 0; } - /*! Builds the Id from the two numbers */ + /** Builds the Id from the two numbers */ Id(id_type ifirst, id_type isecond) { _first = ifirst; _second = isecond; } - /*! Copy constructor */ + /** Copy constructor */ Id(const Id &iBrother) { _first = iBrother._first; _second = iBrother._second; } - /*! Operator= */ + /** Operator= */ Id &operator=(const Id &iBrother) { _first = iBrother._first; @@ -72,43 +72,43 @@ class Id { return *this; } - /*! Returns the first Id number */ + /** Returns the first Id number */ id_type getFirst() const { return _first; } - /*! Returns the second Id number */ + /** Returns the second Id number */ id_type getSecond() const { return _second; } - /*! Sets the first number constituting the Id */ + /** Sets the first number constituting the Id */ void setFirst(id_type first) { _first = first; } - /*! Sets the second number constituting the Id */ + /** Sets the second number constituting the Id */ void setSecond(id_type second) { _second = second; } - /*! Operator== */ + /** Operator== */ bool operator==(const Id &id) const { return ((_first == id._first) && (_second == id._second)); } - /*! Operator!= */ + /** Operator!= */ bool operator!=(const Id &id) const { return !((*this) == id); } - /*! Operator< */ + /** Operator< */ bool operator<(const Id &id) const { if (_first < id._first) { diff --git a/source/blender/freestyle/intern/system/ProgressBar.h b/source/blender/freestyle/intern/system/ProgressBar.h index d7b02c48359..6919c624545 100644 --- a/source/blender/freestyle/intern/system/ProgressBar.h +++ b/source/blender/freestyle/intern/system/ProgressBar.h @@ -64,7 +64,7 @@ class ProgressBar { _label = s; } - /*! accessors */ + /** accessors */ inline unsigned int getTotalSteps() const { return _numtotalsteps; |