Official Torque 3D Documentation Feedback

#1 From Justin Jones:

Quote:
I have the Demo of T3D and tried the Help

Beginners Guide -> Word Editor -> Terrain Editor -> Setup

<I>None of the modifications you are about to make are required for future tutorials, so feel free to create a new level or use an existing one for testing. As long as you have access to existing materials, you are good to go. For this article, we are going to be using a new level.

(If you do not know how to create a new level, click here)</I>

So I clicked the link and a box opened showing this...

Creating a Blank Terrain

To add a new TerrainBlock to your level, in the file menu click on File->Create Blank Terrain.

Just below the above lines is a place holder for an image that is not present. The other image further on also does not display. On checking the link it show this image which is missing:

http://docs.garagegames.com/torque-3d/official/content/documentation/Component%20Tutorials/World%20Editor/images/CreateBlankTerrain.jpg

The image is not showing up. This is with IE7


I checked another section Beginners Guide -> Word Editor -> Adding Terrain -> Setup with a similar link like this...

(If you do not know how to create a new level, click here)

I clicked that link and get an error that the web page is missing.

Firefox 3.5 shows this for the above Adding Terrain link:

The requested URL /torque-3d/official/content/components/World Editor/Creating New Level.html was not found on this server.

IE7 just shows a Web Page Missing error.

I have checked a few other such links on other pages and all of them show a page missing.
What is consistent is that either the page is not found or if found the images that should display do not.

This is for the Docs installed on my computer as well as teh GG Official Site docs.

Can this be fixed please.

#2 Documentation Updated

This will most likely be the last post of a full SVN change log. From here on, a reduced description of changes will be used:

Change log:
Revision: 569
Author: Michael_Perry
Date: 9:44:39 AM, Wednesday, October 14, 2009
Message:
-Fixed broken images
----
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Shape Editor/ShapeEditor.html

Revision: 568
Author: Michael_Perry
Date: 9:44:33 AM, Wednesday, October 14, 2009
Message:
-Fixed broken images
----
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Torque 3D Editors/ShapeEditor.html

Revision: 567
Author: Michael_Perry
Date: 4:39:11 PM, Tuesday, October 13, 2009
Message:
-Updated RTS Prototype to work with 1.0.x versions
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/RTSPrototype.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/rts_prototype.zip
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/rts_prototype_art.zip
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/rts_prototype_scripts.zip

Revision: 566
Author: Michael_Perry
Date: 5:12:12 PM, Monday, October 12, 2009
Message:
-Created blank entry for vectors
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Vectors.html

Revision: 565
Author: Michael_Perry
Date: 4:55:26 PM, Monday, October 12, 2009
Message:
-No longer giving singletons their own simple doc page
----
Deleted : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Singletons.html

Revision: 564
Author: Michael_Perry
Date: 3:44:18 PM, Monday, October 12, 2009
Message:
- Removed commented blocks of code in switch.cs
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/switch.cs

Revision: 563
Author: Michael_Perry
Date: 3:43:33 PM, Monday, October 12, 2009
Message:
- Added section on switch and switch$, plus script

- Updated previous/next links for existing scripts
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Arrays.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Loops.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Output.cs
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/StringManipulation.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Switch.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/arrays.cs
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/loops.cs
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/maths.cs
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/order.txt
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/sampleFunctions.cs
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/stringManip.cs
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/switch.cs

Revision: 562
Author: Michael_Perry
Date: 1:04:05 PM, Wednesday, October 07, 2009
Message:
- Added loops script
----
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/loops.cs

Revision: 561
Author: Michael_Perry
Date: 3:03:41 PM, Thursday, October 01, 2009
Message:
-Added guide on Arrays

-Fixed formatting bug with StringManipulation.html
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Arrays.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/StringManipulation.html
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/arrays.cs

Revision: 560
Author: Michael_Perry
Date: 3:48:37 PM, Wednesday, September 30, 2009
Message:
- Added previous and next buttons for current scripts

- Added String Manipulation guide
----
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Torque 3D Editors/ShapeEditor.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Getting Started/DirectoryOverview.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Getting Started/Setup.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Getting Started/ToolBox.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Material Editor/MaterialEditor.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Shape Editor/ShapeEditor.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Interface.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Introduction.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Precipitation.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/ShapesAndGeometry.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Skybox.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Sun.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/TerrainBlock.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/WaterBlock.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/WaterPlane.html
Modified : /SourceDocumentation/Torque 3D/documentation/Introduction/Introduction.html
Modified : /SourceDocumentation/Torque 3D/documentation/Introduction/UsingDocumentation.html
Deleted : /SourceDocumentation/Torque 3D/documentation/Introduction/images/caret-l.gif
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/CameraModes.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/RTSPrototype.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Overview/Introduction.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Overview/Syntax.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Echos.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Math.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/StringManipulation.html
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/stringManip.cs

Revision: 559
Author: Michael_Perry
Date: 3:02:20 PM, Tuesday, September 29, 2009
Message:
-Added footer nav images
----
Added : /SourceDocumentation/Torque 3D/documentation/Introduction/images/caret-l.gif
Added : /SourceDocumentation/Torque 3D/documentation/Introduction/images/next_h.png
Added : /SourceDocumentation/Torque 3D/documentation/Introduction/images/next_n.png
Added : /SourceDocumentation/Torque 3D/documentation/Introduction/images/previous_h.png
Added : /SourceDocumentation/Torque 3D/documentation/Introduction/images/previous_n.png

Revision: 558
Author: Michael_Perry
Date: 1:40:47 PM, Tuesday, September 29, 2009
Message:
-Added TorqueScript math guide
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Math.html
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/maths.cs

Revision: 557
Author: Michael_Perry
Date: 11:45:35 AM, Tuesday, September 29, 2009
Message:
-Renamed Component Tutorials to "components"

-Updated T3D documentation config files to exclude "components" folders from the TOC.
----
Modified : /SourceDocumentation/Themes/Config/T3D-FullDocsScheme.php
Modified : /SourceDocumentation/Themes/Config/T3D-WebScheme.php
Deleted : /SourceDocumentation/Torque 3D/documentation/Component Tutorials
Added : /SourceDocumentation/Torque 3D/documentation/components (Copy from path: /SourceDocumentation/Torque 3D/documentation/Component Tutorials, Revision, 550)
Modified : /docGenerator/phpScripts/config/configScheme.php

Revision: 556
Author: Michael_Perry
Date: 2:25:24 PM, Monday, September 28, 2009
Message:
- Updated spacing of Top bar to be smaller
----
Modified : /SourceDocumentation/Torque 3D/Include/Documentation Overview.html
Modified : /SourceDocumentation/Torque 3D/WebInclude/Documentation Overview.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html
Modified : /SourceDocumentation/Torque 3D/documentation/order.txt

Revision: 555
Author: Michael_Perry
Date: 4:44:22 PM, Friday, September 25, 2009
Message:
-Updated TorqueScript Introduction
-Added Functions guide
-Added Functions sample script
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Overview/Introduction.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/sampleFunctions.cs

Revision: 554
Author: Michael_Perry
Date: 1:55:43 PM, Friday, September 25, 2009
Message:
-Added ReferenceGuide.html for TorqueScript
----
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Overview/ReferenceGuide.html

Revision: 553
Author: Michael_Perry
Date: 12:20:13 PM, Friday, September 25, 2009
Message:
-Fixed formatting issues
-Removed links to unfinished docs
----
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Max Guides/MaxPhysXGuide1.html
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Max Guides/MaxPhysXGuide2.html
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Overview/ColladaOverview.html
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Torque 3D Editors/MaterialEditor.html
Modified : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Torque 3D Editors/ShapeEditor.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Shape Editor/ShapeEditor.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/GroundPlane.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Precipitation.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/World Editor/Skybox.html
Modified : /SourceDocumentation/Torque 3D/documentation/Engine/SFX/order.txt
Modified : /SourceDocumentation/Torque 3D/documentation/Introduction/UsingDocumentation.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/TSShapeConstructorSpecification.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Overview/Introduction.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html

Revision: 552
Author: Michael_Perry
Date: 3:08:56 PM, Thursday, September 24, 2009
Message:
-Added software setup section
-Changed Torque 3D doc appearance to use new art and theme
----
Modified : /SourceDocumentation/Include/tocStyle.css
Modified : /SourceDocumentation/Include/tocStyles.css
Modified : /SourceDocumentation/Include/topStyles.css
Modified : /SourceDocumentation/Torque 3D/Include/top.html
Modified : /SourceDocumentation/Torque 3D/WebInclude/top.html
Added : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Getting Started/Setup.html
Modified : /SourceDocumentation/Torque 3D/documentation/Beginners Guide/Getting Started/order.txt
Modified : /SourceDocumentation/Torque 3D/images/banner.jpg
Added : /SourceDocumentation/Torque 3D/images/community_h.png
Added : /SourceDocumentation/Torque 3D/images/community_n.png
Added : /SourceDocumentation/Torque 3D/images/search_Button.png
Modified : /SourceDocumentation/Torque 3D/images/t3ddocumentation.png

Revision: 551
Author: Michael_Perry
Date: 12:30:50 PM, Thursday, September 24, 2009
Message:
-Moved TSShapeConstructorSpecification.html from Artist Guide to Advanced Scripting
----
Deleted : /SourceDocumentation/Torque 3D/documentation/Artist Guide/Overview/TSShapeConstructorSpecification.html
Added : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/TSShapeConstructorSpecification.html
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Advanced/order.txt

Revision: 550
Author: Michael_Perry
Date: 12:28:08 PM, Thursday, September 24, 2009
Message:
Renamed Artist Section to Artist Guide
----
Added : /SourceDocumentation/Torque 3D/documentation/Artist Guide (Copy from path: /SourceDocumentation/Torque 3D/documentation/Artist Section, Revision, 542)
Modified : /SourceDocumentation/Torque 3D/documentation/Engine/SFX/SFXOverview.html

Revision: 549
Author: Michael_Perry
Date: 12:17:29 PM, Thursday, September 24, 2009
Message:
-Renamed "Beginner Guide" to "Beginners Guide"
----
Deleted : /SourceDocumentation/Torque 3D/documentation/Beginner Guide
Added : /SourceDocumentation/Torque 3D/documentation/Beginners Guide (Copy from path: /SourceDocumentation/Torque 3D/documentation/Beginner Guide, Revision, 542)
Modified : /SourceDocumentation/Torque 3D/documentation/Scripting/Simple/Functions.html
Modified : /SourceDocumentation/Torque 3D/documentation/order.txt

Revision: 548
Author: Michael_Perry
Date: 11:42:43 AM, Thursday, September 24, 2009
Message:
-Committed SFX docs
----
Modified : /SourceDocumentation/Torque 3D/documentation/Engine/SFX/Conclusion.html
Modified : /SourceDocumentation/Torque 3D/documentation/Engine/SFX/SFXInterface.html
Modified : /SourceDocumentation/Torque 3D/documentation/Engine/SFX/SFXInternals.html

#3 Hey Mitch.

So my big gripe about docs is i'd like to see the C++ reference back in. It just takes running Doxygen over the code to get to all the API reference documentation work that i and others have done within the Torque code base.

It can be done in 10 minutes.... an hour or two to configure the output to give you the style you want.

Reference docs are critical to the C++ development side of the engine as well as give new users a friendlier way to search for functionality and understand how things work. It gives you not only coder written reference, but things like class relationships and heirarchy in graphical charts.

I know that some classes are partially or fully undocumented... but many are documented well. Hiding the fact we have holes in the reference docs is just hurting the documentation process.... we cannot fix them if we ignore them.

I think its better to start exporting and including this to complement the walkthru/tutorial style docs we have at the moment.
Second to that... TorqueScript also has reference documentation on the API. This is even more critical as we release a non-source version of the engine and people want to know how to script. Its as easy as two console commands to dump a text file that Doxygen can process just like it does the C++ docs.

These should be top priorities. It baffles me that we've shipped and we haven't included the easy and automated docs we already have in hand.

#4 Feeling extra critical today... so don't take anything personal on this. :)

I'd like to see the Table of Contents in the docs not include tree view expansion of the sections/headers within an HTML page.

As it is now i can click on a 'Playback Virtualization' and not know if its really different content or the info i just read in the 'Overview' document.

In general when i click i expect that each entry in the TOC tree is a new HTML page and not a paragraph within a document i just read.

To me... we've over done the TOC details... it tends to confuse me more than help me. I'd rather see the 'Search' work properly giving me content results and not just TOC results.

#5 Thanks for the feedback Tom. I have concerns about continuity with shipping the Doxygen reference. It will be difficult to sync the online reference with the offline version, which is why I'm going to try something different.

We are going to start shipping a batch file, or a shortcut to a routine, that will automatically generate the reference documentation from the source code available to the local machine. The user will generate the Doxygen docs which will match up 1 to 1 with what they are working with. This will keep the base documentation clean, and consolidate all the hardcore C++ reference for programmers in a single sections.

I completely agree about the TorqueScript ConsoleFunction and ConsoleMethod documentation. There are over 400 functions exposed to TorqueScript, and the auto-dump helps alleviate the manual documenting process. There are only two small issues to get past:

- Converting the dumps to a more human-friendly format
- Filling out all the missing usage strings (there are A LOT missing)

Still working on that, but they are currently not the highest priority. As far as the TOC goes, the official documentation will probably undergo one last visual overhaul. This will include removal of frames and a cleaner TOC.

#6

Quote:It will be difficult to sync the online reference with the offline version

Not sure i entirely know what you mean... 1.0 docs match the 1.0 code base. If the online docs are for 1.1 and your using 1.0... well stick to your offline docs or update.

Quote:We are going to start shipping a batch file, or a shortcut to a routine

Absolutely... thats a good thing to have anyway. I'm just thinking this same batch can build reference docs for both online and offline uses.

Quote:Converting the dumps to a more human-friendly format

Thats easy... they dump in a Doxygen friendly format. You can run them thru Doxygen and get HTML formatted how ever you like.

We really need to not reinvent the wheel here... Doxygen works well.

Quote:Filling out all the missing usage strings (there are A LOT missing)

And hiding the unfilled strings doesn't help get them fixed. Its gonna take active participation of everyone on the team to get them filled out properly and it shouldn't just be up to you.

Still even if they are empty... its better to know the function exists even if its not defined.

We should add these immediately and not wait for them to all be filled out.

#7 Scratch that last post. I forgot there is not a similar solution for our Mac users. I'm just going to generate the reference docs on my machine and provide a download links to zip files sorted by version #. So there will be:

- 1.0 reference docs
- 1.0.1 reference docs
- 1.1 reference docs

I'll post links in the documentation to download these, but they will not be included in the installer.

#8

Quote:I forgot there is not a similar solution for our Mac users.

What solution? Building Doxygen docs?

Quote:provide a download links to zip files sorted by version #

Why not put them online under the normal docs? Like...

http://docs.garagegames.com/torque-3d/reference/1.0/
http://docs.garagegames.com/torque-3d/reference/1.0.1/
http://docs.garagegames.com/torque-3d/reference/1.1/

... etc.

This will at least make them searchable via Google while offline they are not if its just plain HTML.

#9

Quote:What solution? Building Doxygen docs?

Yes. I do not currently have any routine in my toolset for generating Doxygen references on a Mac. I'll have to write the Mac equivalent of the Windows batch file and make sure it gets into 1.1.

Quote:Why not put them online under the normal docs? Like...

If I add the reference docs (over 4,000 individual html pages) to the base documentation, the doc generator process goes from 5 minutes to over an hour. The zipped docs will go from 100MB to about 300. The internal search will get extremely bloated and cause a lot of bad hits.

Quote:And hiding the unfilled strings doesn't help get them fixed. Its gonna take active participation of everyone on the team to get them filled out properly and it shouldn't just be up to you.

I could really use that help, believe me. Show me how to make a team of programmers stop writing code and write documentation and I'll show you a documentation day that never happened. I have already voiced these concerns to the team.

Even if the empty functions are present, they will still be criticized as not being documented. It's a struggle just trying to keep what is available clear and up to date.

#10

Quote:I'll show you a documentation day that never happened

Yea... documentation day was my idea... but it wasn't followed up on. I still think its a good idea that needs to be done.

I just don't call the shots as to where GG and other contractors spend their time... just my guys. So while i try to make sure our code always includes reference docs... its still not the same as an organized push and enforcement by GG.

They should give you a stick to wield and let you go to town on us when we fail to document new code.

Quote:Even if the empty functions are present, they will still be criticized as not being documented

We'll be critizied no matter what... i just want what we have out there and not hidden away.

#11

Quote:They should give you a stick to wield and let you go to town on us when we fail to document new code.

Amen. On that note, you and Pat are about to get an e-mail from me about some GFX changes I'm documenting.

I think now that 1.0 is out the door, we can push the idea of a documentation day again. I'll write up a proposal, and hope you will back me up =)

#12 Mike

You locked my thread so I am posting here.

Q: Are above fixes made only to the "Official Online Documentation" or has the Demo too been updated?

I am not asking you to update the demo, but just asking whether these changes have been included in it, or will I need to access them online?

Also can you provide a link to this updated Online Documentation in your post above, (if it is not already there) as the page at http://docs.garagegames.com/ has not been updated with the link to the T3D Documentation.

Thanks.

#13 @Justin - I have not tackled your feedback yet, so they are not in the official docs right now. You are correct in looking at the online docs for updates. The offline docs that ship with the demo and the SDK are not going to be updated as much as the online docs.

One correction, though. Do not use http://docs.garagegames.com. Use The Official Documentation Landing Page.

#14 @Mike

Cool. Did not even know such a page existed. Thanks. Will check it out.

#15 Hello Michael.

Thank you for improving RTS Prototype and made it Torque3D ready.

And as always users want to have more documentation, i think it is perpetual :-) cycle.

So, it could be great to extend RTS prototype section with example how create more then just one unit and manage them(choose side or team when join to server and choose team's unit or a group of units during the game and manage them the same way as you already discribed).

It can be a good startpoint multiplayer strategy demo.

Is my BoomBot squad stronger them two brother's SpaceSuit squads :-)?

Funny, there is lot of information about AI on the site and in books, but i did not find information about how to make things i mentioned above...

#16 OK, I have a question for everyone. We are reworking how the engine reference docs are displayed. The current way, as shown by the messy TGEA reference, is badly formatted, hard to search, and just looks awful.

We are going to generate the API reference for Torque 3D, but we are debating about switching to CHM and PDF. We will still most likely use Doxygen to grab the reference, but the presentation is due for a revamp. Anyone have a preferred format or an example of what they like? We are looking heavily at the way PhysX formats its engine reference. Which is a very clean CHM file.

Cramming all the engine reference into the html docs is tedious and actually slows down the documentation process. By switching to something like CHM, we can maintain the engine reference docs as a separately generated file and not have to update it as often as our core guides.

#17 I personally vote for CHM! It is more convenient to use then some html pages and PDF.I am using PhysX documentation it is good formatted.

#18 I would like to cast my vote for CHM also.

#19 As long as it can work natively on Mac, choose what is best suited.

Nicolas Buquet
www.buquet-net.com/cv/

#20 The CHM viewer I know of for Mac is a bit clunky. I don't see any reason why you can't produce several different formats if Doxygen lets you.