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.startuptime - Log area for start up measurement time
 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 @li @c editeng.quicktextsize
 202
 203 @section embeddedobj
 204
 205 @li @c embeddedobj - embedded objects
 206 @li @c embeddedobj.common
 207 @li @c embeddedobj.general
 208 @li @c embeddedobj.ole - OLE embedded objects
 209
 210 @section embedserv
 211 @li @c embedserv - embedding server
 212 @li @c embedserv.ole - OLE server
 213
 214 @section extensions
 215
 216 @li @c extensions.abpilot
 217 @li @c extensions.biblio
 218 @li @c extensions.config
 219 @li @c extensions.dbpilots
 220 @li @c extensions.evoab
 221 @li @c extensions.logging
 222 @li @c extensions.olebridge - OLE automation bridge
 223 @li @c extensions.plugin
 224 @li @c extensions.propctrlr
 225 @li @c extensions.scanner
 226 @li @c extensions.update
 227
 228 @section Filter
 229
 230 @li @c filter.config
 231 @li @c filter.eps
 232 @li @c filter.hwp - Hangul word processor import
 233 @li @c filter.icgm
 234 @li @c filter.ms - escher import/export
 235 @li @c filter.odfflatxml
 236 @li @c filter.os2met
 237 @li @c filter.pdf
 238 @li @c filter.pict
 239 @li @c filter.psd
 240 @li @c filter.ras
 241 @li @c filter.svg
 242 @li @c filter.tga
 243 @li @c filter.tiff
 244 @li @c filter.xmlfa
 245 @li @c filter.xmlfd
 246 @li @c filter.xslt - xslt import/export
 247
 248 @section oox
 249
 250 @li @c oox
 251 @li @c oox.chart
 252 @li @c oox.cscode - see oox/source/drawingml/customshapes/README
 253 @li @c oox.csdata - see oox/source/drawingml/customshapes/README
 254 @li @c oox.drawingml - DrawingML
 255 @li @c oox.drawingml.gradient
 256 @li @c oox.ppt - pptx filter
 257 @li @c oox.shape
 258 @li @c oox.storage - ZipStorage class
 259 @li @c oox.vml - VML
 260 @li @c oox.xmlstream - XmlStream class
 261
 262 @section forms
 263
 264 @li @c forms.component
 265 @li @c forms.helper
 266 @li @c forms.misc
 267 @li @c forms.richtext
 268 @li @c forms.runtime
 269 @li @c forms.xforms
 270
 271 @section formula
 272
 273 @li @c formula.core
 274 @li @c formula.ui
 275
 276 @section fpicker
 277
 278 @li @c fpicker
 279 @li @c fpicker.aqua
 280 @li @c fpicker.office
 281
 282 @section framework
 283
 284 @li @c fwk - framework (abbreviation)
 285 @li @c fwk.accelerators
 286 @li @c fwk.autorecovery
 287 @li @c fwk.desktop
 288 @li @c fwk.dispatch
 289 @li @c fwk.frame
 290 @li @c fwk.joburl
 291 @li @c fwk.loadenv
 292 @li @c fwk.session
 293 @li @c fwk.session.debug
 294 @li @c fwk.uiconfiguration
 295 @li @c fwk.uielement
 296
 297 @section i18nlangtag
 298
 299 @li @c i18nlangtag - language tags
 300
 301 @section i18npool
 302
 303 @li @c i18npool - general i18npool
 304
 305 @section i18n
 306
 307 @li @c i18n - module independent i18n related, e.g. language tag usage
 308
 309 @section io
 310
 311 @li @c io.connector
 312 @li @c io.streams
 313
 314 @section jvmfwk
 315
 316 @li @c jfw
 317 @li @c jfw.level1
 318 @li @c jfw.level2
 319
 320 @section LanguageTool
 321
 322 @li @c languagetool
 323
 324 @section LibreOfficeKit
 325
 326 @li @c lok
 327 @li @c lok.fontsubst
 328 @li @c lok.tiledrendering
 329 @li @c lok.dialog
 330 @li @c lok.a11y - LOK accessibility
 331 @li @c lok.urp - Uno Remote Protocol
 332
 333 @section l10ntools
 334
 335 @li @c l10ntools
 336
 337 @section Math
 338
 339 @li @c starmath
 340 @li @c starmath.ooxml - OOXML import/export
 341 @li @c starmath.rtf
 342 @li @c starmath.wordbase
 343
 344 @section package
 345
 346 @li @c package
 347 @li @c package.manifest
 348 @li @c package.xstor
 349 @li @c package.threadeddeflate
 350
 351 @section pyuno
 352
 353 @li @c pyuno.runtime
 354
 355 @section sdext
 356
 357 @li @c sdext
 358 @li @c sdext.minimizer
 359 @li @c sdext.pdfimport
 360 @li @c sdext.pdfimport.pdfparse
 361 @li @c sdext.presenter
 362
 363 @section sfx
 364
 365 @li @c sfx
 366 @li @c sfx.appl
 367 @li @c sfx.bastyp
 368 @li @c sfx.config
 369 @li @c sfx.control
 370 @li @c sfx.dialog
 371 @li @c sfx.doc
 372 @li @c sfx.notify
 373 @li @c sfx.sidebar
 374 @li @c sfx.view
 375
 376 @section slideshow
 377
 378 @li @c slideshow
 379 @li @c slideshow.eventqueue
 380 @li @c slideshow.opengl
 381 @li @c slideshow.verbose
 382
 383 @section sot
 384
 385 @li @c sot - COM structured storage
 386
 387 @section svl
 388
 389 @li @c svl
 390 @li @c svl.crypto
 391 @li @c svl.items
 392 @li @c svl.misc
 393 @li @c svl.numbers
 394
 395 @section svtools
 396
 397 @li @c svtools
 398 @li @c svtools.config
 399 @li @c svtools.contnr
 400 @li @c svtools.control
 401 @li @c svtools.dialogs
 402 @li @c svtools.misc
 403 @li @c svtools.table
 404 @li @c svtools.uno
 405
 406 @section svx
 407
 408 @li @c svx
 409 @li @c svx.chaining
 410 @li @c svx.diagram - Diagram ModelData
 411 @li @c svx.dialog
 412 @li @c svx.fmcomp
 413 @li @c svx.form
 414 @li @c svx.sdr
 415 @li @c svx.sidebar
 416 @li @c svx.stbcrtls - StatusBarControl
 417 @li @c svx.svdraw
 418 @li @c svx.table
 419 @li @c svx.tbxcrtls - ToolboxControl
 420 @li @c svx.uno
 421
 422 @section toolkit
 423
 424 @li @c toolkit
 425 @li @c toolkit.controls
 426 @li @c toolkit.helper
 427
 428 @section tools
 429
 430 @li @c tools
 431 @li @c tools.datetime
 432 @li @c tools.debug
 433 @li @c tools.fraction
 434 @li @c tools.generic
 435 @li @c tools.memtools
 436 @li @c tools.rc - resource manager
 437 @li @c tools.stream - SvStream class
 438 @li @c tools.urlobj - INetURLObject class
 439
 440 @section ucb
 441
 442 @li @c ucb
 443 @li @c ucb.core
 444 @li @c ucb.ucp
 445 @li @c ucb.ucp.cmis
 446 @li @c ucb.ucp.ext
 447 @li @c ucb.ucp.file
 448 @li @c ucb.ucp.gio
 449 @li @c ucb.ucp.tdoc
 450 @li @c ucb.ucp.webdav
 451 @li @c ucb.ucp.webdav.curl
 452
 453 @section unotools
 454
 455 @li @c unotools
 456 @li @c unotools.config
 457 @li @c unotools.i18n
 458 @li @c unotools.misc
 459 @li @c unotools.ucbhelper
 460
 461 @section URE
 462
 463 @li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
 464 @li @c salhelper.thread - ::salhelper::Thread class
 465
 466 @section sax
 467
 468 @li @c sax.cppunit
 469 @li @c sax.fastparser
 470
 471 @section stoc
 472
 473 @li @c stoc.corerefl - CoreReflection
 474 @li @c stoc.java - javaloader and javavm
 475
 476 @section VCL
 477
 478 @li @c vcl
 479 @li @c vcl.a11y
 480 @li @c vcl.app
 481 @li @c vcl.builder
 482 @li @c vcl.control
 483 @li @c vcl.ct - CoreText-using code for macOS and iOS
 484 @li @c vcl.debugevent
 485 @li @c vcl.driver Graphics driver handling
 486 @li @c vcl.emf - EMF/EMF+ processing
 487 @li @c vcl.filter
 488 @li @c vcl.filter.webp
 489 @li @c vcl.fonts - font-specific code
 490 @li @c vcl.fonts.detail
 491 @li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
 492 @li @c vcl.gdi.wndproc - Windows Procedure part of VCL
 493 @li @c vcl.gdi.fontmetric
 494 @li @c vcl.gtk - Gtk+ 2/3 plugin
 495 @li @c vcl.gtk3
 496 @li @c vcl.gtkkde5
 497 @li @c vcl.harfbuzz - HarfBuzz text layout
 498 @li @c vcl.headless - bitmap-based backend
 499 @li @c vcl.helper
 500 @li @c vcl.icontest
 501 @li @c vcl.ios.clipboard
 502 @li @c vcl.items
 503 @li @c vcl.kf5 - KF5
 504 @li @c vcl.layout - Widget layout
 505 @li @c vcl.lazydelete
 506 @li @c vcl.opengl
 507 @li @c vcl.opengl.qt - Qt OpenGL
 508 @li @c vcl.osx
 509 @li @c vcl.osx.clipboard
 510 @li @c vcl.osx.print
 511 @li @c vcl.pdfwriter
 512 @li @c vcl.print
 513 @li @c vcl.plugadapt - the Unix/X11 backend plugin mechanism
 514 @li @c vcl.qt - Qt
 515 @li @c vcl.quartz
 516 @li @c vcl.schedule - scheduler / main-loop information
 517 @li @c vcl.schedule.deinit
 518 @li @c vcl.sessioninhibitor
 519 @li @c vcl.scrollbar - Scroll Bars
 520 @li @c vcl.se - VCL Session Manager
 521 @li @c vcl.se.debug
 522 @li @c vcl.skia - VCL Skia-based code
 523 @li @c vcl.skia.trace - tracing drawing in VCL Skia-based code
 524 @li @c vcl.sm - Session Manager Client
 525 @li @c vcl.sm.debug
 526 @li @c vcl.uitest - The UI testing framework code
 527 @li @c vcl.unity
 528 @li @c vcl.unx.dtrans
 529 @li @c vcl.unx.freetype
 530 @li @c vcl.unx.print
 531 @li @c vcl.virdev
 532 @li @c vcl.watchdog
 533 @li @c vcl.window
 534 @li @c vcl.win.dtrans
 535
 536 @section winaccessibility
 537
 538 @li @c iacc2 - IAccessible2 bridge debug
 539
 540 @section Writer
 541
 542 @li @c sw
 543 @li @c sw.a11y - accessibility
 544 @li @c sw.calc - formula calculation
 545 @li @c sw.core - Writer core
 546 @li @c sw.createcopy
 547 @li @c sw.doc
 548 @li @c sw.docappend
 549 @li @c sw.docx
 550 @li @c sw.envelp
 551 @li @c sw.filter
 552 @li @c sw.html - Writer HTML import/export
 553 @li @c sw.idle
 554 @li @c sw.layout - Writer core view: document layout
 555 @li @c sw.layout.debug - Writer layout dbg_lay output
 556 @li @c sw.mailmerge - Writer mail merge
 557 @li @c sw.pageframe - debug lifecycle of SwPageFrame
 558 @li @c sw.qa
 559 @li @c sw.rtf - .rtf export filter
 560 @li @c sw.tiled
 561 @li @c sw.transform - Transform documents API
 562 @li @c sw.ui
 563 @li @c sw.uno - Writer UNO interfaces
 564 @li @c sw.vba - Writer VBA
 565 @li @c sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
 566 @li @c sw.ww8.level2 - further info for sw.ww8
 567 @li @c sw.xml - Writer .odt import/export
 568
 569 @section writerfilter
 570
 571 @li @c writerfilter
 572 @li @c writerfilter.dmapper
 573 @li @c writerfilter.ooxml
 574 @li @c writerfilter.profile - load times of filters
 575 @li @c writerfilter.rtf
 576
 577 @section writerperfect
 578
 579 @li @c writerperfect
 580
 581 @section xmloff
 582
 583 @li @c xmloff
 584 @li @c xmloff.chart
 585 @li @c xmloff.core
 586 @li @c xmloff.draw
 587 @li @c xmloff.forms
 588 @li @c xmloff.style
 589 @li @c xmloff.table
 590 @li @c xmloff.text
 591 @li @c xmloff.transform
 592
 593 @section xmlsecurity
 594
 595 @li @c xmlsecurity.comp - xml security component
 596 @li @c xmlsecurity.dialogs - xml security dialogs
 597 @li @c xmlsecurity.helper
 598 @li @c xmlsecurity.nss
 599 @li @c xmlsecurity.ooxml - OOXML signature support
 600 @li @c xmlsecurity.qa
 601 @li @c xmlsecurity.workben
 602 @li @c xmlsecurity.xmlsec - xmlsec wrapper
 603 @li @c xmlsecurity.xmlsec.gpg - gpg xmlsec component
 604
 605 @section xmlscript
 606
 607 @li @c xmlscript.xmldlg
 608 @li @c xmlscript.xmlflat
 609 @li @c xmlscript.xmlhelper
 610 @li @c xmlscript.xmllib
 611 @li @c xmlscript.xmlmod
 612
 613 @section dbaccess
 614
 615 @li @c dbaccess
 616 @li @c dbaccess.core
 617 @li @c dbaccess.ui
 618 @li @c dbaccess.ui.generalpage
 619
 620 @section avmedia
 621
 622 @li @c avmedia
 623 @li @c avmedia.gstreamer
 624 @li @c avmedia.gtk
 625 @li @c avmedia.quicktime
 626
 627 @section other
 628
 629 @li @c accessibility
 630 @li @c animations
 631 @li @c basegfx
 632 @li @c binaryurp
 633 @li @c cli
 634 @li @c configmgr
 635 @li @c configmgr.dconf
 636 @li @c cppcanvas
 637 @li @c cppcanvas.emf
 638 @li @c helpcompiler
 639 @li @c idl
 640 @li @c javaunohelper
 641 @li @c jvmaccess
 642 @li @c lingucomponent
 643 @li @c linguistic
 644 @li @c lwp - lotuswordpro
 645 @li @c net
 646 @li @c opencl
 647 @li @c opencl.device
 648 @li @c opencl.file
 649 @li @c registry
 650 @li @c reportdesign
 651 @li @c rsc
 652 @li @c sax
 653 @li @c scripting
 654 @li @c scripting.provider
 655 @li @c shell
 656 @li @c shell.jumplist
 657 @li @c stoc
 658 @li @c store
 659 @li @c svg
 660 @li @c svgio
 661 @li @c test
 662 @li @c ucbhelper
 663 @li @c unodevtools
 664 @li @c unoidl
 665 @li @c unoxml
 666 @li @c uui
 667 @li @c vbahelper
 668 @li @c wasm
 669 @li @c xmlhelp
 670 @li @c xmlreader
 671
 672 */
 673 /* vim:set ft=cpp shiftwidth=4 softtabstop=4 expandtab: */