include/sal/log-areas.dox

   1 // NOTE: This file is also parsed by a compiler plugin. Make sure all
   2 // areas are marked with '@li @c'.
   3
   4 /**
   5 @page sal_log_areas SAL debug areas
   6
   7 @short List and description of areas for the SAL debug macros
   8
   9 This is a list of areas that are used by the SAL_INFO family of macros.  See
  10 @ref sal_log "basic log functionality" for details about this functionality.
  11
  12 If you need a debug area in some code, first check this list and use the
  13 appropriate area if it exists.  This list is not definite, if you need a new
  14 area, use it and add it to an appropriate section with an explanation.
  15 Generally, use the name of the relevant code module as the first area segment.
  16 Please keep all entries sorted.
  17
  18 This list should give you an overview of which areas to enable when debugging
  19 certain functionality.
  20
  21 @section SAL
  22
  23 @li @c sal.debug - SAL debugging functionality
  24 @li @c sal.osl - SAL OSL library
  25 @li @c sal.rtl - SAL RTL library
  26 @li @c sal.textenc - the textencoding SAL library
  27
  28 @section basctl
  29
  30 @li @c basctl.basicide
  31
  32 @section basebmp
  33
  34 @li @c basebmp.bitmapdevice
  35
  36 @section basic
  37
  38 @li @c basic
  39 @li @c basic.sbx
  40
  41 @section canvas
  42
  43 @li @c canvas
  44 @li @c canvas.cairo
  45 @li @c canvas.null
  46
  47 @section chart2
  48
  49 @li @c chart2
  50 @li @c chart2.areachart
  51
  52 @section connectivity
  53
  54 @li @c connectivity.cpool
  55 @li @c connectivity.commontools
  56 @li @c connectivity.mork
  57 @li @c connectivity.flat
  58 @li @c connectivity.parse
  59 @li @c connectivity.postgresql
  60
  61 @section cui
  62
  63 @li @c cui.customize
  64 @li @c cui.dialogs
  65 @li @c cui.factory
  66 @li @c cui.options
  67 @li @c cui.tabpages
  68
  69 @section Calc
  70
  71 @li @c sc
  72 @li @c sc.core
  73 @li @c sc.ui - Calc UI
  74
  75 @section desktop
  76
  77 @li @c desktop
  78 @li @c desktop.deployment
  79 @li @c desktop.migration
  80
  81 @section Draw
  82
  83 @li @c sd
  84 @li @c sd.fwk
  85 @li @c sd.sls - slidesorter
  86 @li @c sd.tools
  87 @li @c sd.ui
  88 @li @c sd.view
  89 @li @c sd.slideshow
  90 @li @c sdremote
  91 @li @c sdremote.bluetooth
  92
  93 @section editeng
  94
  95 @li @c editeng
  96 @li @c editeng.items
  97
  98 @section embeddedobj
  99
 100 @li @c embeddedobj - embedded objects
 101 @li @c embeddedobj.ole - OLE embedded objects
 102
 103 @section extensions
 104
 105 @li @c extensions.dbpilots
 106 @li @c extensions.plugin
 107 @li @c extensions.scanner
 108 @li @c extensions.update
 109
 110 @section Filter
 111
 112 @li @c filter.ms - escher import/export
 113 @li @c filter.xslt - xslt import/export
 114 @li @c oox.xmlstream - XmlStream class
 115 @li @c oox.storage - ZipStorage class
 116 @li @c oox.ppt - pptx filter
 117
 118 @section forms
 119
 120 @li @c forms.component
 121 @li @c forms.runtime
 122
 123 @section formula
 124
 125 @li @c formula.core
 126
 127 @section fpicker
 128
 129 @li @c fpicker.aqua
 130 @li @c fpicker.office
 131
 132 @section framework
 133
 134 @li @c fwk - framework
 135 @li @c fwk.desktop
 136 @li @c fwk.dispatch
 137 @li @c fwk.session
 138
 139 @section i18nlangtag
 140
 141 @li @c i18nlangtag - language tags
 142
 143 @section i18npool
 144
 145 @li @c i18npool - general i18npool
 146
 147 @section i18n
 148
 149 @li @c i18n - module independent i18n related, e.g. language tag usage
 150
 151 @section io
 152
 153 @li @c io.streams
 154
 155 @section jvmfwk
 156
 157 @li @c jfw
 158 @li @c jfw.level1
 159 @li @c jfw.level2
 160
 161 @section Math
 162
 163 @li @c starmath.rtf
 164 @li @c starmath.ooxml - OOXML import/export
 165 @li @c starmath.wordbase
 166
 167 @section sdext
 168
 169 @li @c sdext.minimizer
 170 @li @c sdext.pdfimport
 171 @li @c sdext.pdfimport.pdfparse
 172 @li @c sdext.presenter
 173
 174 @section sfx2
 175
 176 @li @c sfx2
 177 @li @c sfx2.appl
 178 @li @c sfx2.bastyp
 179 @li @c sfx2.config
 180 @li @c sfx2.control
 181 @li @c sfx2.dialog
 182 @li @c sfx2.doc
 183 @li @c sfx2.notify
 184 @li @c sfx2.view
 185
 186 @section slideshow
 187
 188 @li @c slideshow.opengl
 189 @li @c slideshow.eventqueue
 190
 191 @section svl
 192
 193 @li @c svl
 194 @li @c svl.numbers
 195
 196 @section svtools
 197
 198 @li @c svtools
 199 @li @c svtools.config
 200 @li @c svtools.contnr
 201 @li @c svtools.control
 202 @li @c svtools.dialogs
 203 @li @c svtools.filter
 204 @li @c svtools.misc
 205 @li @c svtools.table
 206 @li @c svtools.uno
 207
 208 @section svx
 209
 210 @li @c svx.dialog
 211 @li @c svx.fmcomp
 212 @li @c svx.form
 213 @li @c svx.stbcrtls - StatusBarControl
 214 @li @c svx.table
 215 @li @c svx.tbxcrtls - ToolboxControl
 216 @li @c svx.sdr
 217 @li @c svx.uno
 218
 219 @section toolkit
 220
 221 @li @c toolkit.controls
 222
 223 @section tools
 224
 225 @li @c tools.debug
 226 @li @c tools.datetime
 227 @li @c tools.generic
 228 @li @c tools.memtools
 229 @li @c tools.rc - resource manager
 230 @li @c tools.stream - SvStream class
 231
 232 @section ucb
 233
 234 @li @c cmisucp
 235 @li @c ucb.ucp
 236 @li @c ucb.ucp.gio
 237 @li @c ucb.ucp.webdav
 238
 239 @section unotools
 240
 241 @li @c unotools.config
 242 @li @c unotools.i18n
 243 @li @c unotools.misc
 244 @li @c unotools.ucbhelper
 245
 246 @section URE
 247
 248 @li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
 249 @li @c salhelper.thread - ::salhelper::Thread class
 250
 251 @section sax
 252
 253 @li @c sax.cppunit
 254
 255 @section stoc
 256
 257 @li @c stoc.corerefl - CoreReflection
 258
 259 @section svl
 260
 261 @li @c svl.items
 262
 263 @section VCL
 264
 265 @li @c vcl
 266 @li @c vcl.a11y
 267 @li @c vcl.atsui - ATSUI (obsolete) -using code for Mac OS X
 268 @li @c vcl.control
 269 @li @c vcl.coretext - CoreText-using code for Mac OS X and iOS
 270 @li @c vcl.emf - EMF/EMF+ processing
 271 @li @c vcl.fonts - font-specific code
 272 @li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
 273 @li @c vcl.gtk - Gtk+ 2/3 plugin
 274 @li @c vcl.harfbuzz.layout
 275 @li @c vcl.headless - bitmap-based backend
 276 @li @c vcl.kde - KDE
 277 @li @c vcl.kde4 - KDE4
 278 @li @c vcl.layout - Widget layout
 279 @li @c vcl.scrollbar - Scroll Bars
 280 @li @c vcl.sm - Session Manager
 281 @li @c vcl.window
 282 @li @c vcl.unity
 283 @li @c vcl.virdev
 284
 285 @section Writer
 286
 287 @li @c sw
 288 @li @c sw.core - Writer core
 289 @li @c sw.docx
 290 @li @c sw.envelp
 291 @li @c sw.level2
 292 @li @c sw.rtf - .rtf export filter
 293 @li @c sw.uno - Writer UNO interfaces
 294 @li @c sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
 295 @li @c sw.ww8.level2 - further info for sw.ww8
 296
 297 @section writerfilter
 298
 299 @li @c writerfilter
 300 @li @c writerfilter.profile - load times of filters
 301
 302 @section writerperfect
 303
 304 @li @c writerperfect
 305
 306 @section xmloff
 307
 308 @li @c xmloff
 309 @li @c xmloff.core
 310 @li @c xmloff.draw
 311 @li @c xmloff.forms
 312 @li @c xmloff.chart
 313 @li @c xmloff.style
 314 @li @c xmloff.text
 315 @li @c xmloff.transform
 316
 317 @section xmlsecurity
 318
 319 @li @c xmlsecurity.dialogs - xml security dialogs
 320 @li @c xmlsecurity.helper
 321 @li @c xmlsecurity.xmlsec - xmlsec wrapper
 322
 323 @section xmlscript
 324
 325 @li @c xmlscript.xmlhelper
 326 @li @c xmlscript.xmldlg
 327 @li @c xmlscript.xmlflat
 328 @li @c xmlscript.xmllib
 329 @li @c xmlscript.xmlmod
 330
 331 @section dbaccess
 332
 333 @li @c dbaccess
 334 @li @c dbaccess.ui
 335 @li @c dbaccess.ui.OGeneralPage
 336
 337 @section svx
 338
 339 @li @c svx
 340 @li @c svx.fmcmop
 341
 342 @section other
 343
 344 @li @c accessibility
 345 @li @c avmedia
 346 @li @c basebmp
 347 @li @c binaryurp
 348 @li @c bridges
 349 @li @c comphelper
 350 @li @c configmgr
 351 @li @c cppcanvas
 352 @li @c cppcanvas.emf
 353 @li @c cppuhelper
 354 @li @c cppu
 355 @li @c helpcompiler
 356 @li @c linguistic
 357 @li @c oox
 358 @li @c package
 359 @li @c rsc
 360 @li @c sax
 361 @li @c shell
 362 @li @c stoc
 363 @li @c svg
 364 @li @c ucbhelper
 365 @li @c unoidl
 366 @li @c uui
 367 @li @c vbahelper
 368 @li @c xmlhelp
 369 @li @c xmlreader
 370
 371 */
 372 /* vim:set ft=cpp shiftwidth=4 softtabstop=4 expandtab: */