Commit Graph

95 Commits

Author SHA1 Message Date
Bruce Mitchener
e7610196b6 Add more see also content. 2018-10-08 07:54:26 +02:00
Bruce Mitchener
8b0918ff1f Add more doc test and correct see also for vector relational functions. 2018-10-08 07:54:26 +02:00
Bruce Mitchener
ccc55b5766 Correctly flag "See also" headers. 2018-10-08 07:54:26 +02:00
sebcrozet
f0b29a9d23 Fix glm::clamp.
Fix #434.
2018-10-07 07:26:24 +02:00
Bruce Mitchener
81b19e9c8e glm docs: Add examples for clamp and clamp_scalar. 2018-10-07 06:01:36 +02:00
Bruce Mitchener
890286293f glm docs: Explain that TVec is a TMat. 2018-10-07 06:01:36 +02:00
Bruce Mitchener
0c5cc0b65e glm docs: Fix broken doc test. 2018-10-07 06:01:36 +02:00
Bruce Mitchener
aed58d0dd6 Vector and quaternion alias improvements.
By aliasing to the aliases defined within glm rather than going
directly to nalgebra types / aliases, we're able to improve the
experience of linking through the docs in the glm docs.

For example, with TVec1 defined in terms of TVec rather than Vector1,
then the docs link from TVec1 to TVec and we're able to better
explain the concepts at the glm level.
2018-10-05 20:34:15 +02:00
Bruce Mitchener
a34ad7d15f clippy: Use f32::from_bits(). 2018-10-05 20:30:41 +02:00
Bruce Mitchener
cb96cdb794 clippy: Prefer unwrap_or_else to unwrap_or. 2018-10-05 06:00:50 +02:00
Bruce Mitchener
71011c080e clippy: Remove redundant closures. 2018-10-05 06:00:21 +02:00
sebcrozet
8699a85693 Remove doc-test for sign on matrices since they are not supported for now. 2018-10-05 05:56:25 +02:00
sebcrozet
87c97497d2 Fix the glm::sign function to match its documentation.
Fix #422.
2018-10-05 05:56:25 +02:00
sebcrozet
e2736caff6 Fix glm::perspective.
Fix #423.
2018-10-05 05:50:56 +02:00
Bruce Mitchener
a01fde5699 Add more doc linking and some doc tests. 2018-10-04 21:04:50 +02:00
Bruce Mitchener
516abbfa06 'every components' -> 'every component' 2018-10-04 05:26:21 +02:00
Bruce Mitchener
ca9b4e38dd Add more see-also content to glm docs. 2018-10-04 05:26:21 +02:00
Bruce Mitchener
a8ae62ea52 Improve cross-linking and cross-referencing in docs. 2018-09-27 06:00:32 +02:00
Bruce Mitchener
c6ca1ca3e2 glm: Use - instead of : after parameter names.
This makes things consistent with the other doc comments here.
2018-09-25 20:17:27 +02:00
Bruce Mitchener
20b464f5b8 glm: Add missing backticks around parameter names. 2018-09-25 20:17:27 +02:00
Bruce Mitchener
96a2a56800 Use 3 space indents to avoid triggering syntax highlighting. 2018-09-25 20:17:27 +02:00
Bruce Mitchener
c56ec720eb glm: Use doc comments instead of regular comment. 2018-09-25 20:17:27 +02:00
Bruce Mitchener
175c41ed3a Typo fixes. 2018-09-24 21:15:07 +02:00
Joe Clay
962e89417c Fix typo in GLM alias docs 2018-09-24 05:34:58 +02:00
sebcrozet
053d51989a Re-export nalgebra's zero and one instead of defining new ones. 2018-09-23 17:10:49 +02:00
sebcrozet
b8b86e72b5 Various documentation fixes. 2018-09-23 17:10:49 +02:00
sebcrozet
41fb5403b5 Mention TMat and TVec on the doc. 2018-09-23 17:10:49 +02:00
sebcrozet
4140375b6e Rename the Mat and Vec aliases to TMat and TVec. 2018-09-23 17:10:49 +02:00
sebcrozet
9e4087d466 Reexport more nalgebra types and traits. 2018-09-23 17:10:49 +02:00
sebcrozet
975e0a8b6b Add the TVec* and TMat* aliases. 2018-09-23 17:10:49 +02:00
sebcrozet
ea668dea90 Various documentation improvements. 2018-09-23 17:10:49 +02:00
sebcrozet
71361fa136 Add more docs on lib.rs 2018-09-23 17:10:49 +02:00
sebcrozet
d5e747bd4a Add more 2D transformation constructors. 2018-09-23 17:10:49 +02:00
sebcrozet
130885d83a Add conversion functions between square matrices. 2018-09-23 17:10:49 +02:00
sebcrozet
f2bad264ef Re-export conversion functions. 2018-09-23 17:10:49 +02:00
sebcrozet
2a6302cd54 Fix some comments. 2018-09-23 17:10:49 +02:00
sebcrozet
cff8f398ba Resolve all name conflicts. 2018-09-23 17:10:49 +02:00
sebcrozet
1b2fc74f33 Resolve some name conflicts. 2018-09-23 17:10:49 +02:00
sebcrozet
81745b5464 Add a quat_ perfix to all quaternion functions. 2018-09-23 17:10:49 +02:00
sebcrozet
5ebb1fa635 Fix typo. 2018-09-23 17:10:49 +02:00
sebcrozet
3e445430a4 Move files around and complete the doc. 2018-09-23 17:10:49 +02:00
sebcrozet
98cf1a8d17 Implement more gtx functions. 2018-09-23 17:10:49 +02:00
sebcrozet
a827e2d95f Start adding some gtx functions. 2018-09-23 17:10:49 +02:00
sebcrozet
e7edad5ebb Start actually implementing the GLM functions. 2018-09-23 17:10:49 +02:00
sebcrozet
bee63859c0 Setup functions signatures for the glm interface. 2018-09-23 17:10:49 +02:00