Skip to content

Non-functional layout, documentation and symbol changes

Tango-Controls Bot requested to merge Layout-And-Documentation into master

Created by: chedburgh

Tidy, added some documentation and function headers. For tickert #7 (closed)

Work done:

  • Added LGPL Licence headers
  • Added some doxygen tags for some basic documentation. To be expanded in future as required.
  • Added consistent function headers in the source
  • Moved some magic values to const at the top of the source so we can track them. More to be added as discovered.
  • Formatted code via clang-format. Simpleformat derived from tango controls.
  • clang-tidy for readability, enforced some naming conventions. Derived from tango controls.
  • General hand tidy of some of the code (spacing)

Any format and naming convention can be easily updated in future when we have some guidelines. For now they are consistent within this library.

Merge request reports