Configuring and Using Doxygen: Difference between revisions

Line 20: Line 20:
2. Then go to the directory where source files are kept. For example, in our case we go to the <>/src/  directory.
2. Then go to the directory where source files are kept. For example, in our case we go to the <>/src/  directory.


3. Run command doxygen -g which will generate the file "doxyfile"  
3. Run command doxygen -g which will generate the file "Doxyfile"  


4. Now we can configure the doxygen as per our need using this "doxyfile".  
4. Now we can configure the doxygen as per our need using this "Doxyfile".  


For Example,  
For Example,  
Line 30: Line 30:
   If we set CALL_GRAPH = YES it will generate a dependency graph for functions and methods.
   If we set CALL_GRAPH = YES it will generate a dependency graph for functions and methods.
    
    
5. When you are done with the editing the doxyfile, run the command
5. When you are done with the editing the Doxyfile, run the command


           doxygen doxyfile
           doxygen Doxyfile


6. This will create the all documentation and diagrams as per the doxyfile.
6. This will create the all documentation and diagrams as per the Doxyfile.


7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.
7. Now you can browse the code by going to the html directory generated in the source files' directory and opening index.html in browser.
8. This is the [[sample doxyfile]] which we used for our project for your refenrence.


== References ==
== References ==