[doc,geometry,multibody] Add refs to Hydroelastic User Guide #16549
Conversation
rpoyner-tri
added
the
release notes: none
There was a problem hiding this comment.
+@DamrongGuoy for feature review.
+(release notes: none)
Reviewable status: LGTM missing from assignee DamrongGuoy, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy)
There was a problem hiding this comment.
There're lint errors, but I'll start reviewing, anyway.
Reviewed all commit messages.
Reviewable status: LGTM missing from assignee DamrongGuoy, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy)
There was a problem hiding this comment.
Reviewable status: 2 unresolved discussions, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy and @rpoyner-tri)
a discussion (no related file):
Since proximity_properties.h declares its content in internal, I suppose it won't show up in Doxygen, right?
multibody/parsing/parsing_doxygen.h, line 388 at r1 (raw file):
@see drake::geometry::ProximityProperties, @ref mbp_hydroelastic_materials_properties "Hydroelastic contact",
Now that we have hug_properties in the next line, do we still want "Hydroelastic contact" here? I would think hug_properties is more direct to the point.
Optional. Remove it?
ref mbp_hydroelastic_materials_properties "Hydroelastic contact",
I'm fine with keeping it too.
There was a problem hiding this comment.
Reviewable status: 3 unresolved discussions, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy and @rpoyner-tri)
a discussion (no related file):
I used bazel run //doc/doxygen_cxx:build -- --serve --quick drake.{geometry,multibody}, and it looked good.
There was a problem hiding this comment.
Reviewable status: 3 unresolved discussions, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy and @rpoyner-tri)
a discussion (no related file):
Previously, DamrongGuoy (Damrong Guoy) wrote…
Since
proximity_properties.hdeclares its content ininternal, I suppose it won't show up in Doxygen, right?
I meant the content where this PR changes.
There was a problem hiding this comment.
Reviewable status: 3 unresolved discussions, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy and @rpoyner-tri)
a discussion (no related file):
Previously, DamrongGuoy (Damrong Guoy) wrote…
I meant the content where this PR changes.
There is no reference to @ref creating_hydro_reps or @ref hug_properties showing up on this web page.
There was a problem hiding this comment.
Reviewable status: 3 unresolved discussions, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy and @rpoyner-tri)
a discussion (no related file):
Previously, DamrongGuoy (Damrong Guoy) wrote…
I used
bazel run //doc/doxygen_cxx:build -- --serve --quick drake.{geometry,multibody}, and it looked good.
There was a problem hiding this comment.
Reviewable status: 1 unresolved discussion, needs platform reviewer assigned, needs at least two assigned reviewers (waiting on @DamrongGuoy)
a discussion (no related file):
Previously, DamrongGuoy (Damrong Guoy) wrote…
There is no reference to
@ref creating_hydro_repsor@ref hug_propertiesshowing up on this web page.
You need to click through to the individual function descriptions on that page to see the references. For example:
There is one change within the internal:: namespace. I figure that's just a freebie for people reading the code directly, and a hedge against future copy-paste.
rpoyner-tri
force-pushed
the
hydro-xref
branch
from
276ca36 to
98cb81b
Compare
There was a problem hiding this comment.
+@xuchenhan-tri for platform review, Wednesday schedule.
Reviewable status: 1 unresolved discussion, LGTM missing from assignee xuchenhan-tri(platform) (waiting on @DamrongGuoy and @xuchenhan-tri)
There was a problem hiding this comment.
Reviewed 1 of 2 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: LGTM missing from assignee xuchenhan-tri(platform) (waiting on @xuchenhan-tri)
a discussion (no related file):
Previously, rpoyner-tri (Rick Poyner (rico)) wrote…
You need to click through to the individual function descriptions on that page to see the references. For example:
There is one change within the internal:: namespace. I figure that's just a freebie for people reading the code directly, and a hedge against future copy-paste.
I see. Thanks for the explanation! Indeed I misunderstood which one is internal which one is not.
There was a problem hiding this comment.
Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status:complete! all discussions resolved, LGTM from assignees DamrongGuoy,xuchenhan-tri(platform) (waiting on @rpoyner-tri)
geometry/proximity_properties.h, line 57 at r2 (raw file):
- accounting for differences between tessellated meshes and half spaces. For the full discussion of preparing geometry for use in the
BTW, odd line break.
geometry/proximity_properties.h, line 130 at r2 (raw file):
/** Overload, intended for shapes that don't get tessellated in their hydroelastic representation (e.g., HalfSpace and Mesh). See @ref hug_properties. */
BTW, is "hug" short for "hydro user guide"? Took me a long while to figure that out.
Closes: RobotLocomotion#15743 The module ... it is written.
rpoyner-tri
force-pushed
the
hydro-xref
branch
from
98cb81b to
3eba074
Compare
There was a problem hiding this comment.
Reviewable status:
geometry/proximity_properties.h, line 130 at r2 (raw file):
Previously, xuchenhan-tri wrote…
BTW, is "hug" short for "hydro user guide"? Took me a long while to figure that out.
yeahh. :)
There was a problem hiding this comment.
Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status:
Closes: #15743
The module ... it is written.
This change is