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.cppunittester
  25 @li @c sal.debug - SAL debugging functionality
  26 @li @c sal.file - file system operations
  27 @li @c sal.fileio - file I/O
  28 @li @c sal.osl - SAL OSL library
  29 @li @c sal.osl.condition
  30 @li @c sal.osl.mutex
  31 @li @c sal.osl.pipe
  32 @li @c sal.rtl - SAL RTL library
  33 @li @c sal.textenc - the textencoding SAL library
  34
  35 @section basctl
  36
  37 @li @c basctl
  38 @li @c basctl.basicide
  39
  40 @section basic
  41
  42 @li @c basic
  43 @li @c basic.sbx
  44
  45 @section bridges
  46
  47 @li @c bridges
  48 @li @c bridges.ios
  49 @li @c bridges.osx
  50
  51 @section canvas
  52
  53 @li @c canvas
  54 @li @c canvas.cairo
  55 @li @c canvas.directx
  56 @li @c canvas.null
  57 @li @c canvas.ogl
  58 @li @c canvas.vcl
  59
  60 @section chart2
  61
  62 @li @c chart2
  63 @li @c chart2.accessibility
  64 @li @c chart2.areachart
  65 @li @c chart2.main
  66 @li @c chart2.pie.label.bestfit
  67 @li @c chart2.pie.label.bestfit.inside
  68 @li @c chart2.template
  69 @li @c chart2.tools
  70
  71 @section connectivity
  72
  73 @li @c connectivity.ado
  74 @li @c connectivity.commontools
  75 @li @c connectivity.cpool
  76 @li @c connectivity.dbase
  77 @li @c connectivity.drivers - a bit overly general, maybe it should be removed?
  78 @li @c connectivity.evoab2
  79 @li @c connectivity.firebird
  80 @li @c connectivity.flat
  81 @li @c connectivity.hsqldb
  82 @li @c connectivity.jdbc
  83 @li @c connectivity.kab
  84 @li @c connectivity.macab
  85 @li @c connectivity.manager
  86 @li @c connectivity.mozab
  87 @li @c connectivity.mysqlc
  88 @li @c connectivity.odbc
  89 @li @c connectivity.parse
  90 @li @c connectivity.postgresql
  91 @li @c connectivity.resource
  92 @li @c connectivity.writer
  93
  94 @section comphelper
  95
  96 @li @c comphelper
  97 @li @c comphelper.backupfilehelper
  98 @li @c comphelper.container - EmbeddedObjectContainer
  99 @li @c comphelper.crypto
 100 @li @c comphelper.lok
 101 @li @c comphelper.traceevent
 102
 103 @section cppu
 104
 105 @li @c cppu
 106 @li @c cppu.affinebridge
 107 @li @c cppu.log
 108 @li @c cppu.purpenv
 109 @li @c cppu.threadpool
 110 @li @c cppu.typelib
 111 @li @c cppu.unsafebridge
 112
 113 @section cppuhelper
 114
 115 @li @c cppuhelper
 116 @li @c cppuhelper.shlib
 117
 118 @section cpputools
 119
 120 @li @c cpputools
 121 @li @c cpputools.unoexe
 122
 123 @section cui
 124
 125 @li @c cui.customize
 126 @li @c cui.customnotebookbar
 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 @li @c drawinglayer.emf
 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.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.hwp - Hangul word processor import
 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.psd
 238 @li @c filter.ras
 239 @li @c filter.svg
 240 @li @c filter.tga
 241 @li @c filter.tiff
 242 @li @c filter.xmlfa
 243 @li @c filter.xmlfd
 244 @li @c filter.xslt - xslt import/export
 245
 246 @section oox
 247
 248 @li @c oox
 249 @li @c oox.chart
 250 @li @c oox.cscode - see oox/source/drawingml/customshapes/README
 251 @li @c oox.csdata - see oox/source/drawingml/customshapes/README
 252 @li @c oox.drawingml - DrawingML
 253 @li @c oox.drawingml.gradient
 254 @li @c oox.ppt - pptx filter
 255 @li @c oox.shape
 256 @li @c oox.storage - ZipStorage class
 257 @li @c oox.vml - VML
 258 @li @c oox.xmlstream - XmlStream class
 259
 260 @section forms
 261
 262 @li @c forms.component
 263 @li @c forms.helper
 264 @li @c forms.misc
 265 @li @c forms.richtext
 266 @li @c forms.runtime
 267 @li @c forms.xforms
 268
 269 @section formula
 270
 271 @li @c formula.core
 272 @li @c formula.ui
 273
 274 @section fpicker
 275
 276 @li @c fpicker
 277 @li @c fpicker.aqua
 278 @li @c fpicker.office
 279
 280 @section framework
 281
 282 @li @c fwk - framework (abbreviation)
 283 @li @c fwk.accelerators
 284 @li @c fwk.autorecovery
 285 @li @c fwk.desktop
 286 @li @c fwk.dispatch
 287 @li @c fwk.frame
 288 @li @c fwk.joburl
 289 @li @c fwk.loadenv
 290 @li @c fwk.session
 291 @li @c fwk.session.debug
 292 @li @c fwk.uiconfiguration
 293 @li @c fwk.uielement
 294
 295 @section i18nlangtag
 296
 297 @li @c i18nlangtag - language tags
 298
 299 @section i18npool
 300
 301 @li @c i18npool - general i18npool
 302
 303 @section i18n
 304
 305 @li @c i18n - module independent i18n related, e.g. language tag usage
 306
 307 @section io
 308
 309 @li @c io.connector
 310 @li @c io.streams
 311
 312 @section jvmfwk
 313
 314 @li @c jfw
 315 @li @c jfw.level1
 316 @li @c jfw.level2
 317
 318 @section LanguageTool
 319
 320 @li @c languagetool
 321
 322 @section LibreOfficeKit
 323
 324 @li @c lok
 325 @li @c lok.fontsubst
 326 @li @c lok.tiledrendering
 327 @li @c lok.dialog
 328 @li @c lok.a11y - LOK accessibility
 329
 330 @section l10ntools
 331
 332 @li @c l10ntools
 333
 334 @section Math
 335
 336 @li @c starmath
 337 @li @c starmath.ooxml - OOXML import/export
 338 @li @c starmath.rtf
 339 @li @c starmath.wordbase
 340
 341 @section package
 342
 343 @li @c package
 344 @li @c package.xstor
 345 @li @c package.threadeddeflate
 346
 347 @section sdext
 348
 349 @li @c sdext
 350 @li @c sdext.minimizer
 351 @li @c sdext.pdfimport
 352 @li @c sdext.pdfimport.pdfparse
 353 @li @c sdext.presenter
 354
 355 @section sfx
 356
 357 @li @c sfx
 358 @li @c sfx.appl
 359 @li @c sfx.bastyp
 360 @li @c sfx.config
 361 @li @c sfx.control
 362 @li @c sfx.dialog
 363 @li @c sfx.doc
 364 @li @c sfx.notify
 365 @li @c sfx.sidebar
 366 @li @c sfx.view
 367
 368 @section slideshow
 369
 370 @li @c slideshow
 371 @li @c slideshow.eventqueue
 372 @li @c slideshow.opengl
 373 @li @c slideshow.verbose
 374
 375 @section sot
 376
 377 @li @c sot - COM structured storage
 378
 379 @section svl
 380
 381 @li @c svl
 382 @li @c svl.crypto
 383 @li @c svl.items
 384 @li @c svl.numbers
 385
 386 @section svtools
 387
 388 @li @c svtools
 389 @li @c svtools.config
 390 @li @c svtools.contnr
 391 @li @c svtools.control
 392 @li @c svtools.dialogs
 393 @li @c svtools.misc
 394 @li @c svtools.table
 395 @li @c svtools.uno
 396
 397 @section svx
 398
 399 @li @c svx
 400 @li @c svx.chaining
 401 @li @c svx.diagram - Diagram ModelData
 402 @li @c svx.dialog
 403 @li @c svx.fmcomp
 404 @li @c svx.form
 405 @li @c svx.sdr
 406 @li @c svx.sidebar
 407 @li @c svx.stbcrtls - StatusBarControl
 408 @li @c svx.svdraw
 409 @li @c svx.table
 410 @li @c svx.tbxcrtls - ToolboxControl
 411 @li @c svx.uno
 412
 413 @section toolkit
 414
 415 @li @c toolkit
 416 @li @c toolkit.controls
 417 @li @c toolkit.helper
 418
 419 @section tools
 420
 421 @li @c tools
 422 @li @c tools.datetime
 423 @li @c tools.debug
 424 @li @c tools.fraction
 425 @li @c tools.generic
 426 @li @c tools.memtools
 427 @li @c tools.rc - resource manager
 428 @li @c tools.stream - SvStream class
 429 @li @c tools.urlobj - INetURLObject class
 430
 431 @section ucb
 432
 433 @li @c ucb
 434 @li @c ucb.core
 435 @li @c ucb.ucp
 436 @li @c ucb.ucp.cmis
 437 @li @c ucb.ucp.ext
 438 @li @c ucb.ucp.file
 439 @li @c ucb.ucp.ftp
 440 @li @c ucb.ucp.gio
 441 @li @c ucb.ucp.tdoc
 442 @li @c ucb.ucp.webdav
 443 @li @c ucb.ucp.webdav.curl
 444
 445 @section unotools
 446
 447 @li @c unotools
 448 @li @c unotools.config
 449 @li @c unotools.i18n
 450 @li @c unotools.misc
 451 @li @c unotools.ucbhelper
 452
 453 @section URE
 454
 455 @li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
 456 @li @c salhelper.thread - ::salhelper::Thread class
 457
 458 @section sax
 459
 460 @li @c sax.cppunit
 461 @li @c sax.fastparser
 462
 463 @section stoc
 464
 465 @li @c stoc.corerefl - CoreReflection
 466 @li @c stoc.java - javaloader and javavm
 467
 468 @section VCL
 469
 470 @li @c vcl
 471 @li @c vcl.a11y
 472 @li @c vcl.app
 473 @li @c vcl.builder
 474 @li @c vcl.control
 475 @li @c vcl.ct - CoreText-using code for macOS and iOS
 476 @li @c vcl.debugevent
 477 @li @c vcl.driver Graphics driver handling
 478 @li @c vcl.emf - EMF/EMF+ processing
 479 @li @c vcl.eventtesting
 480 @li @c vcl.filter
 481 @li @c vcl.filter.webp
 482 @li @c vcl.fonts - font-specific code
 483 @li @c vcl.fonts.detail
 484 @li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
 485 @li @c vcl.gdi.wndproc - Windows Procedure part of VCL
 486 @li @c vcl.gdi.fontmetric
 487 @li @c vcl.gtk - Gtk+ 2/3 plugin
 488 @li @c vcl.gtk3
 489 @li @c vcl.gtkkde5
 490 @li @c vcl.harfbuzz - HarfBuzz text layout
 491 @li @c vcl.headless - bitmap-based backend
 492 @li @c vcl.helper
 493 @li @c vcl.icontest
 494 @li @c vcl.ios.clipboard
 495 @li @c vcl.kf5 - KF5
 496 @li @c vcl.layout - Widget layout
 497 @li @c vcl.lazydelete
 498 @li @c vcl.opengl
 499 @li @c vcl.opengl.qt - Qt OpenGL
 500 @li @c vcl.osx
 501 @li @c vcl.osx.clipboard
 502 @li @c vcl.osx.print
 503 @li @c vcl.pdfwriter
 504 @li @c vcl.print
 505 @li @c vcl.plugadapt - the Unix/X11 backend plugin mechanism
 506 @li @c vcl.qt - Qt
 507 @li @c vcl.quartz
 508 @li @c vcl.schedule - scheduler / main-loop information
 509 @li @c vcl.schedule.deinit
 510 @li @c vcl.sessioninhibitor
 511 @li @c vcl.scrollbar - Scroll Bars
 512 @li @c vcl.se - VCL Session Manager
 513 @li @c vcl.se.debug
 514 @li @c vcl.skia - VCL Skia-based code
 515 @li @c vcl.skia.trace - tracing drawing in VCL Skia-based code
 516 @li @c vcl.sm - Session Manager Client
 517 @li @c vcl.sm.debug
 518 @li @c vcl.uitest - The UI testing framework code
 519 @li @c vcl.unity
 520 @li @c vcl.unx.dtrans
 521 @li @c vcl.unx.freetype
 522 @li @c vcl.unx.print
 523 @li @c vcl.virdev
 524 @li @c vcl.watchdog
 525 @li @c vcl.window
 526 @li @c vcl.win.dtrans
 527
 528 @section winaccessibility
 529
 530 @li @c iacc2 - IAccessible2 bridge debug
 531
 532 @section Writer
 533
 534 @li @c sw
 535 @li @c sw.a11y - accessibility
 536 @li @c sw.calc - formula calculation
 537 @li @c sw.core - Writer core
 538 @li @c sw.createcopy
 539 @li @c sw.doc
 540 @li @c sw.docappend
 541 @li @c sw.docx
 542 @li @c sw.envelp
 543 @li @c sw.filter
 544 @li @c sw.html - Writer HTML import/export
 545 @li @c sw.idle
 546 @li @c sw.layout - Writer core view: document layout
 547 @li @c sw.layout.debug - Writer layout dbg_lay output
 548 @li @c sw.mailmerge - Writer mail merge
 549 @li @c sw.pageframe - debug lifecycle of SwPageFrame
 550 @li @c sw.qa
 551 @li @c sw.rtf - .rtf export filter
 552 @li @c sw.tiled
 553 @li @c sw.ui
 554 @li @c sw.uno - Writer UNO interfaces
 555 @li @c sw.vba - Writer VBA
 556 @li @c sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
 557 @li @c sw.ww8.level2 - further info for sw.ww8
 558 @li @c sw.xml - Writer .odt import/export
 559
 560 @section writerfilter
 561
 562 @li @c writerfilter
 563 @li @c writerfilter.dmapper
 564 @li @c writerfilter.ooxml
 565 @li @c writerfilter.profile - load times of filters
 566 @li @c writerfilter.rtf
 567
 568 @section writerperfect
 569
 570 @li @c writerperfect
 571
 572 @section xmloff
 573
 574 @li @c xmloff
 575 @li @c xmloff.chart
 576 @li @c xmloff.core
 577 @li @c xmloff.draw
 578 @li @c xmloff.forms
 579 @li @c xmloff.style
 580 @li @c xmloff.table
 581 @li @c xmloff.text
 582 @li @c xmloff.transform
 583
 584 @section xmlsecurity
 585
 586 @li @c xmlsecurity.comp - xml security component
 587 @li @c xmlsecurity.dialogs - xml security dialogs
 588 @li @c xmlsecurity.helper
 589 @li @c xmlsecurity.ooxml - OOXML signature support
 590 @li @c xmlsecurity.qa
 591 @li @c xmlsecurity.workben
 592 @li @c xmlsecurity.xmlsec - xmlsec wrapper
 593 @li @c xmlsecurity.xmlsec.gpg - gpg xmlsec component
 594
 595 @section xmlscript
 596
 597 @li @c xmlscript.xmldlg
 598 @li @c xmlscript.xmlflat
 599 @li @c xmlscript.xmlhelper
 600 @li @c xmlscript.xmllib
 601 @li @c xmlscript.xmlmod
 602
 603 @section dbaccess
 604
 605 @li @c dbaccess
 606 @li @c dbaccess.core
 607 @li @c dbaccess.ui
 608 @li @c dbaccess.ui.generalpage
 609
 610 @section avmedia
 611
 612 @li @c avmedia
 613 @li @c avmedia.gstreamer
 614 @li @c avmedia.gtk
 615 @li @c avmedia.quicktime
 616
 617 @section other
 618
 619 @li @c accessibility
 620 @li @c animations
 621 @li @c basegfx
 622 @li @c binaryurp
 623 @li @c cli
 624 @li @c configmgr
 625 @li @c configmgr.dconf
 626 @li @c cppcanvas
 627 @li @c cppcanvas.emf
 628 @li @c helpcompiler
 629 @li @c idl
 630 @li @c javaunohelper
 631 @li @c jvmaccess
 632 @li @c lingucomponent
 633 @li @c linguistic
 634 @li @c lwp - lotuswordpro
 635 @li @c opencl
 636 @li @c opencl.device
 637 @li @c opencl.file
 638 @li @c registry
 639 @li @c reportdesign
 640 @li @c rsc
 641 @li @c sax
 642 @li @c scripting
 643 @li @c scripting.provider
 644 @li @c shell
 645 @li @c shell.jumplist
 646 @li @c stoc
 647 @li @c store
 648 @li @c svg
 649 @li @c svgio
 650 @li @c test
 651 @li @c ucbhelper
 652 @li @c unodevtools
 653 @li @c unoidl
 654 @li @c unoxml
 655 @li @c uui
 656 @li @c vbahelper
 657 @li @c wasm
 658 @li @c xmlhelp
 659 @li @c xmlreader
 660
 661 */
 662 /* vim:set ft=cpp shiftwidth=4 softtabstop=4 expandtab: */