Some documentation issues

 

Sorry to raise the issue of documentation, but I frequently find myself looking through the source code to get the truth of the matter where the documentation is incorrect.

 

My first gripe relates to documentation of control classes.  Typically the documentation only shows one base class, e.g. docs for CXTCaption indicates that there is only one base class - CStatic.

 

In fact, there are 2, CStatic, and CXTThemeManagerStyleHostBase

 

The documentation then doesn't show any of the functions derived from CXTThemeManagerStyleHostBase, such as, oh maybe the slightly useful

 

SetTheme

 

function.  If the documentation showed ALL base classes, at least we would know there were more, and that there would be a lot more derived functionality, even if we have to click through to that base class to see the functions, at least we could!

 

Missing these out is worse than having no docs at all, since if there were no docs I would know I have to go straight to the source code to find the answers, rather than being mislead into thinking I have the answer but it's wrong.

 

My other issue with the docs is they don't really state what classes are or do very well.  Many classes in there the description is very vague.  A screenshot of an example of the use of the class would be useful in the case of a control.

 

Thanks for listening

 

Regards

 

Adrien