EDUCBA

EDUCBA

MENUMENU
  • Free Tutorials
  • Free Courses
  • Certification Courses
  • 600+ Courses All in One Bundle
  • Login
Home Software Development Software Development Tutorials Software Development Basics Doxygen
Secondary Sidebar
Software Development Basics
  • Basics
    • Microsoft Expression Web
    • IDE
    • Microsoft Flow
    • Unity Dashboard
    • Servlet Dispatcher
    • Types of Algorithms
    • Vue.js? nextTick
    • Vue.js Transition
    • Page Replacement Algorithms
    • What is CLI
    • Open Source Software
    • Solve Problems With Technology (Simple)
    • What is Application Software & Types
    • Microsoft Word Alternative
    • ADDIE Model
    • V-model advantages and disadvantages
    • Gatsby Plugins
    • Putty version
    • Xampp versions
    • Avro converter
    • Avro Data Types
    • Avro Schema Evolution
    • Avro Serialization
    • Cloudera Impala
    • Cloudera Careers
    • Entity Framework Core
    • Gulp File Include
    • Gulp Autoprefixer
    • Gulp File
    • Gulp Terser
    • System Software Tools
    • System Software Components
    • Typography App
    • Software as a Service (Saas)
    • Icon Font Pack
    • Interpret Results Using ANOVA Test
    • Blogging Insights Your Analytics
    • Increase Productivity Technology
    • Free Multimedia Software
    • Information Technology Benefits
    • What is SPSS and How Does It Work
    • Learn to Code For Beginners (Advance)
    • Uses of Coding
    • Uses Of Raspberry Pi
    • What Is System Design
    • Introduction to NLP
    • What is MapReduce
    • What is SoapUI
    • What is MVC
    • What is Multithreading
    • What is Neural Networks
    • What is Swift
    • What is PLC
    • What is Open Cart
    • What is Mainframe
    • What is JMS
    • What is Cognos
    • What is Open Source
    • What is Bot
    • What is SOAP
    • What is COBOL
    • What is GraphQL
    • What is Microcontroller
    • What is Open-Source License
    • What is Visual Studio Code
    • What is Pandas
    • What is Hypervisor
    • What is Common Gateway Interface
    • What is IDE?
    • What is MVC Design Pattern
    • What is Application Server
    • What is GPS
    • What is Botnet
    • What is Assembly Language
    • System Analysis And Design
    • HTTP Caching
    • What is Buffer Overflow
    • What is Ajax
    • What is Appium
    • What is SVN
    • What is SPSS
    • What is WCF
    • What is Groovy
    • What is Clickbait
    • What is SOA
    • What is GUI
    • What is FreeBSD
    • What is WebSocket
    • What is WordPress
    • What is OSPF
    • What is Coding
    • What is Raspberry Pi
    • HTTP Cookies
    • What is Hub?
    • What is Bridge
    • What is Switch
    • What is Internet Application
    • What is Sensors
    • What is Proximity Sensors
    • What is Full Stack
    • System Design Interview Questions
    • What is Salesforce technology
    • What is Salesforce Sales Cloud
    • What is OOP
    • What is CMD
    • What is React
    • React Redux Typescript
    • What is DSS
    • What is SVG
    • SVG File
    • Bash Sleep Command
    • What is MTU
    • What is Apex
    • What is Desktop Software
    • Tor Browser, Anonymity and Other Browsers
    • Avoid Pitfalls of Shadow IT
    • Freelance Web Graphic Designer
    • What is Storage Virtualization
    • What is Web Services?
    • What is Social Networking?
    • What is Microservices Architecture?
    • Microservices Tools
    • Advantages of Microservices
    • Uses of Internet
    • Software Platforms
    • Uses of Internet for Business
    • Architecture of Web Services
    • Web Application Testing
    • Advantages of Web Service
    • CPU Virtualization
    • Types of Web Services
    • Web Services Testing
    • What is RabbitMQ?
    • RabbitMQ Architecture
    • Advantages of Bitcoin
    • LINQ foreach
    • Penetration Testing Services
    • Puppet Alternatives
    • What is Memcached?
    • What is Browser?
    • Types of Satellites
    • Model Driven Architecture
    • Types of Variables in Statistics
    • Best Statistics Certifications
    • Integration Architecture
    • What is API Integration?
    • What is Grid Computing?
    • Asus File Manager
    • What is GPRS?
    • What is Gradle?
    • What is Basecamp?
    • Software System Architecture
    • GSM Architecture
    • What is Nagios?
    • AppDynamics Tool
    • Logical Architecture
    • What is Microsoft Planner
    • What is Circuit Switching
    • What is ARM?
    • Embedded Control Systems
    • Embedded System Programming
    • Embedded System Development
    • Embedded Systems Software
    • Embedded System Project
    • Types of Embedded Systems
    • Requirement Engineering
    • Types of Engineering
    • What is WAP
    • What is Registry?
    • What is Dynatrace?
    • What is Digital Forensics?
    • Hardware Virtualization
    • AppDynamics Careers
    • Bandwidth Monitoring Tools
    • Ping Monitor Tools
    • Dynatrace Tools
    • What is Trello?
    • What is AppDynamics?
    • What is Remote Desktop?
    • What is Extranet?
    • What is LTE Network?
    • What is Firebase?
    • Website Monitoring Tool
    • Number Systems
    • Service Desk Manager
    • Static Website
    • Dynamic Website
    • What is Email?
    • What is URL Link?
    • What is Program?
    • What is Lock Screen?
    • What is Grafana
    • Unguided Media Transmission
    • IT Governance
    • IT Governance Framework
    • Remote Support Softwares
    • What is Unification?
    • Topological Map
    • What is LAMP?
    • USB Flash Drive
    • Software Development Models
    • Digital Circuit
    • What is Webpack?
    • Fault Tolerance
    • What is DSL Modem?
    • What is Mozilla Firefox?
    • What is Vagrant?
    • Types of Research Methodology
    • Grafana Plugins
    • Ionic Components
    • Nginx Error_page
    • Nginx Include
    • Nginx Version
    • Nginx Force HTTPS
    • Nginx Environment Variables
    • Nginx Container
    • RabbitMQ Routing Key
    • CakePHP
    • Telegram Features
    • What is CDN
    • RethinkDB
    • Symfony Version
    • UWP
    • cPanel version
    • What is assembly?
    • Seed7
    • Switching Techniques
    • OCaml
    • Pseudocode?Algorithm
    • Quality Control Methods
    • What is OneNote?
    • Workstation Uses
    • Soft Computing Techniques
    • Remote Access Software
    • Remote Desktop Tools
    • OneNote Shortcuts
    • Software Review
    • What is Qubit?
    • Static Analysis Tools
    • Register in Microprocessor
    • What is VDI?
    • What is Svelte?
    • RabbitMQ Version
    • Groovy Version
    • Code Walkthrough
    • What is Telegram?
    • Gradle Version
    • What is Recycle Bin?
    • What is Cordova?
    • Swagger version
    • Doxygen
    • Phalcon
    • Metasploit Framework
    • Microsoft Word Shortcut Keys
    • Wordpad shortcut keys
    • Burp Suite
    • Google Docs Shortcuts
    • Install VPN
    • Frontend Challenges
    • CodeIgniter Version
    • VMware Tools
    • CDMA Advantages
    • CDMA Uses
    • Servlet Session Management
    • ServletConfig
    • Servlet Class
    • Log4j Version
    • Remote Desktop Softwares
    • Soapui Load Test
    • Scikit Learn Version
    • VMware Benefits
    • Google Slides Shortcuts
    • What is XAMPP?
    • What is PyGTK?
    • VMware Fusion
    • What is cPanel?
    • Ubuntu Version
    • Server Types
    • App Analytics Tools
    • DNS Types
    • Evernote Features
    • Restful architecture
    • GNOME Keyboard Shortcuts
    • AngelScript
    • NativeScript Layouts
    • PowerPoint Version
    • setInterval Function
    • Shopify Apps
    • TypeScript foreach loop
    • Socio Technical System
    • PowerPoint Shortcut Keys
    • Civil Engineering Tools
    • OpenLayers vs Leaflet
    • Circuit Switching Advantages and Disadvantages
    • LotusScript
    • Multiplexer
    • Multiple Access Protocol
    • Types of Broadband
    • What is Standardization
    • Methods of Development
    • Software Requirement Specification
    • CentOS restart network
    • Bouncy numbers
    • Burp suite proxy
    • Redshift window functions
    • Mesh Topology Advantages and Disadvantages
    • What is Zabbix?
    • Test Techniques
    • Test Development
    • What is PyCharm
    • What is REST
    • JDBC version
    • System software features
    • Ableton versions
    • Unreal engine version
    • RAD advantage disadvantage
    • Incremental Model Advantage and Disadvantage
    • Disadvantages of Internet
    • What is VoIP
    • WAP Architecture
    • CentOS unzip
    • Cubase Shortcuts
    • Cubase Versions
    • Libreoffice shortcut keys
    • Archiving Software
    • Layered Architecture
    • Coverage Types
    • What is Kivy?
    • Types of Methodology
    • Swift JSON
    • JSON Serialize
    • TypeScript?boolean
    • TypeScript keyof object
    • TypeScript RegEx
    • TypeScript?date
    • TypeScript object
    • CentOS Version
    • XSLT if else
    • Binary Search JavaScript
    • Binary search with recursion
    • PLSQL Replace
    • Evernote Notes
    • Rust vs Python
    • Test Scenario
    • Deadlock in Operating System
    • MVVM Architecture
    • MVVM Flutter
    • What is Keyboard
    • WordPress Hosting
    • Software requirement
    • CentOS Add User to Group
    • Backup Types
    • Firewall Rules
    • Microprocessor Features
    • Maven Versions
    • OneNote features
    • Binary search tree insertion
    • Quick sort algorithm
    • B+ tree insertion
    • What is Automation?
    • What is Digital Electronics?
    • Wireless Transmission Media
    • Border Gateway Protocol
    • Email Encryption Software
    • Endpoint Encryption
    • Outlook Alternative
    • What is Abacus
    • Encapsulation Benefits
    • FL Studio Keyboard Shortcuts
    • NordVPN Features
    • Statsmodels API
    • Statsmodels Linear Regression
    • Buzz number
    • Krishnamurthy Number
    • What is Compact Disc?
    • Bucket Sort Algorithm
    • Insertion Sort Algorithm
    • Redis Version
    • Chatbot Benefits
    • Full Stack Technologies
    • Civil Engineering Types
    • Tomcat Web Server
    • Tomcat Native
    • Tkinter Scrolledtext
    • Anaconda Navigator
    • UML Class Diagram
    • System Monitoring Tool
    • Drupal Features
    • Drupal Free Themes
    • Drupal Modules
    • Drupal 9
    • Drupal Developer
    • Drupal Webform
    • Drupal 8
    • Drupal 8 Themes
    • Drupal Views
    • System Software Functions
    • What is Linker?
    • What is K Map?
    • Website Testing Tool
    • TypeScript map
    • TypeScript enum
    • TypeScript class
    • Hill Climbing Algorithm
    • Hashmap and Hashtable
    • Nexus Plugin
    • Entity Framework Delete by ID
    • What is NumPy?
    • What is NLP?
    • Vishing Attack
    • Test Plan in Software Testing
    • Guest Mode
    • What is Mockito?
    • Advantage of the Internet
    • SVG Creator
    • Rails Logger
    • Intellij Plugins
    • Intellij Shortcuts
    • IntelliJ Maven
    • IntelliJ JavaFX
    • IntelliJ Lombok Plugin
    • IntelliJ Format Code
    • IntelliJ gitignore
    • IntelliJ Find and Replace
    • RESTEasy

Related Courses

Software Testing Training

Selenium Training Certification

Appium Training

JMeter Certification Training

Doxygen

Doxygen

Introduction to Doxygen

Doxygen is a tool or command line-based documentation generator that helps in writing reference documentation for software. As it is written within the code, it is very easy to keep on updating. Moreover, it can cross-reference the code and documentation, which helps in referring to the actual code. Due to these advantages, developers are now using Doxygen for their documentation. In addition to that, it supports different programming languages.  In this article, we will see more details on Doxygen.

All in One Software Development Bundle(600+ Courses, 50+ projects)
Python TutorialC SharpJavaJavaScript
C Plus PlusSoftware TestingSQLKali Linux
Price
View Courses
600+ Online Courses | 50+ projects | 3000+ Hours | Verifiable Certificates | Lifetime Access
4.6 (86,883 ratings)

Why do we need Doxygen?

As already explained, Doxygen is a tool that helps in writing reference documentation for different programming language such as Java, C, C++, C#, IDL, D etc.

Start Your Free Software Development Course

Web development, programming languages, Software testing & others

In addition to that, Doxygen can be used for the

  • creation of template configuration file,
  • generation of documentation using a conf file which is already available
  • updating of the old configuration file, etc.

More details on these will be explained under the heading Uses of Doxygen.

How Doxygen works?

Now, we are going to look at the working below:

1. Select the programming language

For working in Doxygen, first, there should be an assurance that the programming language you are about to choose is recognized by this tool. If not, then choose another method. Normally, Doxygen supports different programming languages such as C, C++, IDL, C#, Java, Objective C, VHDL, Python, D, PHP and Fortran.

Once you select your programming language to be used in Doxygen, create a conf file. That is configuration file. This file decides all the settings, and each of the project in Doxygen will have its own configuration file. As we all know, a project contains either a single source file or a whole source tree which has to be recursively scanned. For 1making conf file in an easy way, a template can be created by Doxygen using the command doxygen -g <conf-file>. Here, the <conf-file> is the configuration file’s name. Suppose you are not using the name of the file; in that case, a file will be created with the name as Doxyfile. In the case where there is already a file with this name, doxygen renames the same to <conf-file>.bak prior to the creation of the configuration template. If the minus sign is used in the created file name, it will be able to read from standard input (stdin), which helps in scripting.

2. Run Doxygen

In order to make the documentation, run the command doxygen <conf-file>.

Once this command is executed, an html, latex, rtf, xml, docbook or man directories will be created within the output directory. The type of document depends on the settings you have provided in the doxygen. From the type of files themselves, we can understand that these directories consist of the documentation in RTF, HTML, Unix-Man page, LATEX, DocBook and XML format.

In this, the default output directory is the one in which it starts. Moreover,  the root directory where the output will be written to can be changed with the help of OUTPUT_DIRECTORY. Inside this OUTPUT_DIRECTORY, the directory which is format-specific can be chosen using DOCBOOK_OUTPUT, HTML_OUTPUT, MAN_OUTPUT, RTF_OUTPUT, XML_OUTPUT, and LATEX_OUTPUT.tags of the conf file. Similar to the creation of the conf file, if the output directory also does not exist, the doxygen will be creating one.

3. Documentation of the sources

Even though the source documentation is explained as the third step, it should be explained as the first step in the case of a new project. Suppose the option EXTRACT_ALL is marked as No in the conf file; documentation will be generated by doxygen only for the documented entities. In order to document these, there are two methods, especially for classes, members and namespaces. The first one is to set a specific documentation block prior to the member/class/name space declaration or definition for file, class and namespace members; it is also allowed to place the documentation directly after the member.

The second way is to place the specific documentation block anywhere else. That is another location or file. Once it is placed, place a structural command within the block. The task of structural command is to connect the documentation block to a specific entity like member, namespace, class or file, which is possible to be documented. The main advantage of the first method is that the entity name need not be repeated.

Advantages and disadvantages

Advantages are:

  • Only less overhead is required from the one who writes the documentation.
  • Documentation of unions, files, templates, namespaces, enums, classes, functions, structs, typedefs, variables, and defines is supported.
  • Compatible with JavaDoc (1.1), KDOC and Qt-Doc
  • Class diagrams are generated automatically in HTML
  • Dependency graphs, graphical class hierarchy graphical graphs etc., can be created using the tool known as a dot which is available in the tool kit known as Graphviz.
  • Documentation can be kept within the header file, source file or in another file.
  • A list of class members can be generated with their protection level.
  • All the sections which are public, private as well as protected can be automatically detected.
  • Transferring to other machine or location is possible for the documentation as well as a search engine.
  • Easy to work even in large projects.

Even though it has several ways to include searching for the HTML output, it has certain disadvantages.

  • Client side searching is limited to symbols only rather than ful text searching.
  • Server side searching does not behave properly while working locally.
  • Compilation of the CHM file works on only Windows
  • Mac OSX and Xcode works only in combination.

Usage of Doxygen

As already explained. It can be used to create template configuration files, generate documentation using a conf file, etc. Now, we will see how.

  • Generation of template conf file: doxygen [-s] -g [confName]
  • Updation of an old conf file: doxygen [-s] -u [confName]
  • Generation of documentation using an already available configuration file: doxygen [confName]
  • Generation of a RTF/HTML/Latex template stylesheet file : doxygen -w rtf styleSheetFile
  • Generation of extension file of RTF : doxygen -e rtf extensionsFile

Conclusion

It is a tool that helps in writing reference documentation for different programming languages.  In this article, different aspects such as usage, working, pros, and cons are explained in detail.

Recommended Articles

This is a guide to Doxygen. Here we discuss Why do we need Doxygen and How it works with usage, Advantages and disadvantages. You may also have a look at the following articles to learn more –

  1. Doxygen Alternatives
  2. Software Testing Methodologies
  3. Quality Software
  4. Database Management Software
Popular Course in this category
Software Testing Training (11 Courses, 2 Projects)
  11 Online Courses |  2 Hands-on Projects |  65+ Hours |  Verifiable Certificate of Completion
4.5
Price

View Course

Related Courses

Selenium Automation Testing Training (11 Courses, 4+ Projects, 4 Quizzes)4.9
Appium Training (2 Courses)4.8
JMeter Testing Training (3 Courses)4.7
0 Shares
Share
Tweet
Share
Primary Sidebar
Footer
About Us
  • Blog
  • Who is EDUCBA?
  • Sign Up
  • Live Classes
  • Corporate Training
  • Certificate from Top Institutions
  • Contact Us
  • Verifiable Certificate
  • Reviews
  • Terms and Conditions
  • Privacy Policy
  •  
Apps
  • iPhone & iPad
  • Android
Resources
  • Free Courses
  • Java Tutorials
  • Python Tutorials
  • All Tutorials
Certification Courses
  • All Courses
  • Software Development Course - All in One Bundle
  • Become a Python Developer
  • Java Course
  • Become a Selenium Automation Tester
  • Become an IoT Developer
  • ASP.NET Course
  • VB.NET Course
  • PHP Course

ISO 10004:2018 & ISO 9001:2015 Certified

© 2022 - EDUCBA. ALL RIGHTS RESERVED. THE CERTIFICATION NAMES ARE THE TRADEMARKS OF THEIR RESPECTIVE OWNERS.

EDUCBA
Free Software Development Course

C# Programming, Conditional Constructs, Loops, Arrays, OOPS Concept

*Please provide your correct email id. Login details for this Free course will be emailed to you

By signing up, you agree to our Terms of Use and Privacy Policy.

EDUCBA Login

Forgot Password?

By signing up, you agree to our Terms of Use and Privacy Policy.

EDUCBA
Free Software Development Course

Web development, programming languages, Software testing & others

*Please provide your correct email id. Login details for this Free course will be emailed to you

By signing up, you agree to our Terms of Use and Privacy Policy.

EDUCBA

*Please provide your correct email id. Login details for this Free course will be emailed to you

By signing up, you agree to our Terms of Use and Privacy Policy.

Let’s Get Started

By signing up, you agree to our Terms of Use and Privacy Policy.

This website or its third-party tools use cookies, which are necessary to its functioning and required to achieve the purposes illustrated in the cookie policy. By closing this banner, scrolling this page, clicking a link or continuing to browse otherwise, you agree to our Privacy Policy

Loading . . .
Quiz
Question:

Answer:

Quiz Result
Total QuestionsCorrect AnswersWrong AnswersPercentage

Explore 1000+ varieties of Mock tests View more