README.md

ROACH2 RCU

This is the repository for the software of the ROACH2 project. RCU and OBC share the same code base.

Source code documentation

The source code has to be documented according to the following style, so that a API documentation can be generated with Doxygen (see also: http://fnch.users.sourceforge.net/doxygen_c.html):

/**
 * @file Dateiname.txt
 * @date 03-06-2019
 * @brief Brief description of the file content
 *
 * @copyright KSat Stuttgart e.V. Roach2 software team
 */

class CLASS {
    private:
        /**
         * @brief Brief description
         */
        int number;
    public:
        /**
         * @brief Brief decription of function
         * @param param Parameter 1
         * @return Returns a number
        */
        int function(int param);
}

Building

to be done ...