---

 
                              CSP301   

---

       Doxygen & Latex                                                    

---

         
 Doxygen is a tool to document your code using the comments that are made in the source/header files. Here we shall  present the bare minimum that we should know to start working with it.

• Step1: Create the Doxyfile, the defaukt configuration file for the doxygen command. Use  'doxygen -g' to generate the Doxygen file in the current directory.
• Step2: Edit the following directives in the Doxyfile to relevent directories and patterns.
  
• PROJECT_NAME : change it to the name of the project
• PROJECT_NUMBER: The current version of the project
• OUTPUT_DIRECTORY: This is the name of the directory where the doxygen documentation shall be generated. It can be an absolute or relative address.
• INPUT: Gives the list of directories whose files need to be scanned for generating the documentation.
• EXCLUDE_PATTERNS: This is the regular expression patttern that will be excluded from the path while considering the files for which we are to generate the document
• Step3:And of course the final step is to generate the document using the Makefile.

                                                 use following target in the makefile at the topmost level:
                                                                         doc: Doxyfile
                                                                         [tab] doxygen Doxyfile



Doxygen Manual







                        

            
                     
                                 

---

Thanks  -- Avinash                                                                                                                                                                                                                                                        

---