Add a bit of documentation to the point module

This commit is contained in:
Brendan Zabarauskas 2013-07-11 14:59:18 +10:00
parent 50747703cf
commit de649c3b50

View file

@ -13,6 +13,13 @@
// See the License for the specific language governing permissions and // See the License for the specific language governing permissions and
// limitations under the License. // limitations under the License.
//! Coordinate vectors for positional data
//!
//! These types differ from the vector types implemented in `core::vec` because
//! they describe coordinates in geometric space and not a magnitude and a
//! direction. All positional data throughout the library uses these point
//! types, which allows for a clear, self-documenting API.
use std::cast; use std::cast;
use core::{Mat2, Mat3, Quat, Vec2, Vec3}; use core::{Mat2, Mat3, Quat, Vec2, Vec3};