update doc visibility

jeremyletang · jeremyletang · commit c28f819ad36f · 2013-09-25T22:18:13.000-04:00
diff --git a/src/rsfml/audio/music.rs b/src/rsfml/audio/music.rs
@@ -84,7 +84,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Music {
     priv music : *ffi::sfMusic
 }
diff --git a/src/rsfml/audio/sound.rs b/src/rsfml/audio/sound.rs
@@ -83,7 +83,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Sound<'self> {
     priv sound :    *ffi::sfSound,
     priv buffer :   &'self SoundBuffer
diff --git a/src/rsfml/audio/sound_buffer.rs b/src/rsfml/audio/sound_buffer.rs
@@ -59,7 +59,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct SoundBuffer {
     priv sound_buffer : *ffi::sfSoundBuffer,
     priv dropable :     bool
@@ -208,7 +207,6 @@ impl SoundBuffer {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfSoundBuffer> for SoundBuffer {
     fn wrap(buffer : *ffi::sfSoundBuffer) -> SoundBuffer {
         SoundBuffer {
diff --git a/src/rsfml/audio/sound_buffer_recorder.rs b/src/rsfml/audio/sound_buffer_recorder.rs
@@ -55,7 +55,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct SoundBufferRecorder {
     priv sound_buffer_recorder : *ffi::sfSoundBufferRecorder
 }
diff --git a/src/rsfml/audio/sound_recorder.rs b/src/rsfml/audio/sound_recorder.rs
@@ -53,7 +53,6 @@ pub mod ffi{
     }
 }
 
-#[doc(hidden)]
 pub struct SoundRecorder {
     priv sound_recorder : *ffi::sfSoundRecorder
 }
diff --git a/src/rsfml/graphics/circle_shape.rs b/src/rsfml/graphics/circle_shape.rs
@@ -100,7 +100,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct CircleShape<'self> {
     priv circle_shape : *ffi::sfCircleShape,
     priv texture :      Option<&'self Texture>
@@ -750,7 +749,6 @@ impl<'self> CircleShape<'self> {
 
 }
 
-#[doc(hidden)]
 impl<'self> Wrappable<*ffi::sfCircleShape> for CircleShape<'self> {
     #[doc(hidden)]
     fn wrap(circle_shape : *ffi::sfCircleShape) -> CircleShape {
diff --git a/src/rsfml/graphics/convex_shape.rs b/src/rsfml/graphics/convex_shape.rs
@@ -99,7 +99,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct ConvexShape<'self> {
     priv convex_shape : *ffi::sfConvexShape,
     priv texture :      Option<&'self Texture>
diff --git a/src/rsfml/graphics/font.rs b/src/rsfml/graphics/font.rs
@@ -63,7 +63,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Font {
     priv font :     *ffi::sfFont,
     priv dropable : bool
@@ -187,7 +186,6 @@ impl Font {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfFont> for Font {
     fn wrap(font : *ffi::sfFont) -> Font {
         Font {
diff --git a/src/rsfml/graphics/image.rs b/src/rsfml/graphics/image.rs
@@ -73,7 +73,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Image {
     priv image : *ffi::sfImage
 }
@@ -347,7 +346,6 @@ impl Image {
 
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfImage> for Image {
     fn wrap(image : *ffi::sfImage) -> Image {
         Image {
diff --git a/src/rsfml/graphics/rectangle_shape.rs b/src/rsfml/graphics/rectangle_shape.rs
@@ -98,7 +98,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct RectangleShape<'self> {
     priv rectangle_shape :  *ffi::sfRectangleShape,
     priv texture :          Option<&'self Texture>
@@ -747,7 +746,6 @@ impl<'self> RectangleShape<'self> {
     }
 }
 
-#[doc(hidden)]
 impl<'self> Wrappable<*ffi::sfRectangleShape> for RectangleShape<'self> {
     fn wrap(rectangle_shape : *ffi::sfRectangleShape) -> RectangleShape {
         RectangleShape {
diff --git a/src/rsfml/graphics/render_states.rs b/src/rsfml/graphics/render_states.rs
@@ -50,7 +50,7 @@ pub mod ffi {
 }
 
 /**
-* brief Define the states used for drawing to a RenderTarget
+* Define the states used for drawing to a RenderTarget
 */
 pub struct RenderStates<'self> {
     priv sfRenderStates :   ffi::sfRenderStates,
diff --git a/src/rsfml/graphics/render_texture.rs b/src/rsfml/graphics/render_texture.rs
@@ -106,7 +106,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct RenderTexture {
     render_texture : *ffi::sfRenderTexture
 }
diff --git a/src/rsfml/graphics/render_window.rs b/src/rsfml/graphics/render_window.rs
@@ -150,7 +150,6 @@ pub enum WindowStyle {
     sfDefaultStyle =    7
 }
 
-#[doc(hidden)]
 pub struct RenderWindow {
     priv render_window :    *ffi::sfRenderWindow,
     priv event :            ffi::sfEvent,
diff --git a/src/rsfml/graphics/shader.rs b/src/rsfml/graphics/shader.rs
@@ -75,7 +75,6 @@ pub mod ffi {
    }
 }
 
-#[doc(hidden)]
 pub struct Shader<'self> {
     priv shader :   *ffi::sfShader,
     priv texture :  Option<&'self Texture>
@@ -367,7 +366,6 @@ impl<'self> Shader<'self> {
 
 }
 
-#[doc(hidden)]
 impl<'self> Wrappable<*ffi::sfShader> for Shader<'self> {
     fn wrap(shader : *ffi::sfShader) -> Shader {
         Shader {
diff --git a/src/rsfml/graphics/sprite.rs b/src/rsfml/graphics/sprite.rs
@@ -91,7 +91,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Sprite<'self> {
     priv sprite :   *ffi::sfSprite,
     priv texture :  Option<&'self Texture>
@@ -602,7 +601,6 @@ impl<'self> Sprite<'self> {
 
 }
 
-#[doc(hidden)]
 impl<'self> Wrappable<*ffi::sfSprite> for Sprite<'self> {
     fn wrap(sprite : *ffi::sfSprite) -> Sprite {
         Sprite { 
@@ -617,7 +615,6 @@ impl<'self> Wrappable<*ffi::sfSprite> for Sprite<'self> {
     
 }
 
-#[doc(hidden)]
 impl<'self> Drawable for Sprite<'self> {
     /**
     * Draw the sprite in the RenderWindow
diff --git a/src/rsfml/graphics/text.rs b/src/rsfml/graphics/text.rs
@@ -690,7 +690,6 @@ impl<'self> Text<'self> {
     }
 }
 
-#[doc(hidden)]
 impl<'self> Wrappable<*ffi::sfText> for Text<'self> {
     fn wrap(text : *ffi::sfText) -> Text {
         Text {
@@ -704,7 +703,6 @@ impl<'self> Wrappable<*ffi::sfText> for Text<'self> {
     }
 }
 
-#[doc(hidden)]
 impl<'self> Drawable for Text<'self> {
     fn draw_in_render_window(&self, render_window : &RenderWindow) -> () {
         render_window.draw_text(self)
diff --git a/src/rsfml/graphics/texture.rs b/src/rsfml/graphics/texture.rs
@@ -79,7 +79,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Texture {
     priv texture :  *ffi::sfTexture,
     priv dropable : bool
@@ -417,7 +416,6 @@ impl Texture {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfTexture> for Texture {
     fn unwrap(&self) -> *ffi::sfTexture {
         self.texture
diff --git a/src/rsfml/graphics/transform.rs b/src/rsfml/graphics/transform.rs
@@ -61,7 +61,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Transform {
         a00 : f32,
         a01 : f32,
diff --git a/src/rsfml/graphics/transformable.rs b/src/rsfml/graphics/transformable.rs
@@ -70,7 +70,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Transformable{
     priv transformable : *ffi::sfTransformable
 }
@@ -306,7 +305,6 @@ impl Transformable {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfTransformable> for Transformable {
     fn wrap(transformable : *ffi::sfTransformable) -> Transformable {
         Transformable {
diff --git a/src/rsfml/graphics/vertex_array.rs b/src/rsfml/graphics/vertex_array.rs
@@ -78,7 +78,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct VertexArray {
     priv vertex_array : *ffi::sfVertexArray
 }
diff --git a/src/rsfml/graphics/view.rs b/src/rsfml/graphics/view.rs
@@ -68,7 +68,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct View {
     priv dropable : bool,
     priv view :     *ffi::sfView
@@ -375,7 +374,6 @@ impl View {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfView> for View {
     fn wrap(view : *ffi::sfView) -> View {
         View { 
diff --git a/src/rsfml/network/ftp.rs b/src/rsfml/network/ftp.rs
@@ -166,24 +166,20 @@ pub enum Status {
     InvalidFile      = 1003  // Invalid file to upload / download
 }
 
-#[doc(hidden)]
 pub struct Ftp {
     priv ftp : *ffi::sfFtp
 }
 
 
-#[doc(hidden)]
 pub struct Response{
     priv response : *ffi::sfFtpResponse
 }
 
-#[doc(hidden)]
 pub struct ListingResponse{
     priv listing_response : *ffi::sfFtpListingResponse
 }
 
 
-#[doc(hidden)]
 pub struct DirectoryResponse{
     priv directory_response : *ffi::sfFtpDirectoryResponse
 }
diff --git a/src/rsfml/network/http.rs b/src/rsfml/network/http.rs
@@ -118,17 +118,14 @@ pub enum Status {
     ConnectionFailed = 1001  //< Connection with server failed
 }
 
-#[doc(hidden)]
 pub struct Request {
     priv request : *ffi::sfHttpRequest
 }
 
-#[doc(hidden)]
 pub struct Response {
     priv response : *ffi::sfHttpResponse
 }
 
-#[doc(hidden)]
 pub struct Http {
     priv http : *ffi::sfHttp
 }
diff --git a/src/rsfml/network/ip_address.rs b/src/rsfml/network/ip_address.rs
@@ -217,7 +217,6 @@ impl IpAddress {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<ffi::sfIpAddress> for IpAddress {
     fn wrap(ip : ffi::sfIpAddress) -> IpAddress {
         IpAddress {
diff --git a/src/rsfml/network/packet.rs b/src/rsfml/network/packet.rs
@@ -391,7 +391,6 @@ impl Packet {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfPacket> for Packet {
     fn unwrap(&self) -> *ffi::sfPacket {
         self.packet
diff --git a/src/rsfml/network/tcp_listener.rs b/src/rsfml/network/tcp_listener.rs
@@ -61,7 +61,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct TcpListener {
     priv listener : *ffi::sfTcpListener
 }
diff --git a/src/rsfml/network/tcp_socket.rs b/src/rsfml/network/tcp_socket.rs
@@ -71,7 +71,6 @@ pub mod ffi {
 
 }
 
-#[doc(hidden)]
 pub struct TcpSocket {
     priv socket : *ffi::sfTcpSocket
 }
@@ -284,7 +283,6 @@ impl TcpSocket {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfTcpSocket> for TcpSocket {
     fn wrap(socket : *ffi::sfTcpSocket) -> TcpSocket {
         TcpSocket {
diff --git a/src/rsfml/network/udp_socket.rs b/src/rsfml/network/udp_socket.rs
@@ -68,7 +68,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct UdpSocket {
     priv socket : *ffi::sfUdpSocket
 }
@@ -278,7 +277,6 @@ impl UdpSocket {
     }
 }
 
-#[doc(hidden)]
 impl Wrappable<*ffi::sfUdpSocket> for UdpSocket {
     fn wrap(socket : *ffi::sfUdpSocket) -> UdpSocket {
         UdpSocket {
diff --git a/src/rsfml/system/clock.rs b/src/rsfml/system/clock.rs
@@ -52,7 +52,6 @@ pub mod ffi {
 }
 
 
-#[doc(hidden)]
 pub struct Clock {
     priv clock : *ffi::sfClock
 }
diff --git a/src/rsfml/system/time.rs b/src/rsfml/system/time.rs
@@ -52,7 +52,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Time {
     priv time : ffi::sfTime
 }
diff --git a/src/rsfml/system/vector3.rs b/src/rsfml/system/vector3.rs
@@ -24,9 +24,6 @@
 
 /*!
 * Utility Class providing 3 dimensional vectors for float.
-* 
-* Create your own by implementing the Trait Vector3
-*
 */
 
 pub use std::libc::{c_float};
diff --git a/src/rsfml/window/context.rs b/src/rsfml/window/context.rs
@@ -47,7 +47,6 @@ pub mod ffi {
     }
 }
 
-#[doc(hidden)]
 pub struct Context {
     priv cont : *ffi::sfContext
 }
diff --git a/src/rsfml/window/window.rs b/src/rsfml/window/window.rs

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,6 @@ pub mod ffi {`
`84`	`84`	`}`
`85`	`85`	`}`
`86`	`86`
`87`		`-#[doc(hidden)]`
`88`	`87`	`pub struct Music {`
`89`	`88`	`priv music : *ffi::sfMusic`
`90`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,6 @@ pub mod ffi {`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
`86`		`-#[doc(hidden)]`
`87`	`86`	`pub struct Sound<'self> {`
`88`	`87`	`priv sound : *ffi::sfSound,`
`89`	`88`	`priv buffer : &'self SoundBuffer`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,6 @@ pub mod ffi {`
`59`	`59`	`}`
`60`	`60`	`}`
`61`	`61`
`62`		`-#[doc(hidden)]`
`63`	`62`	`pub struct SoundBuffer {`
`64`	`63`	`priv sound_buffer : *ffi::sfSoundBuffer,`
`65`	`64`	`priv dropable : bool`
`@@ -208,7 +207,6 @@ impl SoundBuffer {`
`208`	`207`	`}`
`209`	`208`	`}`
`210`	`209`
`211`		`-#[doc(hidden)]`
`212`	`210`	`impl Wrappable<*ffi::sfSoundBuffer> for SoundBuffer {`
`213`	`211`	`fn wrap(buffer : *ffi::sfSoundBuffer) -> SoundBuffer {`
`214`	`212`	`SoundBuffer {`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,6 @@ pub mod ffi {`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
`58`		`-#[doc(hidden)]`
`59`	`58`	`pub struct SoundBufferRecorder {`
`60`	`59`	`priv sound_buffer_recorder : *ffi::sfSoundBufferRecorder`
`61`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,6 @@ pub mod ffi{`
`53`	`53`	`}`
`54`	`54`	`}`
`55`	`55`
`56`		`-#[doc(hidden)]`
`57`	`56`	`pub struct SoundRecorder {`
`58`	`57`	`priv sound_recorder : *ffi::sfSoundRecorder`
`59`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,6 @@ pub mod ffi {`
`100`	`100`	`}`
`101`	`101`	`}`
`102`	`102`
`103`		`-#[doc(hidden)]`
`104`	`103`	`pub struct CircleShape<'self> {`
`105`	`104`	`priv circle_shape : *ffi::sfCircleShape,`
`106`	`105`	`priv texture : Option<&'self Texture>`
`@@ -750,7 +749,6 @@ impl<'self> CircleShape<'self> {`
`750`	`749`
`751`	`750`	`}`
`752`	`751`
`753`		`-#[doc(hidden)]`
`754`	`752`	`impl<'self> Wrappable<*ffi::sfCircleShape> for CircleShape<'self> {`
`755`	`753`	`#[doc(hidden)]`
`756`	`754`	`fn wrap(circle_shape : *ffi::sfCircleShape) -> CircleShape {`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,6 @@ pub mod ffi {`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`
`102`		`-#[doc(hidden)]`
`103`	`102`	`pub struct ConvexShape<'self> {`
`104`	`103`	`priv convex_shape : *ffi::sfConvexShape,`
`105`	`104`	`priv texture : Option<&'self Texture>`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@ pub mod ffi {`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`
`66`		`-#[doc(hidden)]`
`67`	`66`	`pub struct Font {`
`68`	`67`	`priv font : *ffi::sfFont,`
`69`	`68`	`priv dropable : bool`
`@@ -187,7 +186,6 @@ impl Font {`
`187`	`186`	`}`
`188`	`187`	`}`
`189`	`188`
`190`		`-#[doc(hidden)]`
`191`	`189`	`impl Wrappable<*ffi::sfFont> for Font {`
`192`	`190`	`fn wrap(font : *ffi::sfFont) -> Font {`
`193`	`191`	`Font {`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,6 @@ pub mod ffi {`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
`76`		`-#[doc(hidden)]`
`77`	`76`	`pub struct Image {`
`78`	`77`	`priv image : *ffi::sfImage`
`79`	`78`	`}`
`@@ -347,7 +346,6 @@ impl Image {`
`347`	`346`
`348`	`347`	`}`
`349`	`348`
`350`		`-#[doc(hidden)]`
`351`	`349`	`impl Wrappable<*ffi::sfImage> for Image {`
`352`	`350`	`fn wrap(image : *ffi::sfImage) -> Image {`
`353`	`351`	`Image {`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,6 @@ pub mod ffi {`
`98`	`98`	`}`
`99`	`99`	`}`
`100`	`100`
`101`		`-#[doc(hidden)]`
`102`	`101`	`pub struct RectangleShape<'self> {`
`103`	`102`	`priv rectangle_shape : *ffi::sfRectangleShape,`
`104`	`103`	`priv texture : Option<&'self Texture>`
`@@ -747,7 +746,6 @@ impl<'self> RectangleShape<'self> {`
`747`	`746`	`}`
`748`	`747`	`}`
`749`	`748`
`750`		`-#[doc(hidden)]`
`751`	`749`	`impl<'self> Wrappable<*ffi::sfRectangleShape> for RectangleShape<'self> {`
`752`	`750`	`fn wrap(rectangle_shape : *ffi::sfRectangleShape) -> RectangleShape {`
`753`	`751`	`RectangleShape {`