The problem I guess is that there is no AST node to hang those tags
off of, unless I introduce artifical mods. I still want to try this.
It seems to make sense that the best way to structure the docs is also
the best way to structure the code.



Niko


On Thu, May 02, 2013 at 07:49:29PM -0600, Jack Moffitt wrote:
> > Maybe we can find a way to incorporate some sort of "section"
> > to use when grouping items, methods, fields, etc. I imagine
> > we could draw on Markdown's `#`, `##`, `###` notation to
> > define sections, subsections, and so forth, but I'm just
> > not sure how we would let rustdoc know about it, since there
> > is nothing in particular to attach the attribute to.
> >
> > Any thoughts? Is this something other people would like?
> 
> Why not just do it with an annotation and support arbitrary tags? Like:
> #[doc(section="Node construction")]
> 
> Or something like that. Then the doc generator can do whatever it
> likes with the tags, allowing all kinds of nice extensions later.
> 
> jack.
_______________________________________________
Rust-dev mailing list
[email protected]
https://mail.mozilla.org/listinfo/rust-dev

Reply via email to