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 documentation for beluga/algorithm header files #59

Merged
merged 22 commits into from
Jan 12, 2023
Merged

Complete documentation for beluga/algorithm header files #59

merged 22 commits into from
Jan 12, 2023

Conversation

ivanpauno
Copy link
Collaborator

This PR also:

@ivanpauno ivanpauno added the enhancement New feature or request label Jan 10, 2023
@ivanpauno ivanpauno self-assigned this Jan 10, 2023
@ivanpauno
wip
92f1e0b 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Complete documentation for beluga/algorithm
e387bee 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Fix documentation in particle_filter.hpp
ac854bf 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Add script to generate docs
cf8f4ab 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Avoid having multiple doxygen sections named Requirements
b6cb33f 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
More clarifications about constness
773c7b7 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Fix remaining doxygen warnings
d5b7236 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Fix script to generate docs
41a8c6f 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Copy link
Collaborator Author

Force pushed after rebasing to solve conflicts.

@ivanpauno
Fix clang-format issues
f246119 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
nahueespinosa
nahueespinosa requested changes Jan 11, 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 First pass!

beluga/include/beluga/algorithm/distance_map.hpp Show resolved Hide resolved
beluga/include/beluga/algorithm/estimation.hpp Show resolved Hide resolved
beluga/include/beluga/algorithm/estimation.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/exponential_filter.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/particle_filter.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/particle_filter.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/particle_filter.hpp Show resolved Hide resolved
beluga/include/beluga/algorithm/particle_filter.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Show resolved Hide resolved
@nahueespinosa nahueespinosa added the documentation Improvements or additions to documentation label Jan 11, 2023
@ivanpauno
Add \file doxygen sections to all files in beluga/algorithm
c98af6c 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Fix nearest_obstacle_distance_map() to require a sized random access …
f466163 
…range instead of a container. Fix the function docs as well

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Adjust covariance() code so template argument Range is a sized range …
74c23ab 
…and not a container. Adjust docs.

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Fix nits
25551f7 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Add doxygen to Dockerfile, rename generate_docs.bash -> generate_docs.sh
7630077 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Fix error introduced when rebasing
b8b3488 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Modify cluster()/weight()/state() requirements for particles types
dcc63ab 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Avoid dots at the end of doxygen \page titles
3011bf7 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Add new line after end of list in doxygen docs to avoid rendering issues
f85e24e 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
* Highlight code inline in text correctly.
dd18d63 
* Fix some \ref doxygen commands.
* Other minor style changes in docs.

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
nahueespinosa
nahueespinosa previously approved these changes Jan 12, 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 This is awesome! My comments are mostly nits, I think this is already in great shape.

beluga/docs/Doxyfile Outdated Show resolved Hide resolved
beluga/docs/css.css Outdated Show resolved Hide resolved
docker/images/humble/Dockerfile Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/distance_map.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/estimation.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/exponential_filter.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
@ivanpauno
* css.css -> doxygen_extra.css
d935f44 
* Modify custom css for inline code and code fragments.

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno
Address peer review comments
41fc23c 
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
nahueespinosa
nahueespinosa previously approved these changes Jan 12, 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!

There is one last missing newline at the end of a list and a bunch of nit-picky std::size_t comments.

Feel free to merge right after adding the newline!

beluga/include/beluga/algorithm/sampling.hpp Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
beluga/include/beluga/algorithm/sampling.hpp Outdated Show resolved Hide resolved
@ivanpauno
* New line after end of list in doxygen docs.
9588b37 
* size_t -> std::size_t

Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
@ivanpauno ivanpauno merged commit 1a4e153 into master Jan 12, 2023
@ivanpauno ivanpauno deleted the ivanpauno/docs-2 branch January 12, 2023 14:11
@nahueespinosa
Copy link
Member

For future reference: Related to #39.

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.

None yet
2 participants
@ivanpauno @nahueespinosa