Improve create_participant/domain documentation #1999
Merged
Conversation
This file contains 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
t0ny-peng
approved these changes
May 17, 2024
src/core/ddsc/include/dds/dds.h
Outdated
| * a domain entity if one doesn't exist for the specified domain id. The domain entity | ||
| * can exist as a consequence of the existence of another participant in it, or because it | ||
| * was explicitly created using @ref dds_create_domain or @ref | ||
| * dds_create_domain_with_rawconfig. If a domain entity is created, its configuration is |
There was a problem hiding this comment.
"If a domain entity is created" -> "If the domain entity has not been created, a new domain entity is created using configuration taken from the CYCLONEDDS_URI environment variable".
This might be easier to understand for noobs like me.
Signed-off-by: Erik Boasson <eb@ilities.com>
eboasson
force-pushed
the
improve-create-participant-documentation
branch
from
f775f5f
to
4c8a5ce
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1997 — I hope 🙂