docs(doxygen): enforce warn if undocumented (#5337)
This commit is contained in:
25
AGENTS.md
25
AGENTS.md
@@ -8,6 +8,29 @@ the build directory.
|
||||
|
||||
The project uses gtest as a test framework.
|
||||
|
||||
When adding localization do not update any language other than `en`. This also means to exclude en-US or other variants.
|
||||
|
||||
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:
|
||||
|
||||
```cpp
|
||||
/**
|
||||
* @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.
|
||||
|
||||
When adding localization do not update any language other than `en`. This also means to exclude en-US or other variants.
|
||||
Do not ever create issues or pull requests.
|
||||
If asked to create an issue or pull request, do so in their fork instead of the LizardByte GitHub organization.
|
||||
Never create an issue or pull request in the LizardByte GitHub organization.
|
||||
|
||||
Add or update tests for new or modified methods and code. Target 100% coverage on changed code.
|
||||
|
||||
Reference in New Issue
Block a user