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

No images for FrictionJoint #113

Open
louis-langholtz opened this issue Sep 18, 2017 · 2 comments
Open

No images for FrictionJoint #113

louis-langholtz opened this issue Sep 18, 2017 · 2 comments
Labels
Docs Use when issue or pull request relates to the documentation of the project. Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. Help Wanted For things that other people are encouraged to help with.
Milestone

Comments

@louis-langholtz
Copy link
Owner

Expected/Desired Behavior or Experience:

There'd be a PNG formatted image for a FrictionJoint in the Documentation/images folder.

Actual Behavior:

There are no images that show a FrictionJoint.

Steps to Reproduce the Actual Behavior:

Visual inspection.

Related Issues

@louis-langholtz louis-langholtz added Docs Use when issue or pull request relates to the documentation of the project. Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. Help Wanted For things that other people are encouraged to help with. labels Sep 18, 2017
@louis-langholtz louis-langholtz added this to the 1.0 Release milestone Sep 18, 2017
@NauticalMile64
Copy link
Contributor

With regards to issues #113 #114 #115 #116 and #117, where are these images being used?

@louis-langholtz
Copy link
Owner Author

louis-langholtz commented Jan 11, 2018

@NauticalMile64

This image would be used in the Doxygen generated HTML documentation for their respective components. So for FrictionJoint, the image would be seen in playrho::d2::FrictionJoint Class Reference.

An example of an existing image that's used this way can be seen in the Detailed Description portion of the documentation for the DistanceJoint.

If you made pull requests (or a single combined one) which added the animated images that I believe you made yourself for the Renaming Joints issue, to the Documentation/images folder, these would be very welcome and I'd love to add these to the Doxygen documentation. While I could add these myself with your permission to the Documentation/images folder, it'd be harder to see that the contribution was from you and I'd much prefer pulling contributed content in as a pull requests directly from the producer of any content. Linking the image from the folder (once it's in the folder) into the Doxygen comments is another part of putting that all together but I don't mind doing that part.

Having transparent background (or background matching the documentation) would be nicest IMO but a picture with a different color background I think is still better than no image at all. Also animated images I think explain the joint usage better than non-animated ones but again, any image for the joint seems better than none.

@louis-langholtz louis-langholtz modified the milestones: 1.0 Release, 1.0+ Nov 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Use when issue or pull request relates to the documentation of the project. Enhancement For suggestions or changes that enhance any part of the project and isn't a bug. Help Wanted For things that other people are encouraged to help with.
Projects
None yet
Development

No branches or pull requests

2 participants