Welcome to the MacNN Forums.

If this is your first visit, be sure to check out the FAQ by clicking the link above. You may have to register before you can post: click the register link above to proceed. To start viewing messages, select the forum that you want to visit from the selection below.

You are here: MacNN Forums > Software - Troubleshooting and Discussion > Developer Center > Generating documentation from source

Generating documentation from source
Thread Tools
Dedicated MacNNer
Join Date: Nov 2000
Status: Offline
Reply With Quote
Jul 1, 2001, 09:38 AM
 
What tools are y'all using to generate docs? Before I developed a case of the glow butt about Apple STILL not releasing a Rage PRO driver, and wiping OSX and all of my projects in retaliation (stupid I know), I was using a version of HeaderDoc that I had coerced into semi-working with Obj-C. Rather than sink back into the evilness of PERL (what an awful language), I thought I'd see what y'all recommended. If nothing good exists, I might try and come up with a parser in ruby. If anyone else might be interested in such a tool, let me know.

Thanks,
Terry
     
Dedicated MacNNer
Join Date: Jan 2001
Location: Virginia, US
Status: Offline
Reply With Quote
Jul 1, 2001, 10:39 AM
 
For Objective-C, I'm going to have to plug my own tool here -- AutoDoc. It's available from www.misckit.com.

It has a bit different type of markup then HeaderDoc/javadoc (I've been putting it out for well over two years, and it's an ObjC rewrite of someone else's perl version that existed for several years before that, so it invented its own markup). It can produce HTML, RTF, and PDFLaTeX documentation.
     
int69h  (op)
Dedicated MacNNer
Join Date: Nov 2000
Status: Offline
Reply With Quote
Jul 3, 2001, 06:50 PM
 
Your tool was just what I was looking for. I've set myself a shell script build phase to automatically generate linked html in the correct location of my framework. As soon as I can get PB to do automated OCUnit testing for me, my build environment will be complete.

Is there some sort of tag to designate preformatted text? All of my example code is getting messed up.

Terry
     
Dedicated MacNNer
Join Date: Jan 2001
Location: Virginia, US
Status: Offline
Reply With Quote
Jul 4, 2001, 12:53 PM
 
Use the fixed-width markup !{ ... } for example code. It's not technically preformatted as it decides on the indentation for itself, but it should work fine.
     
   
Thread Tools
Forum Links
Forum Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts
BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are On
Top
Privacy Policy
All times are GMT -5. The time now is 12:43 PM.
All contents of these forums © 1995-2011 MacNN. All rights reserved.
Branding + Design: www.gesamtbild.com
vBulletin v.3.8.7 © 2000-2011, Jelsoft Enterprises Ltd., Content Relevant URLs by vBSEO 3.3.2