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