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.

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

API documentation common Get* feature #162

Merged
merged 13 commits into from
Dec 3, 2020

Conversation

anindex
Copy link
Contributor

@anindex anindex commented Nov 14, 2020

From issue #9

Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
Signed-off-by: anindex <[email protected]>
@anindex anindex requested a review from mxgrey as a code owner November 14, 2020 19:21
@anindex anindex changed the title Api doc get feature API documentation Get* feature Nov 14, 2020
@anindex anindex changed the title API documentation Get* feature API documentation common Get* feature Nov 14, 2020
@chapulina chapulina added the documentation Improvements or additions to documentation label Nov 16, 2020
Copy link
Contributor

@claireyywang claireyywang left a comment

Choose a reason for hiding this comment

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

Looks good in general. I just had some minor comments about format and wording. I noticed you borrowed some definition and wording from existing API documentation, which is helpful but not great reference. It'd be better for our new API documentation to improve based on that effort rather than keeping it.

include/ignition/physics/GetBoundingBox.hh Outdated Show resolved Hide resolved
include/ignition/physics/GetEntities.hh Outdated Show resolved Hide resolved
include/ignition/physics/GetEntities.hh Outdated Show resolved Hide resolved
include/ignition/physics/Joint.hh Outdated Show resolved Hide resolved
Signed-off-by: anindex <[email protected]>
@claireyywang claireyywang merged commit ee6e7cc into gazebosim:main Dec 3, 2020
claireyywang added a commit that referenced this pull request Jan 7, 2021
* GetEngineInfo docs

Signed-off-by: anindex <[email protected]>

* GetWorldFromEngine docs

Signed-off-by: anindex <[email protected]>

* GetModelFromWorld docs

Signed-off-by: anindex <[email protected]>

* GetLinkFromModel docs

Signed-off-by: anindex <[email protected]>

* GetJointFromModel docs

Signed-off-by: anindex <[email protected]>

* GetShapeFromLink docs

Signed-off-by: anindex <[email protected]>

* GetJoint* docs

Signed-off-by: anindex <[email protected]>

* GetShape* docs

Signed-off-by: anindex <[email protected]>

* GetShapeFriction docs

Signed-off-by: anindex <[email protected]>

* Get bounding box docs

Signed-off-by: anindex <[email protected]>

* Refine docs

Signed-off-by: anindex <[email protected]>

Co-authored-by: anindex <[email protected]>
Co-authored-by: Claire Wang <[email protected]>
claireyywang added a commit that referenced this pull request Jan 7, 2021
* GetEngineInfo docs

Signed-off-by: anindex <[email protected]>

* GetWorldFromEngine docs

Signed-off-by: anindex <[email protected]>

* GetModelFromWorld docs

Signed-off-by: anindex <[email protected]>

* GetLinkFromModel docs

Signed-off-by: anindex <[email protected]>

* GetJointFromModel docs

Signed-off-by: anindex <[email protected]>

* GetShapeFromLink docs

Signed-off-by: anindex <[email protected]>

* GetJoint* docs

Signed-off-by: anindex <[email protected]>

* GetShape* docs

Signed-off-by: anindex <[email protected]>

* GetShapeFriction docs

Signed-off-by: anindex <[email protected]>

* Get bounding box docs

Signed-off-by: anindex <[email protected]>

* Refine docs

Signed-off-by: anindex <[email protected]>

Co-authored-by: anindex <[email protected]>
Co-authored-by: Claire Wang <[email protected]>
chapulina pushed a commit that referenced this pull request Jan 21, 2021
* GetEngineInfo docs

Signed-off-by: anindex <[email protected]>

* GetWorldFromEngine docs

Signed-off-by: anindex <[email protected]>

* GetModelFromWorld docs

Signed-off-by: anindex <[email protected]>

* GetLinkFromModel docs

Signed-off-by: anindex <[email protected]>

* GetJointFromModel docs

Signed-off-by: anindex <[email protected]>

* GetShapeFromLink docs

Signed-off-by: anindex <[email protected]>

* GetJoint* docs

Signed-off-by: anindex <[email protected]>

* GetShape* docs

Signed-off-by: anindex <[email protected]>

* GetShapeFriction docs

Signed-off-by: anindex <[email protected]>

* Get bounding box docs

Signed-off-by: anindex <[email protected]>

* Refine docs

Signed-off-by: anindex <[email protected]>

Co-authored-by: anindex <[email protected]>
Co-authored-by: Claire Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants