Skip to content

typos, doxygen #174

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.

Sign up for GitHub

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
flipflip8952 merged 1 commit into from
Dec 18, 2025
Merged

typos, doxygen #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions fpsdk_common/include/fpsdk_common/parser.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
*
* // Add the chunk of data to the parser
* if (!parser.Add(data, size)) {
* // We added too much data! This will not happen if we don't add more than MAX_ANY_SIZE at a time.
* // We added too much data! This only happens if we add more than MAX_ADD_SIZE at a time.
* WARNING(("Parser overflow!");
* parser.Reset();
* continue;
Expand All @@ -87,7 +87,7 @@
* }
*
* // There may be some remaining data in the parser.
* // If there is anytghing, we should see only type OTHER "messages" here.
* // If there is any data left, we should see only type OTHER "messages" here.
* while (parser.Flush(msg)) {
* msg.MakeInfo();
* INFO("Message %s, size %d", msg.name_.c_str(), (int)msg.Size(), msg.info_.c_str());
Expand All @@ -107,20 +107,24 @@
* Examples:
*
* - **FP_A**-NAME, e.g. `FP_A-ODOMETRY`, `FP_A-RAWIMU`. See fpsdk::common::parser::nmea::NmeaGetMessageName() for
* details.
* details.
* - **FP_B**-NAME, e.g. `FP_B-SYSTEMSTATUS`, `FP_B-GNSSSTATUS`. See fpsdk::common::parser::fpb::FpbGetMessageName() for
* details.
* details.
* - **NMEA**-TALKER-FORMATTER, e.g. `NMEA-GN-GGA`, `NMEA-GN-RMC`. See fpsdk::common::parser::nmea::NmeaGetMessageName()
* for details.
* for details.
* - **UBX**-CLASS-MESSAGE, e.g. `UBX-NAV-PVT`, `UBX-RXM-RAWX`. See fpsdk::common::parser::ubx::UbxGetMessageName() for
* details.
* details.
* - **RTCM3**-TYPENNNN, e.g. `RTCM3-TYPE1234`. See fpsdk::common::parser::rtcm3::Rtcm3GetMessageName() for details.
* - **UNI_B**-NAME, .e.g. `UNI_B-VERSION`, `UNI_B-BESTNAV`. See fpsdk::common::parser::unib::UnibGetMessageName() for
* details.
* details.
* - **NOV_B**-NAME, .e.g. `NOV_B-BESTGNSSPOS`, `NOV_B-RAWDMI`. See fpsdk::common::parser::novb::NovbGetMessageName()
* for details.
* for details.
* - **SPARTN**-TYPE-SUBTYPE, e.g. `SPARTN-OCB-GPS`. See fpsdk::common::parser::spartn::SpartnGetMessageName() for
* details.
* details.
* - **SBF**-NAME, .e.g. `SBF-NAVCART`, `SBF-MEASEPOCH`. See fpsdk::common::parser::sbf::SbfGetMessageName()
* for details.
* - **QGC**-GROUP-MESSAGE, e.g. `QGC-RAW-HASE6`. See fpsdk::common::parser::qgc::QgcGetMessageName() for
* details.
* - **OTHER** (there are no individual messages in this "protocol")
*
* @section FPSDK_COMMON_PARSER_DESIGN Design
Expand Down
4 changes: 2 additions & 2 deletions fpsdk_common/include/fpsdk_common/parser/qgc.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ constexpr uint8_t QgcMsgId(const uint8_t* msg)
/**
* @brief Get QGC message name
*
* Generates a name (string) in the form "QGC-GRPID-MSGID", where GRPID and MSGID are suitable stringifications of the
* class ID and message ID if known (for example, "QGC-RAW-HASE6", respectively %02X formatted IDs if unknown (for
* Generates a name (string) in the form "QGC-GROUP-MESSAGE", where GROUP and MESSAGE are suitable stringifications of
* the group ID and message ID if known (for example, "QGC-RAW-HASE6", respectively %02X formatted IDs if unknown (for
* example, "QGC-0A-FF").
*
* @param[out] name String to write the name to
Expand Down
Loading