to

1

• Introduction
• to
• Doxygen

2
Contents

• Introduction
• Main Steps for creating documentation
• Examples

3
Introduction

• Doxygen is a documentation system for C, C,
  Java, Objective-C, IDL (Corba and Microsoft
  flavors).
• It helps in
• Generating on-line documentation or offline
  reference manual from documented source files.
• Extracting the Code Structure and visualising the
  relations between various elements by
  means of include dependency graphs, inheritance
  diagrams, and collaboration diagrams, which are
  all generated automatically.

4
Steps

• Create a Configuration File
• Document the Code
• Run the Doxygen

5
Creating a Configuration File

• Doxygen determines settings from Configuration
  file.
• Doxywizard is a GUI front-end for configuring and
  running doxygen.

6
Doxywizard

• Steps to take to configure and run doxygen.
• Wizard
• Expert
• Load

7
Documenting Code

• Document Blocks or Lines
• Document members
• Structural Commands
• Create Lists

8
Document Block

• Specify Comment Blocks
• Special documentation blocks -Comment Blocks with
  additional markings.
• Brief and Detailed Description

9
Detailed Description

• Extra or ! For Comment Blocks
• e.g.
• /
• ... text ...
• /
• or
• /!
• ... text ...
• /

10
Detailed Description

• For Comment Lines-additional slash or an
  exclamation mark e.g.
• ///
• /// ... text ...
• ///
• or
• //!
• //!... text ...
• //!

11
Brief Description

• \brief command
• Syntax
• /! \brief Brief description.
• Brief description continued.
• Detailed description starts here.
• /

12
Document Members

• Documentation after member specification in
  source file.
• Use lt , that indicates that member is located
  in front of block.
• Syntax
• int var /!lt Description /
• or Brief Description
• int var //!lt Brief Description

13
Creating Lists

• Bulleted Lists - Column aligned Minus
  Sign -
• Numbered Lists - Column aligned Minus Sign
  followed by Hash
• 
  -
• Nesting Level is maintained according to column
  alignment.
• HTML Commands - Can be used inside comment
  blocks.

14
Creating Lists

• Syntax
• /!
• List of events
• -Event1
• -Subevent1
• -Subevent2\n
• subevent2 cont.
• -Subevent3
• -Event2
• -Event3
• /

15
Structural Commands

• Starts with \ or _at_.
• Main commands
• \author list of authors
• \brief brief description
• \date date description
• \file ltnamegt
• \fn (function name)- used if comment block
  is not placed
• \param ltparameter-namegt parameter
  description
• \return return value description

16
Structural Commands

• Visual Enhancement Commands
• \a - Special font
• \b - bold
• \c - Typewriter Font
• \arg - Simple bulleted list, not nested
• \e - Italics
• \em - Emphasize word and in Italics

17
Examples

• ...