Add comment for super class documentation Fix 147 #152
Conversation
|
@grhoten I am not sure this is the right fix. But if we do not document it doxygen will consider it missing info and give us warning |
There was a problem hiding this comment.
I agree. I'm not sure that this is the right fix. The new documentation in this pull request isn't adding non-obvious information. The typedef is trying to emulate Java's super keyword, and minimize/avoid the C++ multiple inheritance. If you ever have to move a class around in the class hierarchy, this can be "super" convenient. 😀
So it's helpful to have. It's not meaningful to document from an API perspective.
Would using TYPEDEF_HIDES_STRUCT = YES help? That may require the least maintenance.
I would also be agreeable to surrounding the typedefs with /// @cond and /// @endcond, or making them all private.
The super usage is used a lot within a class, especially in the constructors. I'm not sure that it's used nor helpful outside of a given class. So making it private may be OK.
no. Warning still there. I do not think it is a struct here. |
cee0142 to
b4ac0c4
Compare
|
PTAL |
|
Thanks for the change. |
* Add comment for super class documentation Fix 147 * Fix by using @cond/@endcond * change // to ///
#147