Commit Graph

12 Commits

Author SHA1 Message Date
Bruce Mitchener 136a565579 docs: Use intradoc links rather than HTML.
This fixes almost all HTML links to be intradoc links that Rust
can verify during `cargo doc`. This will help prevent future
broken links.
2023-08-06 22:34:40 +07:00
Zacchary Dempsey-Plante 6eb642625b
Fix a typo in the doc comment for `Mat2x3`
Currently, the doc comment for `Mat2x3` incorrectly describes it as a 2x2 matrix. Obviously this is a very minor issue, but I figured it was worth fixing.
2021-07-30 16:18:31 +00:00
Crozet Sébastien 24d546d3b6 Rename generic parameter N -> T 2021-04-11 13:57:54 +02:00
sebcrozet b9ca074740 Execute rustfmt. 2018-10-22 06:23:40 +02:00
Bruce Mitchener 890286293f glm docs: Explain that TVec is a TMat. 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 a01fde5699 Add more doc linking and some doc tests. 2018-10-04 21:04:50 +02:00
Joe Clay 962e89417c Fix typo in GLM alias docs 2018-09-24 05:34:58 +02:00
sebcrozet 4140375b6e Rename the Mat and Vec aliases to TMat and TVec. 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 3e445430a4 Move files around and complete the doc. 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