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 - file system operations
  26 @li @c sal.fileio - file I/O
  27 @li @c sal.osl - SAL OSL library
  28 @li @c sal.osl.condition
  29 @li @c sal.osl.mutex
  30 @li @c sal.osl.pipe
  31 @li @c sal.rtl - SAL RTL library
  32 @li @c sal.textenc - the textencoding SAL library
  33
  34 @section basctl
  35
  36 @li @c basctl
  37 @li @c basctl.basicide
  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.accessibility
  64 @li @c chart2.areachart
  65 @li @c chart2.main
  66 @li @c chart2.opengl
  67 @li @c chart2.pie.label.bestfit
  68 @li @c chart2.pie.label.bestfit.inside
  69 @li @c chart2.template
  70 @li @c chart2.tools
  71
  72 @section connectivity
  73
  74 @li @c connectivity.ado
  75 @li @c connectivity.commontools
  76 @li @c connectivity.cpool
  77 @li @c connectivity.dbase
  78 @li @c connectivity.drivers - a bit overly general, maybe it should be removed?
  79 @li @c connectivity.evoab2
  80 @li @c connectivity.firebird
  81 @li @c connectivity.flat
  82 @li @c connectivity.hsqldb
  83 @li @c connectivity.jdbc
  84 @li @c connectivity.kab
  85 @li @c connectivity.macab
  86 @li @c connectivity.manager
  87 @li @c connectivity.mork
  88 @li @c connectivity.mozab
  89 @li @c connectivity.mysqlc
  90 @li @c connectivity.odbc
  91 @li @c connectivity.parse
  92 @li @c connectivity.postgresql
  93 @li @c connectivity.resource
  94 @li @c connectivity.writer
  95
  96 @section comphelper
  97
  98 @li @c comphelper
  99 @li @c comphelper.backupfilehelper
 100 @li @c comphelper.container - EmbeddedObjectContainer
 101 @li @c comphelper.crypto
 102 @li @c comphelper.lok
 103
 104 @section cppu
 105
 106 @li @c cppu
 107 @li @c cppu.affinebridge
 108 @li @c cppu.log
 109 @li @c cppu.purpenv
 110 @li @c cppu.threadpool
 111 @li @c cppu.typelib
 112 @li @c cppu.unsafebridge
 113
 114 @section cppuhelper
 115
 116 @li @c cppuhelper
 117 @li @c cppuhelper.shlib
 118
 119 @section cpputools
 120
 121 @li @c cpputools
 122 @li @c cpputools.unoexe
 123
 124 @section cui
 125
 126 @li @c cui.customize
 127 @li @c cui.customnotebookbar
 128 @li @c cui.dialogs
 129 @li @c cui.factory
 130 @li @c cui.options
 131 @li @c cui.tabpages
 132
 133 @section drawinglayer
 134
 135 @li @c drawinglayer
 136
 137 @section emfio
 138
 139 @li @c emfio - EMF and VMF image file formats import module
 140
 141 @section Calc
 142
 143 @li @c sc
 144 @li @c sc.core
 145 @li @c sc.core.formulacell - ScFormulaCell and group
 146 @li @c sc.core.formulagroup
 147 @li @c sc.core.grouparealistener - sc::FormulaGroupAreaListener
 148 @li @c sc.filter - Calc filter
 149 @li @c sc.lok.docsize
 150 @li @c sc.lok.header
 151 @li @c sc.lok.poshelper
 152 @li @c sc.opencl - OpenCL-related stuff in general
 153 @li @c sc.opencl.source - Generated OpenCL source code
 154 @li @c sc.orcus
 155 @li @c sc.orcus.autofilter
 156 @li @c sc.orcus.condformat
 157 @li @c sc.orcus.style
 158 @li @c sc.orcus.table
 159 @li @c sc.qa
 160 @li @c sc.threaded
 161 @li @c sc.timing
 162 @li @c sc.ui - Calc UI
 163 @li @c sc.uitest - Calc UI Test part
 164 @li @c sc.viewdata
 165
 166 @section desktop
 167
 168 @li @c desktop
 169 @li @c desktop.app
 170 @li @c desktop.deployment
 171 @li @c desktop.lib
 172 @li @c desktop.migration
 173 @li @c desktop.offacc
 174 @li @c desktop.opengl
 175 @li @c desktop.splash
 176 @li @c desktop.test
 177 @li @c desktop.updater
 178
 179 @section Draw
 180
 181 @li @c sd
 182 @li @c sd.core
 183 @li @c sd.eppt
 184 @li @c sd.filter
 185 @li @c sd.fwk
 186 @li @c sd.slideshow
 187 @li @c sd.sls - slidesorter
 188 @li @c sd.tools
 189 @li @c sd.transitions
 190 @li @c sd.ui
 191 @li @c sd.view
 192 @li @c sdremote
 193 @li @c sdremote.bluetooth
 194 @li @c sdremote.wifi
 195
 196 @section editeng
 197
 198 @li @c editeng
 199 @li @c editeng.chaining
 200 @li @c editeng.items
 201
 202 @section embeddedobj
 203
 204 @li @c embeddedobj - embedded objects
 205 @li @c embeddedobj.common
 206 @li @c embeddedobj.general
 207 @li @c embeddedobj.ole - OLE embedded objects
 208
 209 @section embedserv
 210 @li @c embedserv - embedding server
 211 @li @c embedserv.ole - OLE server
 212
 213 @section extensions
 214
 215 @li @c extensions.abpilot
 216 @li @c extensions.biblio
 217 @li @c extensions.config
 218 @li @c extensions.dbpilots
 219 @li @c extensions.evoab
 220 @li @c extensions.logging
 221 @li @c extensions.olebridge - OLE automation bridge
 222 @li @c extensions.plugin
 223 @li @c extensions.propctrlr
 224 @li @c extensions.scanner
 225 @li @c extensions.update
 226
 227 @section Filter
 228
 229 @li @c filter.config
 230 @li @c filter.eps
 231 @li @c filter.icgm
 232 @li @c filter.ms - escher import/export
 233 @li @c filter.odfflatxml
 234 @li @c filter.os2met
 235 @li @c filter.pdf
 236 @li @c filter.pict
 237 @li @c filter.ras
 238 @li @c filter.svg
 239 @li @c filter.tga
 240 @li @c filter.tiff
 241 @li @c filter.xmlfa
 242 @li @c filter.xmlfd
 243 @li @c filter.xslt - xslt import/export
 244
 245 @section oox
 246
 247 @li @c oox
 248 @li @c oox.chart
 249 @li @c oox.cscode - see oox/source/drawingml/customshapes/README
 250 @li @c oox.csdata - see oox/source/drawingml/customshapes/README
 251 @li @c oox.drawingml - DrawingML
 252 @li @c oox.drawingml.gradient
 253 @li @c oox.ppt - pptx filter
 254 @li @c oox.shape
 255 @li @c oox.storage - ZipStorage class
 256 @li @c oox.vml - VML
 257 @li @c oox.xmlstream - XmlStream class
 258
 259 @section forms
 260
 261 @li @c forms.component
 262 @li @c forms.helper
 263 @li @c forms.misc
 264 @li @c forms.richtext
 265 @li @c forms.runtime
 266 @li @c forms.xforms
 267
 268 @section formula
 269
 270 @li @c formula.core
 271 @li @c formula.ui
 272
 273 @section fpicker
 274
 275 @li @c fpicker
 276 @li @c fpicker.aqua
 277 @li @c fpicker.office
 278
 279 @section framework
 280
 281 @li @c fwk - framework (abbreviation)
 282 @li @c fwk.accelerators
 283 @li @c fwk.autorecovery
 284 @li @c fwk.desktop
 285 @li @c fwk.dispatch
 286 @li @c fwk.frame
 287 @li @c fwk.joburl
 288 @li @c fwk.loadenv
 289 @li @c fwk.session
 290 @li @c fwk.session.debug
 291 @li @c fwk.uiconfiguration
 292 @li @c fwk.uielement
 293
 294 @section i18nlangtag
 295
 296 @li @c i18nlangtag - language tags
 297
 298 @section i18npool
 299
 300 @li @c i18npool - general i18npool
 301
 302 @section i18n
 303
 304 @li @c i18n - module independent i18n related, e.g. language tag usage
 305
 306 @section io
 307
 308 @li @c io.connector
 309 @li @c io.streams
 310
 311 @section jvmfwk
 312
 313 @li @c jfw
 314 @li @c jfw.level1
 315 @li @c jfw.level2
 316
 317 @section LibreOfficeKit
 318
 319 @li @c lok
 320 @li @c lok.tiledrendering
 321 @li @c lok.dialog
 322
 323 @section l10ntools
 324
 325 @li @c l10ntools
 326
 327 @section Math
 328
 329 @li @c starmath
 330 @li @c starmath.ooxml - OOXML import/export
 331 @li @c starmath.rtf
 332 @li @c starmath.wordbase
 333
 334 @section package
 335
 336 @li @c package
 337 @li @c package.xstor
 338 @li @c package.threadeddeflate
 339
 340 @section sdext
 341
 342 @li @c sdext
 343 @li @c sdext.minimizer
 344 @li @c sdext.pdfimport
 345 @li @c sdext.pdfimport.pdfparse
 346 @li @c sdext.presenter
 347
 348 @section sfx
 349
 350 @li @c sfx
 351 @li @c sfx.appl
 352 @li @c sfx.bastyp
 353 @li @c sfx.config
 354 @li @c sfx.control
 355 @li @c sfx.dialog
 356 @li @c sfx.doc
 357 @li @c sfx.notify
 358 @li @c sfx.sidebar
 359 @li @c sfx.view
 360
 361 @section slideshow
 362
 363 @li @c slideshow
 364 @li @c slideshow.eventqueue
 365 @li @c slideshow.opengl
 366 @li @c slideshow.verbose
 367
 368 @section sot
 369
 370 @li @c sot - COM structured storage
 371
 372 @section svl
 373
 374 @li @c svl
 375 @li @c svl.crypto
 376 @li @c svl.items
 377 @li @c svl.numbers
 378
 379 @section svtools
 380
 381 @li @c svtools
 382 @li @c svtools.config
 383 @li @c svtools.contnr
 384 @li @c svtools.control
 385 @li @c svtools.dialogs
 386 @li @c svtools.misc
 387 @li @c svtools.table
 388 @li @c svtools.uno
 389
 390 @section svx
 391
 392 @li @c svx
 393 @li @c svx.chaining
 394 @li @c svx.dialog
 395 @li @c svx.fmcomp
 396 @li @c svx.form
 397 @li @c svx.opengl
 398 @li @c svx.sdr
 399 @li @c svx.sidebar
 400 @li @c svx.stbcrtls - StatusBarControl
 401 @li @c svx.svdraw
 402 @li @c svx.table
 403 @li @c svx.tbxcrtls - ToolboxControl
 404 @li @c svx.uno
 405
 406 @section toolkit
 407
 408 @li @c toolkit
 409 @li @c toolkit.controls
 410 @li @c toolkit.helper
 411
 412 @section tools
 413
 414 @li @c tools
 415 @li @c tools.datetime
 416 @li @c tools.debug
 417 @li @c tools.fraction
 418 @li @c tools.generic
 419 @li @c tools.memtools
 420 @li @c tools.rc - resource manager
 421 @li @c tools.stream - SvStream class
 422 @li @c tools.urlobj - INetURLObject class
 423
 424 @section ucb
 425
 426 @li @c ucb
 427 @li @c ucb.core
 428 @li @c ucb.ucp
 429 @li @c ucb.ucp.cmis
 430 @li @c ucb.ucp.ext
 431 @li @c ucb.ucp.file
 432 @li @c ucb.ucp.ftp
 433 @li @c ucb.ucp.gio
 434 @li @c ucb.ucp.webdav
 435
 436 @section unotools
 437
 438 @li @c unotools
 439 @li @c unotools.config
 440 @li @c unotools.i18n
 441 @li @c unotools.misc
 442 @li @c unotools.ucbhelper
 443
 444 @section URE
 445
 446 @li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
 447 @li @c salhelper.thread - ::salhelper::Thread class
 448
 449 @section sax
 450
 451 @li @c sax.cppunit
 452 @li @c sax.fastparser
 453
 454 @section stoc
 455
 456 @li @c stoc.corerefl - CoreReflection
 457
 458 @section VCL
 459
 460 @li @c vcl
 461 @li @c vcl.a11y
 462 @li @c vcl.app
 463 @li @c vcl.builder
 464 @li @c vcl.control
 465 @li @c vcl.ct - CoreText-using code for macOS and iOS
 466 @li @c vcl.debugevent
 467 @li @c vcl.driver Graphics driver handling
 468 @li @c vcl.emf - EMF/EMF+ processing
 469 @li @c vcl.eventtesting
 470 @li @c vcl.filter
 471 @li @c vcl.fonts - font-specific code
 472 @li @c vcl.fonts.detail
 473 @li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
 474 @li @c vcl.gdi.wndproc - Windows Procedure part of VCL
 475 @li @c vcl.gdi.fontmetric
 476 @li @c vcl.gtk - Gtk+ 2/3 plugin
 477 @li @c vcl.gtk3
 478 @li @c vcl.gtkkde5
 479 @li @c vcl.harfbuzz - HarfBuzz text layout
 480 @li @c vcl.headless - bitmap-based backend
 481 @li @c vcl.helper
 482 @li @c vcl.icontest
 483 @li @c vcl.ios.clipboard
 484 @li @c vcl.kf5 - KF5
 485 @li @c vcl.layout - Widget layout
 486 @li @c vcl.lazydelete
 487 @li @c vcl.opengl
 488 @li @c vcl.opengl.qt5 - QT5 OpenGL
 489 @li @c vcl.osx
 490 @li @c vcl.osx.clipboard
 491 @li @c vcl.osx.print
 492 @li @c vcl.pdfwriter
 493 @li @c vcl.plugadapt - the Unix/X11 backend plugin mechanism
 494 @li @c vcl.qt5 - QT5
 495 @li @c vcl.quartz
 496 @li @c vcl.schedule - scheduler / main-loop information
 497 @li @c vcl.schedule.deinit
 498 @li @c vcl.screensaverinhibitor
 499 @li @c vcl.scrollbar - Scroll Bars
 500 @li @c vcl.se - VCL Session Manager
 501 @li @c vcl.se.debug
 502 @li @c vcl.skia - VCL Skia-based code
 503 @li @c vcl.skia.trace - tracing drawing in VCL Skia-based code
 504 @li @c vcl.sm - Session Manager Client
 505 @li @c vcl.sm.debug
 506 @li @c vcl.uitest - The UI testing framework code
 507 @li @c vcl.unity
 508 @li @c vcl.unx.dtrans
 509 @li @c vcl.unx.print
 510 @li @c vcl.virdev
 511 @li @c vcl.watchdog
 512 @li @c vcl.window
 513 @li @c vcl.wmf
 514
 515 @section winaccessibility
 516
 517 @li @c iacc2 - IAccessible2 bridge debug
 518
 519 @section Writer
 520
 521 @li @c sw
 522 @li @c sw.a11y - accessibility
 523 @li @c sw.calc - formula calculation
 524 @li @c sw.core - Writer core
 525 @li @c sw.createcopy
 526 @li @c sw.doc
 527 @li @c sw.docappend
 528 @li @c sw.docx
 529 @li @c sw.envelp
 530 @li @c sw.filter
 531 @li @c sw.html - Writer HTML import/export
 532 @li @c sw.idle
 533 @li @c sw.layout - Writer core view: document layout
 534 @li @c sw.layout.debug - Writer layout dbg_lay output
 535 @li @c sw.level2
 536 @li @c sw.mailmerge - Writer mail merge
 537 @li @c sw.pageframe - debug lifecycle of SwPageFrame
 538 @li @c sw.rtf - .rtf export filter
 539 @li @c sw.tiled
 540 @li @c sw.ui
 541 @li @c sw.uno - Writer UNO interfaces
 542 @li @c sw.vba - Writer VBA
 543 @li @c sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
 544 @li @c sw.ww8.level2 - further info for sw.ww8
 545 @li @c sw.xml - Writer .odt import/export
 546
 547 @section writerfilter
 548
 549 @li @c writerfilter
 550 @li @c writerfilter.dmapper
 551 @li @c writerfilter.ooxml
 552 @li @c writerfilter.profile - load times of filters
 553 @li @c writerfilter.rtf
 554
 555 @section writerperfect
 556
 557 @li @c writerperfect
 558
 559 @section xmloff
 560
 561 @li @c xmloff
 562 @li @c xmloff.chart
 563 @li @c xmloff.core
 564 @li @c xmloff.draw
 565 @li @c xmloff.forms
 566 @li @c xmloff.style
 567 @li @c xmloff.table
 568 @li @c xmloff.text
 569 @li @c xmloff.transform
 570
 571 @section xmlsecurity
 572
 573 @li @c xmlsecurity.comp - xml security component
 574 @li @c xmlsecurity.dialogs - xml security dialogs
 575 @li @c xmlsecurity.helper
 576 @li @c xmlsecurity.ooxml - OOXML signature support
 577 @li @c xmlsecurity.qa
 578 @li @c xmlsecurity.workben
 579 @li @c xmlsecurity.xmlsec - xmlsec wrapper
 580 @li @c xmlsecurity.xmlsec.gpg - gpg xmlsec component
 581
 582 @section xmlscript
 583
 584 @li @c xmlscript.xmldlg
 585 @li @c xmlscript.xmlflat
 586 @li @c xmlscript.xmlhelper
 587 @li @c xmlscript.xmllib
 588 @li @c xmlscript.xmlmod
 589
 590 @section dbaccess
 591
 592 @li @c dbaccess
 593 @li @c dbaccess.core
 594 @li @c dbaccess.ui
 595 @li @c dbaccess.ui.generalpage
 596
 597 @section avmedia
 598
 599 @li @c avmedia
 600 @li @c avmedia.gstreamer
 601 @li @c avmedia.opengl - OpenGL models
 602 @li @c avmedia.quicktime
 603
 604 @section other
 605
 606 @li @c accessibility
 607 @li @c animations
 608 @li @c basegfx
 609 @li @c binaryurp
 610 @li @c cli
 611 @li @c configmgr
 612 @li @c configmgr.dconf
 613 @li @c cppcanvas
 614 @li @c cppcanvas.emf
 615 @li @c dtrans
 616 @li @c helpcompiler
 617 @li @c idl
 618 @li @c javaunohelper
 619 @li @c jvmaccess
 620 @li @c lingucomponent
 621 @li @c linguistic
 622 @li @c lwp - lotuswordpro
 623 @li @c opencl
 624 @li @c opencl.device
 625 @li @c opencl.file
 626 @li @c registry
 627 @li @c reportdesign
 628 @li @c rsc
 629 @li @c sax
 630 @li @c scripting
 631 @li @c scripting.provider
 632 @li @c shell
 633 @li @c stoc
 634 @li @c store
 635 @li @c svg
 636 @li @c svgio
 637 @li @c test
 638 @li @c ucbhelper
 639 @li @c unodevtools
 640 @li @c unoidl
 641 @li @c unoxml
 642 @li @c uui
 643 @li @c vbahelper
 644 @li @c xmlhelp
 645 @li @c xmlreader
 646
 647 */
 648 /* vim:set ft=cpp shiftwidth=4 softtabstop=4 expandtab: */