August 30, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Michael | OT
> ... Walter working on getting his IDE
> working with D ... IDE that has debugging and
> intellisense...
Is that for real, or thats just your wish?
Is there an IDE on the way?
|
August 30, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Jonathan Oser Jr. | Its already been suggested to the NaturalDocs developers. See here: http://www.naturaldocs.org/languages.html Under the heading: Getting Full Language Support D is sixth down the list. It isn't too completely different from Walter's proposal -- and might be a worthy influence on it. In any case its worthy sending in votes to get D fully supported. -- Chris Sauls Jonathan Oser Jr. wrote: > I'm not sure if this was mentioned earlier, I haven't read about it in the thread yet and I figure that it is worth mentioning. > There is an inline documentation system that (I feel) is worth taking a look at. It seems to generate good documentation with a minimum of extra symbols and such. > It's called Natural Docs and you can read more at www.naturaldocs.org <http://www.naturaldocs.org> > Have fun, > Jon > > "Walter" <newshound@digitalmars.com > <mailto:newshound@digitalmars.com>> wrote in message > news:depaee$fre$1@digitaldaemon.com... > I've put up a strawman proposal for embedding documentation in > comments at > www.digitalmars.com/d/doc.html <http://www.digitalmars.com/d/doc.html> > |
August 30, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Walter | Walter wrote: > I've put up a strawman proposal for embedding documentation in comments at > www.digitalmars.com/d/doc.html > > It just occurred to me, with this proposal, what tool would be used to generate the doc? Is there an existing one, or it would have to be created? -- Bruno Medeiros Computer Science/Engineering student |
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Bruno Medeiros | On Tue, 30 Aug 2005 22:53:31 +0000, Bruno Medeiros <daiphoenixNO@SPAMlycos.com> wrote: > Walter wrote: >> I've put up a strawman proposal for embedding documentation in comments at >> www.digitalmars.com/d/doc.html >> > It just occurred to me, with this proposal, what tool would be used to generate the doc? Is there an existing one, or it would have to be created? http://www.digitalmars.com/drn-bin/wwwnews?digitalmars.D/28157 Regan |
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Freejack | "Freejack" <freejack@nowhere.net> wrote in message news:pan.2005.08.28.17.31.04.603691@nowhere.net... > On Sat, 27 Aug 2005 01:47:18 -0700, Walter wrote: > > > I've put up a strawman proposal for embedding documentation in comments at > > www.digitalmars.com/d/doc.html > > Have you considered going the whole route and adding formalized annotations for Splint and ASIS like tools? Look at the Spark system from Praxis High Integrity Systems (www.praxis-his.com/sparkada/)to see what I mean. The link doesn't work? |
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Walter | On Tue, 30 Aug 2005 21:36:59 -0700, Walter wrote: > "Freejack" <freejack@nowhere.net> wrote in message news:pan.2005.08.28.17.31.04.603691@nowhere.net... >> On Sat, 27 Aug 2005 01:47:18 -0700, Walter wrote: >> >>> I've put up a strawman proposal for embedding documentation in comments > at >>> www.digitalmars.com/d/doc.html >> >> Have you considered going the whole route and adding formalized annotations for Splint and ASIS like tools? Look at the Spark system from Praxis High Integrity Systems (www.praxis-his.com/sparkada/)to see what I mean. > > The link doesn't work? Try http://www.praxis-his.com/sparkada/ instead ;-) -- Derek (skype: derek.j.parnell) Melbourne, Australia 31/08/2005 3:11:12 PM |
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Walter | On Tue, 30 Aug 2005 21:36:59 -0700, Walter wrote: > > "Freejack" <freejack@nowhere.net> wrote in message news:pan.2005.08.28.17.31.04.603691@nowhere.net... >> On Sat, 27 Aug 2005 01:47:18 -0700, Walter wrote: >> >> > I've put up a strawman proposal for embedding documentation in comments > at >> > www.digitalmars.com/d/doc.html >> >> Have you considered going the whole route and adding formalized annotations for Splint and ASIS like tools? Look at the Spark system from Praxis High Integrity Systems (www.praxis-his.com/sparkada/)to see what I mean. > > The link doesn't work? Strange. It works from here. Hrrrmmm... Perhaps something a bit more in-depth... Try http://www.acm.org/sigada/WG/asiswg/asiswg.html Granted, this is an Ada extension, however the concept seems right up the alley of the embedded documentation system you're proposing. Also try http://www.praxis-his.com Freejack |
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Freejack | On Wed, 31 Aug 2005 00:36:53 -0400, Freejack wrote: > On Tue, 30 Aug 2005 21:36:59 -0700, Walter wrote: > >> >> "Freejack" <freejack@nowhere.net> wrote in message news:pan.2005.08.28.17.31.04.603691@nowhere.net... >>> On Sat, 27 Aug 2005 01:47:18 -0700, Walter wrote: >>> >>> > I've put up a strawman proposal for embedding documentation in comments >> at >>> > www.digitalmars.com/d/doc.html >>> >>> Have you considered going the whole route and adding formalized annotations for Splint and ASIS like tools? Look at the Spark system from Praxis High Integrity Systems (www.praxis-his.com/sparkada/)to see what I mean. >> >> The link doesn't work? > > Strange. It works from here. Hrrrmmm... It doesn't work because the URL in your text, as interpreted by most newsreaders, is 'www.praxis-his.com/sparkada/)to' rather than 'www.praxis-his.com/sparkada/' -- Derek (skype: derek.j.parnell) Melbourne, Australia 31/08/2005 6:54:47 PM |
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Walter | What I am missing is a way to add the unit test to the documentation as examples.
Most auto-generated documents doesn't have enough examples.
On Sat, 27 Aug 2005 01:47:18 -0700, Walter wrote:
> I've put up a strawman proposal for embedding documentation in comments at www.digitalmars.com/d/doc.html
|
August 31, 2005 Re: Embedded Documentation in Comments | ||||
---|---|---|---|---|
| ||||
Posted in reply to Freejack | "Freejack" <freejack@nowhere.net> wrote in message news:pan.2005.08.28.17.31.04.603691@nowhere.net... > On Sat, 27 Aug 2005 01:47:18 -0700, Walter wrote: > > > I've put up a strawman proposal for embedding documentation in comments at > > www.digitalmars.com/d/doc.html > > Have you considered going the whole route and adding formalized annotations for Splint and ASIS like tools? Look at the Spark system from Praxis High Integrity Systems (www.praxis-his.com/sparkada/)to see what I mean. It seems way beyond what we're doing here <g>. |
Copyright © 1999-2021 by the D Language Foundation