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

API documentation summary for remaining classes (ROS 2 Gem) #319

Open
adamdbrw opened this issue May 9, 2023 · 0 comments
Open

API documentation summary for remaining classes (ROS 2 Gem) #319

adamdbrw opened this issue May 9, 2023 · 0 comments
Labels
feature/robotics This item is related to robotics. good-first-issue Issue ready for a new contributor according to the help wanted guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/major Major priority. Work that should be handled after all blocking and critical work is done. sig/simulation Categorizes an issue or PR as relevant to SIG Simulation triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@adamdbrw
Copy link
Contributor

adamdbrw commented May 9, 2023

Some classes are missing summary and they are thus not described in doxygen documentation. See https://www.o3de.org/docs/api/gems/ros2/annotated.html.
image

We would like all of the classes to be (at least briefly) documented.
@adamdbrw adamdbrw added kind/documentation Categorizes issue or PR as related to documentation. priority/major Major priority. Work that should be handled after all blocking and critical work is done. feature/robotics This item is related to robotics. labels May 9, 2023
@byrcolin byrcolin added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/simulation Categorizes an issue or PR as relevant to SIG Simulation labels May 16, 2023
@lgleim lgleim added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 25, 2023
MateuszWasilewski pushed a commit to RobotecAI/o3de-extras that referenced this issue Oct 11, 2023
@michalpelka
switched to AZStd where possible (o3de#319)
17e7a2b 
Signed-off-by: Michał Pełka <[email protected]>
@adamdbrw adamdbrw added the good-first-issue Issue ready for a new contributor according to the help wanted guidelines. label Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature/robotics This item is related to robotics. good-first-issue Issue ready for a new contributor according to the help wanted guidelines. kind/documentation Categorizes issue or PR as related to documentation. priority/major Major priority. Work that should be handled after all blocking and critical work is done. sig/simulation Categorizes an issue or PR as relevant to SIG Simulation triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lgleim @adamdbrw @byrcolin