Make use of inheritance in class API docs

[karlnapf]

There are many methods that are well documented in the base class (doxygen docs).
Then the subclass often doesnt provide any comments at all or, even worse, copy-pased from the baseclass.

But doxygen can in fact automatically use base class doc strings if subclasses do not provide one:

This depends on the INHERIT_DOCS configuration setting. When setting INHERIT_DOCS to YES the documentation will be copied, when setting it to NO the derived method will remain undocumented. This option is already enabled in shogun

This task to to do through the method doc strings and try to

• use base class docs where possible (delete subclass docs)
• if subclass docs are useful (something is different), write proper ones

Also see https://stackoverflow.com/questions/6534831/will-doxygen-use-base-class-docs-if-a-sub-class-doesnt-provide-its-own?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa

Good candidates to start

• CMachine
• CKernel
• CLabels

[nouranali]

I want to start in this issue, but i need more clarification, would you help

[karlnapf]

Not sure what you mean, it is all described above?