Ask more detail in "How to use doxygen to generate Docs
by Kon Fun Sandy Lee · in General Discussion · 09/11/2006 (8:02 pm) · 3 replies
I 've studied those documents about "How to use doxygen to generate Documentations", but still cannot understand. Since I' ve just finished studying the courses of VC++ and directX and did not knowing about this kind of Doxygen. Would anyone tell me more detail in step by step like the way of those elementary tutorials.
Thanks!
Thanks!
#2
I am very happy I suceeded to get it. Since I am beginner of programming, the first time looking so much amount of files, I think it can help me improve a lot.
Actually I want to use doxygen to generate the TorqueScript Documentation in Window Help file format (chm). I can't understand what the doc by Daan Broekhof says, would you mind tell me how to generate it?
Thanks !
09/13/2006 (4:49 am)
Thanks Jonathan ! I am very happy I suceeded to get it. Since I am beginner of programming, the first time looking so much amount of files, I think it can help me improve a lot.
Actually I want to use doxygen to generate the TorqueScript Documentation in Window Help file format (chm). I can't understand what the doc by Daan Broekhof says, would you mind tell me how to generate it?
Thanks !
#3
The Steps as following:
After getting the documentation in HTML by Doxygen
Download MS HTML Help Workshop from Microsoft.com
Install the software.
Launch HTML Workshop.hhw.
File \ New \ Specify what to create : Project \ Specify the name of your project e.g. Help \ check : HTML Help table of contents, HTML Help index if need, HTML files \ ignore if doesn't have Table of Content or Help Index file \ finish..
In the window of Help Workshop :
Open Content tab that will create Table of Content file and open Index tab that will create Index file if need
In Project tab :
icon - change project opions \ Files tab \ Content file Table of Content.hhc , check Automatically create content file(hhc) when compiling. Compiler tab \ check Compile full-text search information, if need check others.
In Project tab:
Icon - add/remove files. If too many HTML files to add , separate them to add as cannot add the whole for one time.
Then menu File \ Compile to get documentation in Help format(chm).
09/15/2006 (12:38 am)
I did the TorqueScript Documentation in Window Help file format(chm).The Steps as following:
After getting the documentation in HTML by Doxygen
Download MS HTML Help Workshop from Microsoft.com
Install the software.
Launch HTML Workshop.hhw.
File \ New \ Specify what to create : Project \ Specify the name of your project e.g. Help \ check : HTML Help table of contents, HTML Help index if need, HTML files \ ignore if doesn't have Table of Content or Help Index file \ finish..
In the window of Help Workshop :
Open Content tab that will create Table of Content file and open Index tab that will create Index file if need
In Project tab :
icon - change project opions \ Files tab \ Content file Table of Content.hhc , check Automatically create content file(hhc) when compiling. Compiler tab \ check Compile full-text search information, if need check others.
In Project tab:
Icon - add/remove files. If too many HTML files to add , separate them to add as cannot add the whole for one time.
Then menu File \ Compile to get documentation in Help format(chm).
Torque Owner AcidFaucet
In step 1 choose the wizard to configure,
On the project tab:
Give the project a name and version. Set the source code directory to your source directory (e.g. "C:/tse/engine") and make sure you check the box to scan recursively (basically to look inside folders in that folder). Set the destination to wherever you want the documentation to appear, I recommend that you make a new folder for it, because if you make HTML you'll have thousands of files.
On the mode tab:
Select the radio button for ALL ENTITIES not just documented ones, optionally you can add source cross references. Select the radio button for C++ optimization.
On the output tab:
HTML usually works pretty well, XML is fantastic if you've got access to pagemaker or some other similar tool.
On the diagrams tab:
Just use the built in method.
Press okay.
Now save the configuration (it's really arbitrary as you'll probably never reuse it but they make you do it)
I always set the working directory to match my source directory.
Then start running doxygen.
TSE takes something like 10 minutes to document and ends up at over 120mb for HTML documentation.