Commit cadd4a07 authored by Brian Helba's avatar Brian Helba
Browse files

STYLE: Update documentation generation of vtkTypeMacro

Unfortunately, since the "EXPAND_ONLY_PREDEF" Doxygen option is being
used, all preprocessor macros must be explicitly redefined in
doxyfile.in. This commit updates the redefinition for vtkTypeMacro.

Additionally, update the documentation string for GetClassName().

Change-Id: I8313e0b3602514c48ac16d6e246ade5549036b1f
parent f142e3f3
......@@ -51,6 +51,10 @@ class vtkWeakPointerBaseToObjectBaseFriendship;
class VTKCOMMONCORE_EXPORT vtkObjectBase
{
// Description:
// Return the class name as a string. This method is overridden
// in all subclasses of vtkObjectBase with the vtkTypeMacro found
// in vtkSetGet.h.
virtual const char* GetClassNameInternal() const { return "vtkObjectBase"; }
public:
......@@ -61,9 +65,7 @@ public:
#endif
// Description:
// Return the class name as a string. This method is defined
// in all subclasses of vtkObjectBase with the vtkTypeMacro found
// in vtkSetGet.h.
// Return the class name as a string.
const char* GetClassName() const;
#ifdef VTK_WORKAROUND_WINDOWS_MANGLE
......
......@@ -173,8 +173,14 @@ PREDEFINED = "vtkSetMacro(name,type)= \
virtual float *Get##name();" \
"vtkTypeMacro(thisClass,superclass)= \
typedef superclass Superclass; \
virtual const char *GetClassName(); \
private: \
virtual const char* GetClassNameInternal() const; \
public: \
static int IsTypeOf(const char *type); \
virtual int IsA(const char *type); \
static thisClass* SafeDownCast(vtkObject *o);" \
static thisClass* SafeDownCast(vtkObjectBase *o); \
protected: \
virtual vtkObjectBase *NewInstanceInternal() const; \
public: \
thisClass *NewInstance() const;" \
"VTK_LEGACY(x)= x"
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment