Doxygen - A Simple Quick Guide
				==============================
			
					

										Lakshmipathi.G
										June 16,2008,4.44PM.
										Lakshmipathi.G@gmail.com

		


Hi 
	It's Doxygen.
	Simple documentaion tool saves you from plenty of sleepless nights digging about source code.
	It's gives clear graphical view of of the source code and allows you to browse the source code.
	It's supports C,C++,Java, Objective-C, Python,  Fortran,PHP,C#, and to some extent D.I learned 
	We have counter parts like Javadoc as i but know nothing about that ...no comments or comparisons.
	
	
	You don't need to use pen and paper to note down the control flow. Sounds Great isn't it?
	I tried to learn about Doxygen few months back...I tried one or two times and gave up.
	But today it's surprising easy & simple learn ..In fact very simple,just 5 step procedure.

	For my dear Linux User,The Linux version of this doc will be written soon :-)

	
Step 0:
	you sure want to read this ? – Nothing useful to do?  Then go to step 1 else go to step 074.0264021
	


Step 1: 
	Creat directory called Doxygen in D: and Creat directory called dot in D:/Doxygen


Step 2 : 
	Download Doxygen from here:
	http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
	(download  windows the binaries in a zip  about 2MB size - you get two exe called doxygen.exe and doxytag.exe)
	copy these two exe to D:/Doxygen


	From here http://www.graphviz.org/ Download dot for graphs 
	and install it under D:\Doxygen\dot


Step 3:

	Now comes the real part ...Open Terminal (Command prompt)

	cd D:/Doxygen

	Run following command to creat a deafult config file called Doxyfile.

	D:\Doxygen>doxygen.exe -g

	type ls ooops!!! type 'dir' :-)
	
	You can see a config file named Doxyfile.


Step 4:

	Open the file.


	give values for these tags ....

	PROJECT_NAME,PROJECT_NUMBER,OUTPUT_DIRECTORY,INPUT,CALLER_GRAPH,CALL_GRAPH,
	OPTIMIZE_OUTPUT_FOR_C,EXTRACT_ALL,HAVE_DOT,DOT_PATH

	After assigning value to this tag the file will look like this,

	PROJECT_NAME           = giis
	PROJECT_NUMBER         = 1.0
	OUTPUT_DIRECTORY       = D:\Doxygen\giis_doc
	INPUT                  = D:\giis-all\giis
	CALLER_GRAPH           = YES
	CALL_GRAPH             = YES
	OPTIMIZE_OUTPUT_FOR_C  = YES
	EXTRACT_ALL            = YES
	HAVE_DOT 		= YES
	DOT_PATH               = D:\Doxygen\dot\bin


	save & close the file.

	Note If you are using JAVA search for java tags and set it ,if you need that option.
	You can configure other parameter if you need them.If you don't want to open config file and 
	update it download GUI interface from the above mentioned link.

	D:\giis-all\giis has source code directory ...Appropriate doc will created under directory 
	D:\Doxygen\giis_doc


Step 5:

	I'm going to run this :

	D:\Doxygen>doxygen.exe Doxyfile


Check  index file under D:\Doxygen\giis_doc\html .. Simple Amazing ..Makes our life easier. :-)
I tested this with C codes looks great ;-) 

Step 074.0264021 :
	Want To Skip this docs? you are allowed to skip this doc if and only if you can answer the following question…
	Question: When was the last time to you did completely Useless stuff ?????

	if you don’t know the answer
	goto step 1.;-) to get the answer ;-) ;-) ;-)

More Links :
http://www.stack.nl/~dimitri/doxygen/manual.html
http://www.star.bnl.gov/public/comp/sofi/doxygen/starting.html