Thanks! --- .NET newb On Thu, Apr 30, 2009 at 11:37 AM, Dino Viehland <di...@microsoft.com> wrote:
> There’s the format the compiler generates w/ the /doc: option – I’m not > sure how standardized it is but it’s at least consistent J When you > install the .NET framework SDK you get XML doc files for all of the .NET > framework installed into %WINDIR%\Microsoft.NET\Framework\v2.0.50727\en\... > (or some other language instead of en). > > > > We already support reading and producing __doc__ from these XML files > (using .NET’s xml reading support and just looking for the values we know we > need to pull out) it’s just that we do something different for IronPython’s > own doc strings. > > > > *From:* users-boun...@lists.ironpython.com [mailto: > users-boun...@lists.ironpython.com] *On Behalf Of *Jonathan March > *Sent:* Thursday, April 30, 2009 9:20 AM > *To:* Discussion of IronPython > *Subject:* Re: [IronPython] Docstrings on stuff in clr module > > > > Is there a standardized protocol for XML docstrings? > Then what software would you use to process them? > > On Thu, Apr 30, 2009 at 10:54 AM, Dino Viehland <di...@microsoft.com> > wrote: > > Yes - I've opened a bug (22235 - > http://ironpython.codeplex.com/WorkItem/View.aspx?WorkItemId=22235). > > I want to generally improve the doc strings everywhere. I've slowly > been pushing on this and my ultimate goal is to get all of the doc > strings moved into XML comments and then we can read them from there. > > Then we just need to go through a big push and add XML doc comments > everywhere :) > > If other people have APIs they want doc strings on please add them > to the comments. But I can see clr being particularly problematic > as it otherwise lacks documentation. > > > > _______________________________________________ > Users mailing list > Users@lists.ironpython.com > http://lists.ironpython.com/listinfo.cgi/users-ironpython.com > >
_______________________________________________ Users mailing list Users@lists.ironpython.com http://lists.ironpython.com/listinfo.cgi/users-ironpython.com