Document memory_conf_t and memory_rule_t members

[gavanderhoorn]

As per subject.

I've added some (very terse) documentation to the fields in micro_ros_utilities_memory_rule_t and micro_ros_utilities_memory_conf_t, as I kept having to go back to the Handling messages memory in micro-ROS page to see what the fields are for.

Note: I'm not sure I understood the purpose of each of the fields completely -- or documented them correctly. The purpose of this PR is as much a way for me to get some confirmation.

[codecov-commenter]

Codecov Report

Merging #30 (49da026) into galactic (327213a) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff              @@
##           galactic      #30      +/-   ##
============================================
  Coverage     60.84%   60.84%              
============================================
  Files           620       10     -610     
  Lines         64604     1042   -63562     
  Branches      27776      448   -27328     
============================================
- Hits          39308      634   -38674     
+ Misses         7688      124    -7564     
+ Partials      17608      284   -17324     

Impacted Files	Coverage Δ
...utilities/test/micro_ros_utilities/test_string.cpp
...ibc74rbsb/micro_ros_utilities/src/type_utilities.c
...utilities/test/micro_ros_utilities/test_memory.hpp
...utilities/test/micro_ros_utilities/test_memory.cpp
...utilities/test/micro_ros_utilities/test_memory.cpp
...utilities/test/micro_ros_utilities/test_string.cpp
...utilities/test/micro_ros_utilities/test_string.cpp
...utilities/test/micro_ros_utilities/test_memory.cpp
...1r9jr58rl/micro_ros_utilities/src/type_utilities.c
...utilities/test/micro_ros_utilities/test_string.cpp
... and 620 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 327213a...49da026. Read the comment docs.

[Acuadros95]

Just a few comments, also adding @pablogs9 as a reviewer.

[pablogs9]

I'm OK with this if @Acuadros95 comments are added. Ping @gavanderhoorn

[gavanderhoorn]

Friendly ping?

[pablogs9]

Please @gavanderhoorn could you add the requested changes?

[gavanderhoorn]

If you could take a look at my responses to your comments :)

[gavanderhoorn]

I've just accepted your proposal, as I couldn't come up with a satisfying alternative phrasing.

[Acuadros95]

@mergify backport main

[mergify]

backport main

✅ Backports have been created

Details

• #31 Document memory_conf_t and memory_rule_t members (backport #30) has been created for branch main

[gavanderhoorn]

thanks

[pablogs9]

This seems to have break the CI in the API doc generator: https://github.com/micro-ROS/micro-ROS.github.io/runs/6465261539?check_suite_focus=true

Can you take a look @Acuadros95 ?

[Acuadros95]

@pablogs9 Fixed on #34