Doxygen

Summary

Learn about Doxygen and how to obtain the service in Saint Mary's University

Body

Name

Doxygen

Description

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL and to some extent D. 

Functions

It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. 

You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. 

You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site). 

OS Supported

Windows 10

Apple MacOS

License Details

This license is an annual subscription purchased by Saint Mary's University

Available to

Faculty/Staff/Students

Restrictions

Personal devices and university-owned devices

How to Get

For Students/Staff/Faculty: Doxygen is available via AppsAnywhere.smu.ca

Faculty only: For special requests, please contact EIT Helpdesk at helpdesk@smu.ca

Website

For more information, visit https://www.doxygen.nl/index.html

 

Details

Details

Article ID: 541
Created
Tue 3/16/21 9:49 AM
Modified
Fri 7/15/22 1:37 PM