• 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: HeaderDoc questions
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: HeaderDoc questions


  • Subject: Re: HeaderDoc questions
  • From: Matt Morse <email@hidden>
  • Date: Wed, 7 Jul 2004 10:19:54 -0700

On Jul 7, 2004, at 8:14 AM, Bill Cheeseman wrote:

I've been revising the HeaderDoc comments in my project, and I have some
questions:


1. The build setting GENERATE_HEADERDOC does not seem to work in Xcode, as
it did in Project Builder. The workaround appears to be a shell script build
phase. Is this correct?

Using a shell script build phase to run headerdoc2html definitely works. Please file a bug about the GENERATE_HEADERDOC build setting, if it isn't working for you.



2. In a header file with two classes, the HeaderDoc comments for the first
class are ignored and no documentation is generated for that class. It used
to work in an earlier version. I can find no syntax errors. The only change
since the last working version is that the class now has many more methods
and therefore many more HeaderDoc comments. Is there a known size limit on
HeaderDoc class documentation? If not, what else should I look for?


Mac OS X 10.3.4, Xcode 1.2, and HeaderDoc 7.2


I just downloaded the HeaderDoc 7.4.8 source from http://developer.apple.com/darwin/projects/headerdoc/ and ran headerDoc2HTML on the ExampleHeaders folder (which includes a test case for multiple classes in one header). It seemed to work fine, so you might try upgrading to 7.4.8. If that version doesn't work on your header, I'd suspect either a syntax error in the comments, or a bug in headerDoc2HTML. If the latter, you know what to do ;-).


There should be no practical limit to the length of comments processed by HeaderDoc.

Hope this helps,
-- Matt



--

Bill Cheeseman - email@hidden
Quechee Software, Quechee, Vermont, USA
http://www.quecheesoftware.com

The AppleScript Sourcebook - http://www.AppleScriptSourcebook.com
Vermont Recipes - http://www.stepwise.com/Articles/VermontRecipes
_______________________________________________
xcode-users mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/xcode-users
Do not post admin requests to the list. They will be ignored.
_______________________________________________
xcode-users mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/xcode-users
Do not post admin requests to the list. They will be ignored.


  • Follow-Ups:
    • Re: HeaderDoc questions
      • From: Bill Cheeseman <email@hidden>
    • Re: HeaderDoc questions
      • From: Bill Cheeseman <email@hidden>
    • Re: HeaderDoc questions
      • From: Prachi Gauriar <email@hidden>
References: 
 >HeaderDoc questions (From: Bill Cheeseman <email@hidden>)

  • Prev by Date: Re: Disabling a Processor
  • Next by Date: Re: Switch to Symbolic Counterpart keyboard equivalent
  • Previous by thread: HeaderDoc questions
  • Next by thread: Re: HeaderDoc questions
  • Index(es):
    • Date
    • Thread