Comment classes, function, and other members in C++ code

Description

The C++ code must be comprehensively documented.

Demonstration

  • comprehensive documentation of classes, functions, and other members available after compilation of documentation with doxygen

Sub-tasks

The following C++ classes/files need to be considered/included

  • Cluster.*pp
  • ClusterCounts.*pp
  • ClusterSpace.*pp
  • Geometry.*pp
  • LatticeSite.hpp
  • LocalEnvironment.hpp
  • LocalOrbitlistGenerator.*pp
  • ManybodyNeighborlist.*pp (rename to ManybodyNeighborList.*pp; see #64 (closed))
  • Neighborlist.*pp (rename to NeighborList.*pp; see #64 (closed))
  • Orbit.*pp
  • OrbitList.*pp
  • PeriodicTable.*pp
  • PermutationMap.*pp
  • Structure.*pp
  • Symmetry.*pp
  • Vector3dCompare.hpp
  • hash_functions.hpp (to be renamed to HashFunctions.hpp; see #64 (closed))