Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 859 Bytes

File metadata and controls

28 lines (19 loc) · 859 Bytes

On Windows we use msys2 and ucrt64 to compile. You need to prefix commands with C:\msys64\msys2_shell.cmd -defterm -here -no-start -ucrt64 -c.

Prefix build directories with cmake-build-.

The test executable is named test_libdisplaydevice and will be located inside the tests directory within the build directory.

The project uses gtest as a test framework.

Always add or update doxygen documentation.

The project requires that everything be documented in doxygen or the build will fail.

Primary doxygen comments should be done like so:

  /**
   * @brief Describe the function, structure, etc.
   *
   * @param my_param Describe the parameter.
   * @return Describe the return.
   */

Inline doxygen comments should use ///< ... instead of /**< ... */.

Always follow the style guidelines defined in .clang-format for c/c++ code.