- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 551
Docs v3 notes and pass #2503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+6,956
−4,447
Merged
Docs v3 notes and pass #2503
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
cebde60
docs/tools: remove changelog generation script
julianoes af28dd4
docs: add API changes for v3
julianoes e1af634
docs: general pass through docs
julianoes a72328a
Updated API reference docs
julianoes 4c5bb1b
tools: copy over md files into docs
julianoes c78684a
CI: check whether docs require updating
julianoes 2ecd84c
docs: fix typo
julianoes 92d0f45
Fix proto syntax to prevent ul in table
julianoes d636bed
tools: get rid of doxygen warnings
julianoes 55420f7
templates: don't document non-existing return value
julianoes 1f1d298
tools: speed up docs build
julianoes 33ca6b6
tools: don't document operator methods
julianoes 8e9ef26
Run proto and docs generation
julianoes e7601f7
CI: install doxygen
julianoes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: general pass through docs
More to come...
- Loading branch information
commit e1af634b625fa7ff5222f940d2d01b9eee6e8606
There are no files selected for viewing
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_info_1_1_identification.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::Info::Identification Struct Reference | ||
`#include: info.h` | ||
---- | ||
[System](classmavsdk_1_1_system.md) identification. | ||
## Data Fields | ||
std::string [hardware_uid](#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385) {} - UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
uint64_t [legacy_uid](#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1) {} - Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
## Field Documentation | ||
### hardware_uid {#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385} | ||
```cpp | ||
std::string mavsdk::Info::Identification::hardware_uid {} | ||
``` | ||
UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
### legacy_uid {#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1} | ||
```cpp | ||
uint64_t mavsdk::Info::Identification::legacy_uid {} | ||
``` | ||
Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
# mavsdk::Info::Identification Struct Reference | ||
`#include: info.h` | ||
|
||
---- | ||
|
||
|
||
[System](classmavsdk_1_1_system.md) identification. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [hardware_uid](#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385) {} - UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
|
||
uint64_t [legacy_uid](#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1) {} - Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### hardware_uid {#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385} | ||
|
||
```cpp | ||
std::string mavsdk::Info::Identification::hardware_uid {} | ||
``` | ||
|
||
|
||
UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
|
||
|
||
### legacy_uid {#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1} | ||
|
||
```cpp | ||
uint64_t mavsdk::Info::Identification::legacy_uid {} | ||
``` | ||
|
||
|
||
Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
|
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_param_1_1_float_param.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::Param::FloatParam Struct Reference | ||
`#include: param.h` | ||
---- | ||
Type for float parameters. | ||
## Data Fields | ||
std::string [name](#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f) {} - Name of the parameter. | ||
float [value](#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66) {} - Value of the parameter. | ||
## Field Documentation | ||
### name {#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f} | ||
```cpp | ||
std::string mavsdk::Param::FloatParam::name {} | ||
``` | ||
Name of the parameter. | ||
### value {#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66} | ||
```cpp | ||
float mavsdk::Param::FloatParam::value {} | ||
``` | ||
Value of the parameter. | ||
# mavsdk::Param::FloatParam Struct Reference | ||
`#include: param.h` | ||
|
||
---- | ||
|
||
|
||
Type for float parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f) {} - Name of the parameter. | ||
|
||
float [value](#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f} | ||
|
||
```cpp | ||
std::string mavsdk::Param::FloatParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66} | ||
|
||
```cpp | ||
float mavsdk::Param::FloatParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_param_server_1_1_float_param.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::ParamServer::FloatParam Struct Reference | ||
`#include: param_server.h` | ||
---- | ||
Type for float parameters. | ||
## Data Fields | ||
std::string [name](#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e) {} - Name of the parameter. | ||
float [value](#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536) {} - Value of the parameter. | ||
## Field Documentation | ||
### name {#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e} | ||
```cpp | ||
std::string mavsdk::ParamServer::FloatParam::name {} | ||
``` | ||
Name of the parameter. | ||
### value {#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536} | ||
```cpp | ||
float mavsdk::ParamServer::FloatParam::value {} | ||
``` | ||
Value of the parameter. | ||
# mavsdk::ParamServer::FloatParam Struct Reference | ||
`#include: param_server.h` | ||
|
||
---- | ||
|
||
|
||
Type for float parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e) {} - Name of the parameter. | ||
|
||
float [value](#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e} | ||
|
||
```cpp | ||
std::string mavsdk::ParamServer::FloatParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536} | ||
|
||
```cpp | ||
float mavsdk::ParamServer::FloatParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_param_server_1_1_int_param.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::ParamServer::IntParam Struct Reference | ||
`#include: param_server.h` | ||
---- | ||
Type for integer parameters. | ||
## Data Fields | ||
std::string [name](#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292) {} - Name of the parameter. | ||
int32_t [value](#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2) {} - Value of the parameter. | ||
## Field Documentation | ||
### name {#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292} | ||
```cpp | ||
std::string mavsdk::ParamServer::IntParam::name {} | ||
``` | ||
Name of the parameter. | ||
### value {#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2} | ||
```cpp | ||
int32_t mavsdk::ParamServer::IntParam::value {} | ||
``` | ||
Value of the parameter. | ||
# mavsdk::ParamServer::IntParam Struct Reference | ||
`#include: param_server.h` | ||
|
||
---- | ||
|
||
|
||
Type for integer parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292) {} - Name of the parameter. | ||
|
||
int32_t [value](#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292} | ||
|
||
```cpp | ||
std::string mavsdk::ParamServer::IntParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2} | ||
|
||
```cpp | ||
int32_t mavsdk::ParamServer::IntParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't all this ref be updated/removed/modified by CI?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I'll look into that.