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.file
  25 @li @c sal.osl - SAL OSL library
  26 @li @c sal.rtl - SAL RTL library
  27 @li @c sal.textenc - the textencoding SAL library
  28
  29 @section basctl
  30
  31 @li @c basctl.basicide
  32
  33 @section basebmp
  34
  35 @li @c basebmp.bitmapdevice
  36
  37 @section basic
  38
  39 @li @c basic
  40 @li @c basic.sbx
  41
  42 @section canvas
  43
  44 @li @c canvas
  45 @li @c canvas.cairo
  46 @li @c canvas.directx
  47 @li @c canvas.null
  48 @li @c canvas.ogl
  49 @li @c canvas.vcl
  50
  51 @section chart2
  52
  53 @li @c chart2
  54 @li @c chart2.areachart
  55
  56 @section connectivity
  57
  58 @li @c connectivity.commontools
  59 @li @c connectivity.cpool
  60 @li @c connectivity.drivers
  61 @li @c connectivity.evoab2
  62 @li @c connectivity.firebird
  63 @li @c connectivity.flat
  64 @li @c connectivity.hsqldb
  65 @li @c connectivity.jdbc
  66 @li @c connectivity.mork
  67 @li @c connectivity.parse
  68 @li @c connectivity.postgresql
  69
  70 @section comphelper
  71
  72 @li @c comphelper
  73 @li @c comphelper.container
  74
  75 @section cui
  76
  77 @li @c cui.customize
  78 @li @c cui.dialogs
  79 @li @c cui.factory
  80 @li @c cui.options
  81 @li @c cui.tabpages
  82
  83 @section Calc
  84
  85 @li @c sc
  86 @li @c sc.opencl
  87 @li @c sc.opencl.thread
  88 @li @c sc.qa
  89 @li @c sc.core
  90 @li @c sc.filter - Calc filter
  91 @li @c sc.ui - Calc UI
  92
  93 @section desktop
  94
  95 @li @c desktop
  96 @li @c desktop.app
  97 @li @c desktop.deployment
  98 @li @c desktop.migration
  99 @li @c desktop.offacc
 100 @li @c desktop.splash
 101
 102 @section Draw
 103
 104 @li @c sd
 105 @li @c sd.filter
 106 @li @c sd.fwk
 107 @li @c sd.slideshow
 108 @li @c sd.sls - slidesorter
 109 @li @c sd.tools
 110 @li @c sd.ui
 111 @li @c sd.view
 112 @li @c sdremote
 113 @li @c sdremote.bluetooth
 114 @li @c sdremote.wifi
 115
 116 @section editeng
 117
 118 @li @c editeng
 119 @li @c editeng.items
 120
 121 @section embeddedobj
 122
 123 @li @c embeddedobj - embedded objects
 124 @li @c embeddedobj.common
 125 @li @c embeddedobj.general
 126 @li @c embeddedobj.ole - OLE embedded objects
 127
 128 @section extensions
 129
 130 @li @c extensions.dbpilots
 131 @li @c extensions.plugin
 132 @li @c extensions.scanner
 133 @li @c extensions.update
 134
 135 @section Filter
 136
 137 @li @c filter.config
 138 @li @c filter.ms - escher import/export
 139 @li @c filter.odfflatxml
 140 @li @c filter.xslt - xslt import/export
 141 @li @c oox.cscode - see oox/source/drawingml/customshapes/README
 142 @li @c oox.drawingml - DrawingML
 143 @li @c oox.ppt - pptx filter
 144 @li @c oox.storage - ZipStorage class
 145 @li @c oox.xmlstream - XmlStream class
 146
 147 @section forms
 148
 149 @li @c forms.component
 150 @li @c forms.misc
 151 @li @c forms.runtime
 152
 153 @section formula
 154
 155 @li @c formula.core
 156
 157 @section fpicker
 158
 159 @li @c fpicker.aqua
 160 @li @c fpicker.office
 161
 162 @section framework
 163
 164 @li @c fwk - framework (abbreviation)
 165 @li @c fwk.accelerators
 166 @li @c fwk.autorecovery
 167 @li @c fwk.desktop
 168 @li @c fwk.dispatch
 169 @li @c fwk.frame
 170 @li @c fwk.joburl
 171 @li @c fwk.loadenv
 172 @li @c fwk.session
 173 @li @c fwk.uielement
 174
 175 @section i18nlangtag
 176
 177 @li @c i18nlangtag - language tags
 178
 179 @section i18npool
 180
 181 @li @c i18npool - general i18npool
 182
 183 @section i18n
 184
 185 @li @c i18n - module independent i18n related, e.g. language tag usage
 186
 187 @section io
 188
 189 @li @c io.streams
 190
 191 @section jvmfwk
 192
 193 @li @c jfw
 194 @li @c jfw.level1
 195 @li @c jfw.level2
 196
 197 @section l10ntools
 198
 199 @li @c l10ntools
 200
 201 @section Math
 202
 203 @li @c starmath
 204 @li @c starmath.ooxml - OOXML import/export
 205 @li @c starmath.rtf
 206 @li @c starmath.wordbase
 207
 208 @section package
 209
 210 @li @c package
 211 @li @c package.xstor
 212
 213 @section sdext
 214
 215 @li @c sdext.minimizer
 216 @li @c sdext.pdfimport
 217 @li @c sdext.pdfimport.pdfparse
 218 @li @c sdext.presenter
 219
 220 @section sfx2
 221
 222 @li @c sfx2
 223 @li @c sfx2.appl
 224 @li @c sfx2.doc
 225
 226 @section sfx
 227
 228 @li @c sfx
 229 @li @c sfx.appl
 230 @li @c sfx.bastyp
 231 @li @c sfx.config
 232 @li @c sfx.control
 233 @li @c sfx.dialog
 234 @li @c sfx.doc
 235 @li @c sfx.notify
 236 @li @c sfx.sidebar
 237 @li @c sfx.view
 238
 239 @section slideshow
 240
 241 @li @c slideshow
 242 @li @c slideshow.eventqueue
 243 @li @c slideshow.opengl
 244
 245 @section svl
 246
 247 @li @c svl
 248 @li @c svl.numbers
 249
 250 @section svtools
 251
 252 @li @c svtools
 253 @li @c svtools.config
 254 @li @c svtools.contnr
 255 @li @c svtools.control
 256 @li @c svtools.dialogs
 257 @li @c svtools.misc
 258 @li @c svtools.table
 259 @li @c svtools.uno
 260
 261 @section svx
 262
 263 @li @c svx.dialog
 264 @li @c svx.fmcomp
 265 @li @c svx.form
 266 @li @c svx.sdr
 267 @li @c svx.stbcrtls - StatusBarControl
 268 @li @c svx.svdraw
 269 @li @c svx.table
 270 @li @c svx.tbxcrtls - ToolboxControl
 271 @li @c svx.uno
 272
 273 @section toolkit
 274
 275 @li @c toolkit.controls
 276
 277 @section tools
 278
 279 @li @c tools
 280 @li @c tools.datetime
 281 @li @c tools.debug
 282 @li @c tools.generic
 283 @li @c tools.memtools
 284 @li @c tools.rc - resource manager
 285 @li @c tools.stream - SvStream class
 286 @li @c tools.urlobj - INetURLObject class
 287
 288 @section ucb
 289
 290 @li @c ucb
 291 @li @c ucb.core
 292 @li @c ucb.ucp
 293 @li @c ucb.ucp.cmis
 294 @li @c ucb.ucp.ext
 295 @li @c ucb.ucp.ftp
 296 @li @c ucb.ucp.gio
 297 @li @c ucb.ucp.gvfs
 298 @li @c ucb.ucp.webdav
 299
 300 @section unotools
 301
 302 @li @c unotools.config
 303 @li @c unotools.i18n
 304 @li @c unotools.misc
 305 @li @c unotools.ucbhelper
 306
 307 @section URE
 308
 309 @li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
 310 @li @c salhelper.thread - ::salhelper::Thread class
 311
 312 @section sax
 313
 314 @li @c sax.cppunit
 315
 316 @section stoc
 317
 318 @li @c stoc.corerefl - CoreReflection
 319
 320 @section svl
 321
 322 @li @c svl.items
 323
 324 @section VCL
 325
 326 @li @c vcl
 327 @li @c vcl.a11y
 328 @li @c vcl.app
 329 @li @c vcl.atsui - ATSUI (obsolete) -using code for Mac OS X
 330 @li @c vcl.control
 331 @li @c vcl.coretext - CoreText-using code for Mac OS X and iOS
 332 @li @c vcl.emf - EMF/EMF+ processing
 333 @li @c vcl.filter
 334 @li @c vcl.fonts - font-specific code
 335 @li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
 336 @li @c vcl.gtk - Gtk+ 2/3 plugin
 337 @li @c vcl.harfbuzz - HarfBuzz text layout
 338 @li @c vcl.headless - bitmap-based backend
 339 @li @c vcl.helper
 340 @li @c vcl.kde - KDE
 341 @li @c vcl.kde4 - KDE4
 342 @li @c vcl.layout - Widget layout
 343 @li @c vcl.plugadapt - the Unix/X11 backend plugin mechanism
 344 @li @c vcl.scrollbar - Scroll Bars
 345 @li @c vcl.sm - Session Manager
 346 @li @c vcl.unity
 347 @li @c vcl.unx.print
 348 @li @c vcl.virdev
 349 @li @c vcl.window
 350
 351 @section winaccessiblity
 352
 353 @li @c iacc2 - IAccessible2 bridge debug
 354
 355 @section Writer
 356
 357 @li @c sw
 358 @li @c sw.core - Writer core
 359 @li @c sw.doc
 360 @li @c sw.docx
 361 @li @c sw.envelp
 362 @li @c sw.filter
 363 @li @c sw.level2
 364 @li @c sw.rtf - .rtf export filter
 365 @li @c sw.ui
 366 @li @c sw.uno - Writer UNO interfaces
 367 @li @c sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
 368 @li @c sw.ww8.level2 - further info for sw.ww8
 369
 370 @section writerfilter
 371
 372 @li @c writerfilter
 373 @li @c writerfilter.profile - load times of filters
 374
 375 @section writerperfect
 376
 377 @li @c writerperfect
 378
 379 @section xmloff
 380
 381 @li @c xmloff
 382 @li @c xmloff.chart
 383 @li @c xmloff.core
 384 @li @c xmloff.draw
 385 @li @c xmloff.forms
 386 @li @c xmloff.style
 387 @li @c xmloff.text
 388 @li @c xmloff.transform
 389
 390 @section xmlsecurity
 391
 392 @li @c xmlsecurity.dialogs - xml security dialogs
 393 @li @c xmlsecurity.helper
 394 @li @c xmlsecurity.xmlsec - xmlsec wrapper
 395
 396 @section xmlscript
 397
 398 @li @c xmlscript.xmldlg
 399 @li @c xmlscript.xmlflat
 400 @li @c xmlscript.xmlhelper
 401 @li @c xmlscript.xmllib
 402 @li @c xmlscript.xmlmod
 403
 404 @section dbaccess
 405
 406 @li @c dbaccess
 407 @li @c dbaccess.ui
 408 @li @c dbaccess.ui.OGeneralPage
 409
 410 @section svx
 411
 412 @li @c svx
 413 @li @c svx.fmcmop
 414
 415 @section other
 416
 417 @li @c accessibility
 418 @li @c avmedia
 419 @li @c basebmp
 420 @li @c binaryurp
 421 @li @c bridges
 422 @li @c configmgr
 423 @li @c cppcanvas
 424 @li @c cppcanvas.emf
 425 @li @c cppu
 426 @li @c cppuhelper
 427 @li @c helpcompiler
 428 @li @c linguistic
 429 @li @c oox
 430 @li @c reportdesign
 431 @li @c rsc
 432 @li @c sax
 433 @li @c shell
 434 @li @c stoc
 435 @li @c svg
 436 @li @c ucbhelper
 437 @li @c unoidl
 438 @li @c unoxml
 439 @li @c uui
 440 @li @c vbahelper
 441 @li @c xmlhelp
 442 @li @c xmlreader
 443
 444 */
 445 /* vim:set ft=cpp shiftwidth=4 softtabstop=4 expandtab: */