> It might be worth looking into how .NET or other platforms with similar > architecture accomplish this, if at all.
The C# compiler has a switch that converts C# XML doc comments into an XML file, which is placed in the output folder beside the .DLL or .EXE file. This starting point makes a lot of sense, as binaries can be distributed with their documentation, and IDE "intellisense" can show basic documentation directly from the XML file, which is found automatically by looking for an XML file beside each referenced DLL. (Creating pretty-printed HTML documentation from the XML gets a bit complicated; a remarkably large number of separate tools are involved, but these tools are bundled together, and thanks to IDE features, the plain XML gets a lot of mileage.) While creating XML, the compiler resolves short references like <see cref="Foo"/> into a complete reference like <see cref="M:Blah.Blah.Foo"/> (where "M" means "Method", "T" means "Type", etc.) -- - David http://loyc-etc.blogspot.com
_______________________________________________ Rust-dev mailing list [email protected] https://mail.mozilla.org/listinfo/rust-dev
