doxygen.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Tue, 26 Oct 2010 11:45:51 +0300
changeset 625 85cabce94fda
child 626 ad96e87bf403
permissions -rwxr-xr-x
Simple workflow.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
625
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
-*- mode: outline; coding: utf-8 -*-
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
* Doxygen simple workflow.
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
  $ cd $proj
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
  $ doxygen -g $proj.cfg  # generate basic config file
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     8
Edit $proj.cfg. Some essential settings:
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    10
  PROJECT_NAME     = my-proj
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    11
  OUTPUT_DIRECTORY = my
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    12
  OUTPUT_LANGUAGE  = English
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    13
  INPUT            = my.h my.hpp dir/
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    14
  INPUT_ENCODING   = UTF-8
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    15
  FILE_PATTERNS    =
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    16
  RECURSIVE        = NO
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    17
  GENERATE_HTML    = YES
85cabce94fda Simple workflow.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    18