• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: commenting code using diagrams
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: commenting code using diagrams


  • Subject: Re: commenting code using diagrams
  • From: Steve Checkoway <email@hidden>
  • Date: Fri, 10 Apr 2009 17:24:41 -0700


On Apr 10, 2009, at 5:09 PM, julius wrote:

On 10 Apr 2009, at 15:35, Paul Walmsley wrote:

Another possibility is to use an ASCII art editor, eg http://www.jave.de/

If you use doxygen you can wrap this in \verbatim ... \endverbatim tags so that it will preserve the format in the HTML output.
Paul
This JavE looks like a labour of love. You can even make movies in it!!! 
A real piece of magic. Wonderful. 
Thanks for telling me.
I'll definitely play with it.

So the upshot seems then to be that many people have found it useful to include diagrams in their inline documentation (surprise surprise) but compiler writers have not thought to provide this one tiny and simple to implement thing? Hmmm.. there must be reasons... I suggested it once to BBEdit but they had no plans to do anything like this. Perhaps XCode could be the first?

Do you mean you want to embed a picture in a plain text file or you want some special markup that the editor recognizes to insert a picture? Surely language standards should not include pictures in the input files!

-- 
Steve Checkoway




 _______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list      (email@hidden)
Help/Unsubscribe/Update your Subscription:

This email sent to email@hidden

References: 
 >commenting code using diagrams (From: julius <email@hidden>)
 >Re: commenting code using diagrams (From: "Sean McBride" <email@hidden>)
 >Re: commenting code using diagrams (From: Paul Walmsley <email@hidden>)
 >Re: commenting code using diagrams (From: julius <email@hidden>)

  • Prev by Date: Re: commenting code using diagrams
  • Next by Date: Re: commenting code using diagrams
  • Previous by thread: Re: commenting code using diagrams
  • Next by thread: Re: commenting code using diagrams
  • Index(es):
    • Date
    • Thread