doxy_tutorial

doxy_tutorial - Documentation Generators Doxygen Tutorial...

Info iconThis preview shows pages 1–2. Sign up to view the full content.

View Full Document Right Arrow Icon
1 Doxygen Tutorial For : COP 3330. Object oriented Programming (Using C++) http://www.compgeom.com/~piyush/teach/3330 Piyush Kumar Documentation Generators | A documentation generator is a programming tool that generates documentation intended for programmers ( API documentation ) or end users ( End-user Guide), or both, from a set of specially commented source codes . Commenting programs z Doxygen is a documentation generator for C++ , C , Java , Objective- C , Python , and to some extent PHP , C# and D . z Its highly portable. (Windows/unix/linux/mac) z KDevelop has builtin support for Doxygen. Why? | Doxygen is very useful for maintaining and understanding your own larger projects as well as useful documentation for others who use your code. How? | For each project that uses Doxygen, you must create a configuration file. | doxygen –g ” creates a example configuration file called “ Doxyfile | doxygen [configfile] ” will create the documentation for your code as per your configuration specs. Configuration File
Background image of page 1

Info iconThis preview has intentionally blurred sections. Sign up to view the full version.

View Full DocumentRight Arrow Icon
Image of page 2
This is the end of the preview. Sign up to access the rest of the document.

Page1 / 2

doxy_tutorial - Documentation Generators Doxygen Tutorial...

This preview shows document pages 1 - 2. Sign up to view the full document.

View Full Document Right Arrow Icon
Ask a homework question - tutors are online