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