Skip to content

Instantly share code, notes, and snippets.

@sriharsha1235

sriharsha1235/README

Created October 13, 2017 11:10
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save sriharsha1235/63a6c7d1dc5e90bc806275db871ea980 to your computer and use it in GitHub Desktop.
Save sriharsha1235/63a6c7d1dc5e90bc806275db871ea980 to your computer and use it in GitHub Desktop.
Download ZIP
Doxygen
Raw
README
Doxygen Installation
Step1:
Install doxygen in ubuntu (https://www.tutorialspoint.com/articles/how-to-install-doxygen-on-ubuntu)
Step2:
Generate the sample conf file doxygen -g sample_text.conf
Step3:
Edit the sample_text.conf
Search for “Configuration options related to the input files”
Below this section you will see INPUT which is empty by default, here you need to give the directory(/var/www/html/ipassio_sprint2/modules) that the doxygen should read.
INPUT = /var/www/html/ipassio_sprint2/modules
I have given modules because it will look for classes and comments.
Make RECURSIVE = YES
Step4:
Search for “Project related configuration options”. In this section you can give your project name, logo and description. Give OUTPUT_DIRECTORY path where the generated html should be created.
OUTPUT_DIRECTORY = /var/www/html/test_doxy
CREATE_SUBDIRS = YES will create sub directories instead of using single level directory.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment