Mirrors_Framework/PX4-Autopilot
1
0
Fork 0
mirror of https://github.com/PX4/PX4-Autopilot.git synced 2026-05-25 08:36:08 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Fix all possible HTTP to HTTPS docs links (#25153)
Container build / Set Tags and Variables (push) Has been cancelled
Details
Container build / Build Container (amd64) (push) Has been cancelled
Details
Container build / Build Container (arm64) (push) Has been cancelled
Details
Container build / Deploy To Registry (push) Has been cancelled
Details
Docs - Crowdin - Upload Guide sources (en) / upload-to-crowdin (push) Has been cancelled
Details
Docs - Deploy PX4 User Guide / build (push) Has been cancelled
Details
Docs - Deploy PX4 User Guide / deploy (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Hamish Willee
2025-07-03 18:09:58 +10:00
committed by GitHub
parent 375f421c61
commit 2c31e2bad5
84 changed files with 276 additions and 359 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/contribute/code.md
+1 -1
View File
@@ -112,7 +112,7 @@ Currently we have two types of source-based documentation:
- Do not add documentation that can trivially be inferred from C++ entity names.
- ALWAYS specify units of variables, constants, and input/return parameters where they are defined.
- Commonly you may want to add information about corner cases and error handling.
- [Doxgyen](http://www.doxygen.nl/) tags should be used if documentation is needed: `@class`, `@file`, `@param`, `@return`, `@brief`, `@var`, `@see`, `@note`.
- [Doxgyen](https://www.doxygen.nl/) tags should be used if documentation is needed: `@class`, `@file`, `@param`, `@return`, `@brief`, `@var`, `@see`, `@note`.
A good example of usage is [src/modules/events/send_event.h](https://github.com/PX4/PX4-Autopilot/blob/main/src/modules/events/send_event.h).
Please avoid "magic numbers", for example, where does this number in the conditional come from? What about the multiplier on yaw stick input?