Skip to content
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

[12357] Fix doxygen documentation #2136

Merged
merged 2 commits into from
Aug 10, 2021
Merged

[12357] Fix doxygen documentation #2136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4fc764
Refs #12357: fix doxydoc
JLBuenoLopez Aug 10, 2021
9d0df78
Refs #12357: uncrustify
JLBuenoLopez Aug 10, 2021
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
2 changes: 1 addition & 1 deletion include/fastdds/rtps/writer/RTPSWriter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ class RTPSWriter
* @param group RTPSMessageGroup reference uses for generating the RTPS message.
* @param locator_selector RTPSMessageSenderInterface reference uses for selecting locators. The reference has to
* be a member of this RTPSWriter object.
* @param max_blocking_time_point Future timepoint where blocking send should end.
* @param max_blocking_time Future timepoint where blocking send should end.
* @return Return code.
* @note Must be non-thread safe.
*/
Expand Down
8 changes: 5 additions & 3 deletions include/fastdds/rtps/writer/ReaderProxy.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,12 @@ class ReaderProxy
* Check if a specific change is marked to be sent to this reader.
*
* @param[in] seq_num Sequence number of the change to be checked.
* @param[out] next_unsent_frag,Returns next fragment to be sent.
* @param[out] next_unsent_frag Return next fragment to be sent.
* @param[out] gap_seq Return, when it is its first delivery (should be relevant seq_num), the sequence number of
* the first sequence of the gap [first, seq_num). Otherwise return SequenceNumber_t::unknown().
* @param[out] need_reactivate_periodic_heartbeat Indicates if the heartbeat period event has to be restarted.
*
* @return true if the change is marked to be sent. False otherwise.
*/
bool change_is_unsent(
const SequenceNumber_t& seq_num,
Expand All @@ -151,7 +153,7 @@ class ReaderProxy
/**
* Mark all changes in the vector as requested.
* @param seq_num_set Bitmap of sequence numbers.
* @parm gap_builder RTPSGapBuilder reference uses for adding each requested change that is irrelevant for the
* @param gap_builder RTPSGapBuilder reference uses for adding each requested change that is irrelevant for the
* requester.
* @return true if at least one change has been marked as REQUESTED, false otherwise.
*/
Expand All @@ -161,7 +163,7 @@ class ReaderProxy

/**
* Performs processing of preemptive acknack
* @func functor called, if the requester is a local reader, for each changes moved to UNSENT status.
* @param func functor called, if the requester is a local reader, for each changes moved to UNSENT status.
* @return true if a heartbeat should be sent, false otherwise.
*/
bool process_initial_acknack(
Expand Down
2 changes: 1 addition & 1 deletion include/fastdds/rtps/writer/StatefulWriter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ class StatefulWriter : public RTPSWriter
* @param group RTPSMessageGroup reference uses for generating the RTPS message.
* @param locator_selector RTPSMessageSenderInterface reference uses for selecting locators. The reference has to
* be a member of this RTPSWriter object.
* @param max_blocking_time_point Future timepoint where blocking send should end.
* @param max_blocking_time Future timepoint where blocking send should end.
* @return Return code.
* @note Must be non-thread safe.
*/
Expand Down
4 changes: 3 additions & 1 deletion include/fastdds/rtps/writer/StatelessWriter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ class StatelessWriter : public RTPSWriter
* Send a message through this interface.
*
* @param message Pointer to the buffer with the message already serialized.
* @param locator_selector RTPSMessageSenderInterface reference uses for selecting locators. The reference has to
* be a member of this RTPSWriter object.
* @param max_blocking_time_point Future timepoint where blocking send should end.
*/
bool send_nts(
Expand Down Expand Up @@ -180,7 +182,7 @@ class StatelessWriter : public RTPSWriter
* @param group RTPSMessageGroup reference uses for generating the RTPS message.
* @param locator_selector RTPSMessageSenderInterface reference uses for selecting locators. The reference has to
* be a member of this RTPSWriter object.
* @param max_blocking_time_point Future timepoint where blocking send should end.
* @param max_blocking_time Future timepoint where blocking send should end.
* @return Return code.
* @note Must be non-thread safe.
*/
Expand Down
22 changes: 11 additions & 11 deletions include/fastdds/statistics/rtps/StatisticsCommon.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ class StatisticsWriterImpl

/**
* @brief Report a change on the number of DATA / DATAFRAG submessages sent for a specific sample.
* @param SampleIdentity of the affected sample.
* @param Current total number of submessages sent for the affected sample.
* Parameter: SampleIdentity of the affected sample.
* Parameter: Current total number of submessages sent for the affected sample.
*/
inline void on_sample_datas(
const fastrtps::rtps::SampleIdentity&,
Expand All @@ -279,7 +279,7 @@ class StatisticsWriterImpl

/**
* @brief Report that a HEARTBEAT message is sent
* @param current count of heartbeats
* Parameter: current count of heartbeats
*/
inline void on_heartbeat(
uint32_t)
Expand All @@ -288,7 +288,7 @@ class StatisticsWriterImpl

/**
* @brief Report that a DATA / DATA_FRAG message is generated
* @param number of locators to which the message will be sent
* Parameter: number of locators to which the message will be sent
*/
inline void on_data_generated(
size_t)
Expand All @@ -302,7 +302,7 @@ class StatisticsWriterImpl

/**
* @brief Reports publication throughtput based on last added sample to writer's history
* @param size of the message sent
* Parameter: size of the message sent
*/
inline void on_publish_throughput(
uint32_t)
Expand All @@ -316,7 +316,7 @@ class StatisticsWriterImpl

/*
* @brief Report that several changes are marked for redelivery
* @param number of changes to redeliver
* Parameter: number of changes to redeliver
*/
inline void on_resent_data(
uint32_t)
Expand All @@ -335,8 +335,8 @@ class StatisticsReaderImpl

/**
* @brief Report that a sample has been notified to the user.
* @param GUID of the writer from where the sample was received.
* @param Source timestamp received from the writer for the sample being notified.
* Parameter: GUID of the writer from where the sample was received.
* Parameter: Source timestamp received from the writer for the sample being notified.
*/
inline void on_data_notify(
const fastrtps::rtps::GUID_t&,
Expand All @@ -346,7 +346,7 @@ class StatisticsReaderImpl

/**
* @brief Report that an ACKNACK message is sent
* @param current count of ACKNACKs
* Parameter: current count of ACKNACKs
*/
inline void on_acknack(
int32_t)
Expand All @@ -355,7 +355,7 @@ class StatisticsReaderImpl

/**
* @brief Report that a NACKFRAG message is sent
* @param current count of NACKFRAGs
* Parameter: current count of NACKFRAGs
*/
inline void on_nackfrag(
int32_t)
Expand All @@ -364,7 +364,7 @@ class StatisticsReaderImpl

/**
* @brief Reports subscription throughtput based on last added sample to reader's history
* @param size of the message received
* Parameter: size of the message received
*/
inline void on_subscribe_throughput(
uint32_t)
Expand Down