Documentation Convention

[LHRaceIng]

To stick to one Documentation convention:
Only in the header file document how classes/ functions/ variables are used.
Classes are documented using this style:

    /**
     * @class MyClass
     * @brief briefly explain what function/class does/ is used for 
     *        Can be extended to multiple lines like this.
     * 
     * Further/ detailed explanation in multiple lines if necessary.
     * Multiple lines mean that it can be extended like this. 
     * 
     */
    class MyClass
    {

Functions are documented in the header like this:

    /**
     * @brief briefly explain what function does/ is used for 
     *        Can be extended to multiple lines like this.
     * 
     * Further/ detailed explanation in multiple lines if necessary.
     * Multiple lines mean that it can be extended like this. 
     * 
     * @param parameter_1 (if function takes parameters)
     * @param parameter_2 (if function takes parameters)
     */
   MyFunction(auto parameter_1, auto parameter_2)

Variables are documented in the header file inline using the brief commenting style :

     auto var; //!< Brief description after the member

In the code (cpp files) documentation happens before the line that needs additional information:

      \\ This is very complex and needs additional information
      int a = 6+7

[Joni32do]

Okay, super. Werde ich versuchen umzusetzen