xml file, so that’s the first port of call – just a case of ticking a box and then changing the default filename slightly… because for some bizarre reason, Visual Studio defaults to creating a ".XML" file instead of ".xml". The build project doesn’t currently even create the. Obviously there’s a warning available for this so we’ll be able to make sure that eventually everything’s documented, but we also need to be able to build documentation before we reach that point. Noda Time has some documentation, but there are plenty of public members which don’t have any XML documentation at all at the moment. I’m not expecting that idea to be useful for Noda Time in the near future, but you never know.) (I’ve mailed Scott Hanselman and Matt Hawley about the idea of having an ASP.NET component of some form which could dynamically generate all this stuff on the fly – you’d just need to upload the. If the best way forward turns out to be something completely different, that’s fine.
#Ghostdoc doxygen code#
Ideally I’d like to be able to put the web pages on the Google Code project page, but I don’t know how feasible that will be. I don’t have much in the way of preconceived ideas of what the output should be: my guess is a CHM file and something to integrate into MSDN, as well as some static web pages. My eventual aim is to include "build the docs" as a task in the build procedure for Noda Time. I didn’t try any other options as I’m unaware of them. I should point out that I considered using NDoc (it just didn’t make sense to use a dead project) and docu (I’m not keen on the output style, and it threw an exception when I tried running it on Noda Time anyway). If I have decisions to make, they’ll be documented here. If I make stupid mistakes, they’ll be documented here. It’s a record of trying to get Sandcastle to work for Noda Time as much as anything it’s meant to be an indication of how smooth or otherwise the process of getting started with Sandcastle is. I apologise in advance if this blog post becomes hard to get good information from.
(Posted to both my main code blog and the Noda Time blog.)
0 kommentar(er)
