On 06/21/2013 02:32 PM, Corey Richardson wrote:
Using https://github.com/huonw/rust-rand as the example crate, I've started a sketch at http://octayn.net/rdoc-proto/. Not intended to work or be pretty or usable, but intended to present the structure of documentation.
I don't know how I feel about the struct definition. I feel like it should be replaced with a list of public fields (in order, so you can use the documentation to instantiate a struct manually). Alternatively it could stay, but each field could link to an documentation entry for that field.
This also brings a point of public vs private API, it'd be nice if the doc generator could generate a public-only API documentation and a public + private API documentation.
-SL _______________________________________________ Rust-dev mailing list [email protected] https://mail.mozilla.org/listinfo/rust-dev
