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

Complete beluga documentation #66

Merged
merged 10 commits into from
Jan 17, 2023
Merged

Complete beluga documentation #66

merged 10 commits into from
Jan 17, 2023

Conversation

ivanpauno
Copy link
Collaborator

Fixes #39.

This should complete beluga documentation.

@ivanpauno
Document type traits
cefcdea 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Document spatial_hash.hpp
c017275 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Document tuple_vector.hpp
b29fb8e 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
* Fix \\file directives.
a79a144 
* Document all files.

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno ivanpauno added the enhancement New feature or request label Jan 16, 2023
@ivanpauno ivanpauno self-assigned this Jan 16, 2023
@ivanpauno
Copy link
Collaborator Author

Note to self: check if there's any TODO in the code that should be fixed before closing #39.

nahueespinosa
nahueespinosa requested changes Jan 16, 2023
View reviewed changes
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

@ivanpauno Left some minor comments.

beluga/include/beluga/type_traits/particle_traits.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/spatial_hash.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/spatial_hash.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/views.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/spatial_hash.hpp Show resolved Hide resolved
beluga/include/beluga/spatial_hash.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/type_traits/particle_traits.hpp Outdated Show resolved Hide resolved
@nahueespinosa nahueespinosa mentioned this pull request Jan 17, 2023
Merged
@ivanpauno
Fix alpha3 -> alpha4
46652e0 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Address peer review comments
39a9d96 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
* Enable Doxygen warn if undocumented option.
1b4ce69 
* Document remaining items.
* Fix other doxygen warnings.

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Copy link
Collaborator Author

Fixed #70 (comment) in 46652e0.

@ivanpauno
Solve TODOs related to missing links
58d7c66 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
nahueespinosa
nahueespinosa previously approved these changes Jan 17, 2023
View reviewed changes
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

@ivanpauno LGTM!

beluga/include/beluga/spatial_hash.hpp Outdated Show resolved Hide resolved
@nahueespinosa nahueespinosa added the documentation Improvements or additions to documentation label Jan 17, 2023
@ivanpauno
Document the OccupancyGrid2d requirements
30cd40e 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Use [[maybe_unused]] instead of cast to void
b3c7f5f 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Copy link
Collaborator Author

Note to self: check if there's any TODO in the code that should be fixed before closing #39.

I think I solved all remaining TODOs related to documentation after 30cd40e.

nahueespinosa
nahueespinosa approved these changes Jan 17, 2023
View reviewed changes
Copy link
Member

@nahueespinosa nahueespinosa left a comment

Choose a reason for hiding this comment

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

Awesome job!

@ivanpauno ivanpauno merged commit 44e05a8 into main Jan 17, 2023
@ivanpauno ivanpauno deleted the ivanpauno/docs-4 branch January 17, 2023 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nahueespinosa nahueespinosa nahueespinosa approved these changes

Assignees

@ivanpauno ivanpauno

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document beluga code
2 participants
@ivanpauno @nahueespinosa