Re: [Doxygen-users] Hide typedef initializer
Brought to you by:
dimitri
|
From: <le...@bl...> - 2010-05-19 14:16:41
|
Martin K. Svensson wrote: > @hideinitializer is for values, not types. Why is the hiding of initializers limited to values? In combination with types, it would obviously make sense, too. Typedefs are a concept to abstract from the original type, in order to allow changes of the back-end (the actual type) while keeping the same front-end (the typedef identifier). Like private variables, typedef initializers are often an implementation detail in which the user is not interested. In this case, I consider them adequate to disappear in the API documentation. Besides, a #define needn't necessarily contain a value. It can also refer to a type, for example. > This may not work, but you could try documenting a forward declaration, > something like: > > /// @brief Hello > class FloatingPointType; > > typedef double FloatingPointType; Unfortunately, C++ doesn't allow to forward-declare a type with the class keyword if it is actually no class. |