summaryrefslogtreecommitdiff
path: root/include/sal/log-areas.dox
diff options
context:
space:
mode:
Diffstat (limited to 'include/sal/log-areas.dox')
-rw-r--r--include/sal/log-areas.dox355
1 files changed, 355 insertions, 0 deletions
diff --git a/include/sal/log-areas.dox b/include/sal/log-areas.dox
new file mode 100644
index 000000000000..d21f14388d96
--- /dev/null
+++ b/include/sal/log-areas.dox
@@ -0,0 +1,355 @@
+// NOTE: This file is also parsed by a compiler plugin. Make sure all
+// areas are marked with '@li @c'.
+
+/**
+@page sal_log_areas SAL debug areas
+
+@short List and description of areas for the SAL debug macros
+
+This is a list of areas that are used by the SAL_INFO family of macros. See
+@ref sal_log "basic log functionality" for details about this functionality.
+
+If you need a debug area in some code, first check this list and use the
+appropriate area if it exists. This list is not definite, if you need a new
+area, use it and add it to an appropriate section with an explanation.
+Generally, use the name of the relevant code module as the first area segment.
+Please keep all entries sorted.
+
+This list should give you an overview of which areas to enable when debugging
+certain functionality.
+
+@section SAL
+
+@li @c sal.debug - SAL debugging functionality
+@li @c sal.osl - SAL OSL library
+@li @c sal.rtl - SAL RTL library
+@li @c sal.textenc - the textencoding SAL library
+
+@section basctl
+
+@li @c basctl.basicide
+
+@section basebmp
+
+@li @c basebmp.bitmapdevice
+
+@section basic
+
+@li @c basic
+@li @c basic.sbx
+
+@section canvas
+
+@li @c canvas
+@li @c canvas.cairo
+@li @c canvas.null
+
+@section chart2
+
+@li @c chart2
+@li @c chart2.areachart
+
+@section connectivity
+
+@li @c connectivity.cpool
+@li @c connectivity.commontools
+@li @c connectivity.mork
+@li @c connectivity.parse
+@li @c connectivity.postgresql
+
+@section cui
+
+@li @c cui.customize
+@li @c cui.dialogs
+@li @c cui.factory
+@li @c cui.options
+@li @c cui.tabpages
+
+@section Calc
+
+@li @c sc
+@li @c sc.core
+@li @c sc.ui - Calc UI
+
+@section desktop
+
+@li @c desktop
+@li @c desktop.deployment
+@li @c desktop.migration
+
+@section Draw
+
+@li @c sd
+@li @c sd.fwk
+@li @c sd.sls - slidesorter
+@li @c sd.tools
+@li @c sd.ui
+@li @c sd.view
+@li @c sd.slideshow
+@li @c sdremote
+@li @c sdremote.bluetooth
+
+@section editeng
+
+@li @c editeng
+@li @c editeng.items
+
+@section embeddedobj
+
+@li @c embeddedobj - embedded objects
+@li @c embeddedobj.ole - OLE embedded objects
+
+@section extensions
+
+@li @c extensions.dbpilots
+@li @c extensions.plugin
+@li @c extensions.scanner
+@li @c extensions.update
+
+@section Filter
+
+@li @c filter.ms - escher import/export
+@li @c filter.xslt - xslt import/export
+@li @c oox.xmlstream - XmlStream class
+@li @c oox.storage - ZipStorage class
+@li @c oox.ppt - pptx filter
+
+@section formula
+
+@li @c formula.core
+
+@section fpicker
+
+@li @c fpicker.aqua
+@li @c fpicker.office
+
+@section framework
+
+@li @c fwk - framework
+@li @c fwk.desktop
+@li @c fwk.session
+
+@section i18nlangtag
+
+@li @c i18nlangtag - language tags
+
+@section i18npool
+
+@li @c i18npool - general i18npool
+
+@section i18n
+
+@li @c i18n - module independent i18n related, e.g. language tag usage
+
+@section io
+
+@li @c io.streams
+
+@section jvmfwk
+
+@li @c jfw
+@li @c jfw.level1
+@li @c jfw.level2
+
+@section Math
+
+@li @c starmath.rtf
+@li @c starmath.ooxml - OOXML import/export
+@li @c starmath.wordbase
+
+@section sdext
+
+@li @c sdext.minimizer
+@li @c sdext.pdfimport
+@li @c sdext.pdfimport.pdfparse
+@li @c sdext.presenter
+
+@section sfx2
+
+@li @c sfx2
+@li @c sfx2.appl
+@li @c sfx2.bastyp
+@li @c sfx2.config
+@li @c sfx2.control
+@li @c sfx2.dialog
+@li @c sfx2.doc
+@li @c sfx2.notify
+@li @c sfx2.view
+
+@section slideshow
+
+@li @c slideshow.opengl
+@li @c slideshow.eventqueue
+
+@section svl
+
+@li @c svl
+@li @c svl.numbers
+
+@section svtools
+
+@li @c svtools.config
+@li @c svtools.contnr
+@li @c svtools.control
+@li @c svtools.dialogs
+@li @c svtools.filter
+@li @c svtools.misc
+@li @c svtools.table
+@li @c svtools.uno
+
+@section svx
+
+@li @c svx.dialog
+@li @c svx.fmcomp
+@li @c svx.form
+@li @c svx.stbcrtls - StatusBarControl
+@li @c svx.table
+@li @c svx.tbxcrtls - ToolboxControl
+@li @c svx.sdr
+@li @c svx.uno
+
+@section toolkit
+
+@li @c toolkit.controls
+
+@section tools
+
+@li @c tools.debug
+@li @c tools.datetime
+@li @c tools.generic
+@li @c tools.memtools
+@li @c tools.rc - resource manager
+@li @c tools.stream - SvStream class
+
+@section ucb
+
+@li @c cmisucp
+@li @c ucb.ucp
+@li @c ucb.ucp.gio
+@li @c ucb.ucp.webdav
+
+@section unotools
+
+@li @c unotools.config
+@li @c unotools.i18n
+@li @c unotools.misc
+@li @c unotools.ucbhelper
+
+@section URE
+
+@li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
+@li @c salhelper.thread - ::salhelper::Thread class
+
+@section sax
+
+@li @c sax.cppunit
+
+@section stoc
+
+@li @c stoc.corerefl - CoreReflection
+@li @c stoc.tdmanager - TypeDescriptionManager
+
+@section svl
+
+@li @c svl.items
+
+@section VCL
+
+@li @c vcl
+@li @c vcl.a11y
+@li @c vcl.atsui - ATSUI (obsolete) -using code for Mac OS X
+@li @c vcl.control
+@li @c vcl.coretext - CoreText-using code for Mac OS X and iOS
+@li @c vcl.fonts - font-specific code
+@li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
+@li @c vcl.gtk - Gtk+ 2/3 plugin
+@li @c vcl.headless - bitmap-based backend
+@li @c vcl.kde - KDE
+@li @c vcl.kde4 - KDE4
+@li @c vcl.layout - Widget layout
+@li @c vcl.scrollbar - Scroll Bars
+@li @c vcl.sm - Session Manager
+@li @c vcl.window
+@li @c vcl.unity
+@li @c vcl.virdev
+
+@section Writer
+
+@li @c sw
+@li @c sw.core - Writer core
+@li @c sw.docx
+@li @c sw.envelp
+@li @c sw.level2
+@li @c sw.rtf - .rtf export filter
+@li @c sw.uno - Writer UNO interfaces
+@li @c sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
+@li @c sw.ww8.level2 - further info for sw.ww8
+
+@section writerfilter
+
+@li @c writerfilter
+@li @c writerfilter.profile - load times of filters
+
+@section xmloff
+
+@li @c xmloff.core
+@li @c xmloff.forms
+@li @c xmloff.chart
+@li @c xmloff.style
+
+@section xmlsecurity
+
+@li @c xmlsecurity.dialogs - xml security dialogs
+@li @c xmlsecurity.helper
+@li @c xmlsecurity.xmlsec - xmlsec wrapper
+
+@section xmlscript
+
+@li @c xmlscript.xmlhelper
+@li @c xmlscript.xmldlg
+@li @c xmlscript.xmlflat
+@li @c xmlscript.xmllib
+@li @c xmlscript.xmlmod
+
+@section dbaccess
+
+@li @c dbaccess
+@li @c dbaccess.ui
+
+@section svx
+
+@li @c svx
+@li @c svx.fmcmop
+
+@section other
+
+@li @c accessibility
+@li @c avmedia
+@li @c basebmp
+@li @c binaryurp
+@li @c bridges
+@li @c comphelper
+@li @c configmgr
+@li @c cppcanvas
+@li @c cppuhelper
+@li @c cppu
+@li @c forms
+@li @c helpcompiler
+@li @c linguistic
+@li @c oox
+@li @c package
+@li @c rsc
+@li @c sax
+@li @c shell
+@li @c stoc
+@li @c svg
+@li @c ucbhelper
+@li @c unoidl
+@li @c uui
+@li @c vbahelper
+@li @c xmlhelp
+@li @c xmloff
+@li @c xmlreader
+
+*/
+/* vim:set ft=cpp shiftwidth=4 softtabstop=4 expandtab: */