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

Jump to bottom

[16315] Improve XML documentation section #435

Merged
merged 41 commits into from
Jan 18, 2023
Merged

[16315] Improve XML documentation section #435

merged 41 commits into from
Jan 18, 2023

Conversation

JLBuenoLopez
Copy link
Contributor

This PR:

  • Fixes the order of the examples so it is consistent with the order in the tables.
  • Ensures that every example has every available option set.
  • Fixes incomplete information (IP address as DNS name...)
  • Fixes some typos
  • Refactors Dynamic types profiles to follow a more logical order.
  • Removes deprecated ThroughputControllerDescriptor.

@JLBuenoLopez
Refs #16315: fix example order to be consistent with the tags table
f028200 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: Fix XML example with every transport descriptor option d…
459f3b6 
…epending on the transport kind

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add TLS section to example
7b822cb 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: clarify the address format: DNS name. Change table format
f41a3b0 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add external locator list example
d740657 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: fix typo
b2a190f 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add DomainParticipant external unicast locators to compl…
8ccc730 
…ete example

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: clarify ignoreParticipantFlags XML section
3cf3adf 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add options missing from complete example
3e1f5fa 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: fix element order in example to be consistent with the d…
20f086b 
…ocumentation order

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: improve DurationType section
13624e4 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: complete builtin discovery config
b86689c 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: fix title level
ee826f9 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add missing builtin elements to complete example
3e73f8a 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: use correct link to Memory Management Policy
be5748f 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add userData to DomainParticipant
7f4b79e 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remote locators allocations should have its own subsection
3505927 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: update section order to be consistent with the table pre…
714e01d 
…sentation

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remove throughput controller (deprecated). Follow the sa…
cc3471b 
…me element order in the full example

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remove ThroughputControllerDescriptor from API reference
30a92dc 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remove throughput controller information as is deprecate…
800080c 
…d since Fast DDS v2.4.0

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: fix table header
e5060a1 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remove <domainId> and reestructure header levels
13a7e42 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remove <publisher> and <subscriber>
a129019 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: remove Topic tags <kind>, <name> and <dataType>
fd4c866 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: avoid referencing again and again to the same section
73b03ca 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add <extra_samples> tag to examples
d4729de 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: sort alphabetically QoS tags
5be63e4 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: fix Durability default values and constants read by XML …
4a29fce 
…parser

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: sort alphabetically XML QoS example
3b164db 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: add missing DataWriter QoS from complete example and sor…
3f688a2 
…t alphabetically

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: clarify WriterTimes
94d3497 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: complete datawriter profile example
3973f7c 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: clarify ReaderTimes
ade9353 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: complete datareader profile example
d42c8ab 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: log configuration complete example
49fce55 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: complete dynamic primitive types information. Explain first
434adc8 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: refactor XML dynamic types section
a440ebf 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: containers within containers must be defined with typede…
c163508 
…f and not as members

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez
Refs #16315: fix XML files. Remove example from Tester (already in Te…
1a7507d 
…sterExample)

Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@JLBuenoLopez JLBuenoLopez added this to the 2.9.1 milestone Dec 22, 2022
EduPonz
EduPonz suggested changes Jan 16, 2023
View reviewed changes
Copy link

@EduPonz EduPonz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is indeed a much needed PR and a great effort, kudos! The review has taken a while, and I think at this point I can almost render RST in my head 🤦🏼, thank Lord Github for the commit by commit reviews (an you for splitting the changes so nicely!).

I have reviewed both the text and the generated pages, I hope I haven't overlooked anything, but I think everything is up to code with a few nipicks.

code/XMLTesterExample.xml Outdated Show resolved Hide resolved
code/XMLTester.xml Show resolved Hide resolved
code/XMLTesterExample.xml Outdated Show resolved Hide resolved
@JLBuenoLopez
Refs #16315: apply review suggestions
474cb95 
Signed-off-by: JLBuenoLopez-eProsima <joseluisbueno@eprosima.com>
@EduPonz EduPonz merged commit 6e0b42e into master Jan 18, 2023
@EduPonz EduPonz deleted the fix/xml-example-order branch January 18, 2023 08:47
@JLBuenoLopez JLBuenoLopez mentioned this pull request Feb 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EduPonz EduPonz EduPonz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v2.9.1
Development

Successfully merging this pull request may close these issues.
2 participants
@JLBuenoLopez @EduPonz