Add doxygen docs for particle_filter.hpp #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
|
Generated html docs where pushed to https://github.com/ekumenlabs/beluga/tree/ivanpauno/generated-docs.
|
|
@nahueespinosa I added you as a reviewer, but feel free to redirect or to add someone else. |
glpuga
reviewed
Jan 5, 2023
glpuga
reviewed
Jan 5, 2023
There was a problem hiding this comment.
@ivanpauno This is truly outstanding! I think the named requirements approach is the right choice here. I left a couple of comments, let me know what you think.
@glpuga Feel free to join in the discussions, I think it's a great opportunity to review the design.
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Co-authored-by: Nahuel Espinosa <nespinosa@ekumenlabs.com> Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
nahueespinosa
previously approved these changes
Jan 6, 2023
There was a problem hiding this comment.
@ivanpauno This is awesome! I think we can merge this barring some minor capitalization comments.
Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
nahueespinosa
approved these changes
Jan 6, 2023
ivanpauno
added a commit
that referenced
this pull request
Jan 12, 2023
This PR also: - Fixes minor issues in the docs added in #47. - Adds a script to generate the docs. Signed-off-by: Ivan Santiago Paunovic <ivanpauno@ekumenlabs.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partial attempt to complete #39.
There's still a lot to do, as it can be seen by the unlinked references to pieces of docs I haven't written yet.
But I wanted to know if the general approach I'm using looks okay.
Particularly, there's no standard way to document the "interface" that a template parameter should satisfy.
The approach I'm using is the "named requirements" approach.
This is the same approach that for example uses the standard library, e.g. https://en.cppreference.com/w/cpp/named_req/Container.
I'm using one doxygen
\pagefor each named requirement, but I think we can bundle many of them in sections of the same page (these is trivial to change later).There are a bunch of TODOs in the patch I'm adding:
We don't need to solve them here, but I thought it was useful if we have a minor discussion here and at least we craete an issue for them if it's needed.
I will continue writing docs, but I opened this initial PR so if we want to document things in a different style we can discuss that early in the process.
The remaining docs can be commited to this PR or we can move forward with this one and complete the docs in other PRs, as prefered.