src/Doxyfile

   1 # Doxyfile: default configuration for `doxygen'.
   2
   3 # We'll explicitly list inputs (for faster doxygen runs), but will probably
   4 # switch to recursive scan once we have a large number of inputs.
   5 #FILE_PATTERNS = *.cpp *.h
   6 #RECURSIVE = yes
   7 # find -name '*.cpp' -o -name '*.h'|xargs grep -l '\\file'|sort|sed 's,^./,     ,;s,$,  \\,'
   8 # (and remove the non source files sp-skeleton.*).
   9 INPUT = \
  10         application/application.cpp     \
  11         application/application.h       \
  12         application/editor.cpp  \
  13         application/editor.h    \
  14         arc-context.cpp \
  15         attributes.cpp  \
  16         attributes.h    \
  17         color-rgba.h    \
  18         color.cpp       \
  19         color.h \
  20         composite-undo-stack-observer.h \
  21         desktop-style.cpp       \
  22         desktop.cpp     \
  23         desktop.h       \
  24         dialogs/color-picker.h  \
  25         dialogs/desktop-properties.cpp  \
  26         dialogs/export.cpp      \
  27         dialogs/filedialog.h    \
  28         dialogs/unclump.h       \
  29         dir-util.cpp    \
  30         display/bezier-utils.cpp        \
  31         display/curve.cpp       \
  32         display/curve.h \
  33         display/sp-canvas.cpp   \
  34         display/sp-canvas.h     \
  35         document-undo.cpp       \
  36         document.cpp    \
  37         document.h      \
  38         draw-anchor.cpp \
  39         draw-anchor.h   \
  40         event-context.cpp       \
  41         event-context.h \
  42         extension/extension.cpp \
  43         extension/extension.h   \
  44         extension/implementation/plugin-link.h  \
  45         extension/implementation/plugin.cpp     \
  46         extension/implementation/plugin.h       \
  47         extension/implementation/script.cpp     \
  48         extension/internal/bluredge.cpp \
  49         extension/internal/gimpgrad.cpp \
  50         extension/internal/gimpgrad.h   \
  51         extension/internal/grid.cpp     \
  52         extension/internal/ps.cpp       \
  53         extension/internal/ps.h \
  54         extension/parameter.cpp \
  55         extension/parameter.h   \
  56         fill-or-stroke.h        \
  57         gc-anchored.h   \
  58         gc-managed.h    \
  59         geom.cpp        \
  60         geom.h  \
  61         grid-snapper.cpp        \
  62         grid-snapper.h  \
  63         guide-snapper.cpp       \
  64         guide-snapper.h \
  65         helper/action.cpp       \
  66         helper/action.h \
  67         jabber_whiteboard/buddy-list-manager.h  \
  68         jabber_whiteboard/callbacks.h   \
  69         jabber_whiteboard/chat-handler.h        \
  70         jabber_whiteboard/defines.h     \
  71         jabber_whiteboard/deserializer.h        \
  72         jabber_whiteboard/error-codes.h \
  73         jabber_whiteboard/internal-constants.h  \
  74         jabber_whiteboard/invitation-confirm-dialog.h   \
  75         jabber_whiteboard/jabber-handlers.h     \
  76         jabber_whiteboard/message-aggregator.h  \
  77         jabber_whiteboard/message-contexts.h    \
  78         jabber_whiteboard/message-handler.h     \
  79         jabber_whiteboard/message-node.h        \
  80         jabber_whiteboard/message-processors.cpp        \
  81         jabber_whiteboard/message-processors.h  \
  82         jabber_whiteboard/message-queue.h       \
  83         jabber_whiteboard/message-tags.h        \
  84         jabber_whiteboard/message-utilities.h   \
  85         jabber_whiteboard/node-tracker-event-tracker.h  \
  86         jabber_whiteboard/node-tracker-observer.h       \
  87         jabber_whiteboard/node-tracker.cpp      \
  88         jabber_whiteboard/node-tracker.h        \
  89         jabber_whiteboard/node-utilities.h      \
  90         jabber_whiteboard/session-file-player.h \
  91         jabber_whiteboard/session-file-selector.h       \
  92         jabber_whiteboard/session-file.h        \
  93         jabber_whiteboard/session-manager.h     \
  94         jabber_whiteboard/tracker-node.h        \
  95         jabber_whiteboard/typedefs.h    \
  96         jabber_whiteboard/undo-stack-observer.h \
  97         knot-enums.h    \
  98         knot-holder-entity.h    \
  99         knot.cpp        \
 100         knot.h  \
 101         libnr/n-art-bpath.h     \
 102         libnr/nr-matrix-scale-ops.h     \
 103         libnr/nr-matrix-translate-ops.h \
 104         libnr/nr-matrix.cpp     \
 105         libnr/nr-matrix.h       \
 106         libnr/nr-path-code.h    \
 107         libnr/nr-pixblock.cpp   \
 108         libnr/nr-pixblock.h     \
 109         libnr/nr-point-matrix-ops.h     \
 110         libnr/nr-point.h        \
 111         libnr/nr-rect.h \
 112         libnr/nr-rotate-fns.cpp \
 113         libnr/nr-rotate-fns.h   \
 114         libnr/nr-rotate.h       \
 115         libnr/nr-scale-matrix-ops.h     \
 116         libnr/nr-types.cpp      \
 117         libnrtype/boundary-type.h       \
 118         libnrtype/one-box.h     \
 119         libnrtype/one-glyph.h   \
 120         libnrtype/text-boundary.h       \
 121         livarot/float-line.cpp  \
 122         livarot/float-line.h    \
 123         livarot/int-line.cpp    \
 124         livarot/int-line.h      \
 125         livarot/sweep-event-queue.h     \
 126         livarot/sweep-event.h   \
 127         livarot/sweep-tree-list.h       \
 128         main.cpp        \
 129         message-context.h       \
 130         message-stack.h \
 131         modifier-fns.h  \
 132         nodepath.cpp    \
 133         nodepath.h      \
 134         object-hierarchy.cpp    \
 135         object-hierarchy.h      \
 136         pen-context.cpp \
 137         pen-context.h   \
 138         pencil-context.cpp      \
 139         pencil-context.h        \
 140         preferences.cpp \
 141         preferences.h   \
 142         print.cpp       \
 143         print.h \
 144         removeoverlap/remove_rectangle_overlap.h        \
 145         selection.cpp   \
 146         selection.h     \
 147         shortcuts.cpp   \
 148         snap.cpp        \
 149         snap.h  \
 150         snapper.cpp     \
 151         snapper.h       \
 152         sp-animation.cpp        \
 153         sp-gradient-fns.h       \
 154         sp-gradient.cpp \
 155         sp-gradient.h   \
 156         sp-item-notify-moveto.cpp       \
 157         sp-item.cpp     \
 158         sp-item.h       \
 159         sp-linear-gradient-fns.h        \
 160         sp-linear-gradient.h    \
 161         sp-object.cpp   \
 162         sp-object.h     \
 163         sp-offset.cpp   \
 164         sp-offset.h     \
 165         sp-radial-gradient-fns.h        \
 166         sp-radial-gradient.h    \
 167         sp-root.cpp     \
 168         sp-root.h       \
 169         sp-spiral.cpp   \
 170         sp-spiral.h     \
 171         sp-stop.h       \
 172         style.cpp       \
 173         style.h \
 174         svg-view-widget.cpp     \
 175         svg-view-widget.h       \
 176         svg-view.cpp    \
 177         svg-view.h      \
 178         ui/dialog/document-preferences.cpp      \
 179         ui/dialog/document-preferences.h        \
 180         ui/view/edit-widget-interface.h \
 181         ui/view/view-widget.cpp \
 182         ui/view/view-widget.h   \
 183         ui/view/view.cpp        \
 184         ui/view/view.h  \
 185         ui/widget/color-picker.cpp      \
 186         ui/widget/color-picker.h        \
 187         ui/widget/color-preview.cpp     \
 188         ui/widget/color-preview.h       \
 189         ui/widget/entity-entry.cpp      \
 190         ui/widget/entity-entry.h        \
 191         ui/widget/licensor.cpp  \
 192         ui/widget/licensor.h    \
 193         ui/widget/page-sizer.cpp        \
 194         ui/widget/page-sizer.h  \
 195         ui/widget/registered-widget.cpp \
 196         ui/widget/registered-widget.h   \
 197         ui/widget/registry.cpp  \
 198         ui/widget/registry.h    \
 199         ui/widget/ruler.cpp     \
 200         ui/widget/ruler.h       \
 201         ui/widget/svg-canvas.cpp        \
 202         ui/widget/svg-canvas.h  \
 203         ui/widget/zoom-status.cpp       \
 204         ui/widget/zoom-status.h \
 205         undo-stack-observer.h   \
 206         uri.cpp \
 207         uri.h   \
 208         util/list.h     \
 209         verbs.cpp       \
 210         verbs.h \
 211         widgets/desktop-widget.cpp      \
 212         widgets/desktop-widget.h        \
 213         widgets/icon.cpp        \
 214         widgets/paint-selector.cpp      \
 215         widgets/paint-selector.h        \
 216         widgets/toolbox.cpp     \
 217         xml/quote.cpp   \
 218         xml/repr-sorting.h      \
 219         xml/repr-util.cpp       \
 220         xml/repr.cpp    \
 221         xml/repr.h
 222
 223
 224 # Uncomment this to treat undocumented things as if they had an empty
 225 # documentation string; comment it out to suppress all undocumented things from
 226 # the output.
 227 # Leaving it uncommented allows using doxygen output as the primary information
 228 # source about a class (without needing to look at the source code to look for
 229 # undocumented things).
 230 # OTOH, you may find it annoying to have reems of relatively unhelpful
 231 # information: commenting it out gives more compact display of the helpful
 232 # bits.
 233 # I'm commenting it out for now to facilitate checking existing doc comments
 234 # for doxygen correctness.
 235 #EXTRACT_ALL = yes
 236
 237 # I'll disable this for the moment, to reduce the number of files in the output.
 238 SOURCE_BROWSER = no
 239
 240 # Keep the output out of the src directory so that it doesn't get in the way of
 241 # `rgrep'.
 242 OUTPUT_DIRECTORY = ../doxygen
 243
 244 # In absence of explicit `\brief', treat the first "sentence" as the brief part
 245 # and the rest as detail.  (With explicit `\brief', the first _paragraph_ is
 246 # considered the brief part.)
 247 #
 248 # It's unclear whether programmers should deliberately use this facility.
 249 # Advantage: Less clutter.
 250 # Disadvantage: Absence of `\brief' may indicate that the comment was written
 251 # by someone unfamiliar with doxygen and not giving thought to what the brief
 252 # description should be.  Using explicit `\brief' may facilitate checking
 253 # non-\briefed comments for doxygen correctness.
 254 # OTOH, using `\brief' may be parrot-like: it doesn't necessarily indicate
 255 # doxygen familiarity.
 256 JAVADOC_AUTOBRIEF = yes
 257
 258 WARN_IF_UNDOCUMENTED = yes
 259
 260 GENERATE_TODOLIST = yes
 261
 262 GENERATE_BUGLIST = yes
 263
 264 REFERENCED_BY_RELATION = yes
 265
 266 EXTRACT_STATIC = yes
 267
 268 WARN_LOGFILE = doxygen-log
 269