Documentation updates #1888
Merged
Documentation updates #1888
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
eboasson
reviewed
Nov 29, 2023
| @@ -21,7 +21,7 @@ CycloneDDS configuration | |||
| //CycloneDDS/Domain | |||
| ******************* | |||
|
|
|||
| Attributes: [Id](`//CycloneDDS/Domain[@Id]`_) | |||
There was a problem hiding this comment.
This is definitely much better, but I wonder if it would be possible to show Id the reader but have it be a link target for the definition of the attribute (as in <a href="...">Id</a>): that would make it read like:
Attributes: Id
Children: Compatibility, Discovery, General, ...
which in my opinion would look much nicer.
(The same goes for the child elements, of course.)
There was a problem hiding this comment.
@eboasson i agree and fixed it
eboasson
approved these changes
Nov 29, 2023
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.
Fixed issue #1873 and #1883
Added missing psmx, dynamic types, log and loan documentation.
Fix missing refs and group refs from several header files.