search

ChimeraTK / ApplicationCore

Core library for creating applications based on the ControlSystemAdapter and DeviceAccess.
GNU Lesser General Public License v3.0
1 stars 2 forks source link

chore/doc: move all tests to namespace to help Doxygen #371

Closed mhier closed 2 months ago

mhier commented 2 months ago

This helps in two ways:

  1. Doxygen is confused if there are multiple class defintions with the same name, which happens frequently in tests, e.g. "ModuleA"
  2. Doxygen shows rather prominently all classes defined in the tests when viewing the Class List, while the important classes are "hidden" at first below the ChimeraTK namespace.
mhier commented 2 months ago

Sorry, the diffs are stupid here. The change is merely to place everything of each test into a namespace called "Tests::". Due to the changed indentation the whole file content is changed, you don't need to check this though. The review should merely check the idea in this case...

killenb commented 2 months ago

I will do a quick diff locally with a better diff tool.

mhier commented 2 months ago

I made one fixup commit where the auto-formatter broke readability for a commended code segment. (commenting in the broken diff was not possible).

good catch, thanks!