Some documentation fixes.

Fix #25.
This commit is contained in:
Sébastien Crozet 2014-10-12 10:35:56 +02:00
parent b6090042ac
commit 03eda09084
3 changed files with 5 additions and 2 deletions

View File

@ -42,6 +42,7 @@ fn main() {
and keeps an optimized set of tools for computational graphics and physics. Those features include:
* Vectors with static sizes: `Vec0`, `Vec1`, `Vec2`, `Vec3`, `Vec4`, `Vec5`, `Vec6`.
* Points with static sizes: `Pnt0`, `Pnt1`, `Pnt2`, `Pnt3`, `Pnt4`, `Pnt5`, `Pnt6`.
* Square matrices with static sizes: `Mat1`, `Mat2`, `Mat3`, `Mat4`, `Mat5`, `Mat6 `.
* Rotation matrices: `Rot2`, `Rot3`, `Rot4`.
* Isometries: `Iso2`, `Iso3`, `Iso4`.
@ -87,7 +88,7 @@ Feel free to add your project to this list if you happen to use **nalgebra**!
* [nphysics](https://github.com/sebcrozet/nphysics): a real-time physics engine.
* [ncollide](https://github.com/sebcrozet/ncollide): a collision detection library.
* [kiss3d](https://github.com/sebcrozet/kiss3d): a minimalistic graphics engine.
* [frog](https://github.com/natal/frog): a machine learning library.
* [nrays](https://github.com/sebcrozet/nrays): a ray tracer.
*/
#![deny(non_camel_case_types)]

View File

@ -55,6 +55,7 @@ macro_rules! pnt_sub_vec_impl(
macro_rules! pnt_as_vec_impl(
($t: ident, $tv: ident, $comp0: ident $(,$compN: ident)*) => (
impl<N> $t<N> {
/// Converts this point to its associated vector.
#[inline]
pub fn to_vec(self) -> $tv<N> {
$tv::new(
@ -63,6 +64,7 @@ macro_rules! pnt_as_vec_impl(
)
}
/// Converts a reference to this point to a reference to its associated vector.
#[inline]
pub fn as_vec<'a>(&'a self) -> &'a $tv<N> {
unsafe {

View File

@ -361,7 +361,7 @@ impl<N, T: Div<N, T>> ScalarDiv<N> for T {
}
}
/// Trait of objects implementing the $$y = ax + y$$ operation.
/// Trait of objects implementing the `y = ax + y` operation.
pub trait Axpy<N> {
/// Adds $$a * x$$ to `self`.
fn axpy(&mut self, a: &N, x: &Self);