Skip to content

Commit

Permalink
Refs #22012: Added TODO comments to start discussion
Browse files Browse the repository at this point in the history
Signed-off-by: Juanjo Garcia <[email protected]>
  • Loading branch information
juanjo4936 committed Dec 24, 2024
1 parent a1d8b70 commit 1cd570e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/notes/migration_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,8 @@ Step 5: Migrate public headers
Also, the ``fixed_size_string.hpp`` implementation has been migrated from ``fastrtps/utils/fixed_size_string.hpp``
to ``fastcdr/cdr/fixed_size_string.hpp``.

.. TODO:: Fix this table, ``fastdds/rtps/DomainParticipantQos.hpp`` has wrong path and doesn't include the content.

2. File extensions:

Rename file extensions from `.h` to `.hpp`.
Expand Down Expand Up @@ -208,6 +210,8 @@ If your project previously included any of these headers, you will need to modif
Since these headers are now private, you should replace their usage with public alternatives or refactor the
related code to ensure it does not depend on private headers.

.. TODO:: Add a note about which headers to use instead of the private ones.

.. _step-7-update-api-methods:

Step 7: Update API methods
Expand Down Expand Up @@ -395,6 +399,9 @@ your code to reflect these changes:
Step 9: Examples refactor
^^^^^^^^^^^^^^^^^^^^^^^^^

.. TODO:: What to do here? Write which examples in 2 turned into which examples in 3?
A lot of the info seems too much.

All examples have been refactored to follow a consistent structure across the Fast DDS project.
This includes renaming files, restructuring classes, and updating the overall format.
Additionally, it is important to note that some examples have been removed, renamed, or had significant changes
Expand Down

0 comments on commit 1cd570e

Please sign in to comment.