log-areas clean up

sal/Package_inc.mk

@@ -105,6 +105,7 @@ $(eval $(call gb_Package_add_file,sal_inc,inc/rtl/ustring.hxx,rtl/ustring.hxx))
 $(eval $(call gb_Package_add_file,sal_inc,inc/rtl/uuid.h,rtl/uuid.h))
 $(eval $(call gb_Package_add_file,sal_inc,inc/sal/alloca.h,sal/alloca.h))
 $(eval $(call gb_Package_add_file,sal_inc,inc/sal/config.h,sal/config.h))
+$(eval $(call gb_Package_add_file,sal_inc,inc/sal/log-areas.dox,sal/log-areas.dox))
 $(eval $(call gb_Package_add_file,sal_inc,inc/sal/log.hxx,sal/log.hxx))
 $(eval $(call gb_Package_add_file,sal_inc,inc/sal/macros.h,sal/macros.h))
 $(eval $(call gb_Package_add_file,sal_inc,inc/sal/main.h,sal/main.h))

sal/inc/sal/log-areas.dox

@@ -3,45 +3,50 @@
 
 @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.
+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 use 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 the list in the proper section with an explanation.
+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 Calc
 
-@li sc.ui - Calc's UI
+@li @c sc.ui - Calc UI
+
 
 @section Filter
 
-@li filter.ms - escher export/import support
+@li @c filter.ms - escher import/export
+@li @c oox.xmlstream - XmlStream class
 
-@section oox
 
-@li oox.xmlstream - XmlStream class
+@section Math
 
-@section SAL/RTL
+@li @c starmath.ooxml - OOXML import/export
 
-@li rtl.string - rtl::OString, rtl::OUString and related functionality
 
-@section VCL
+@section URE
 
-@li vcl.gdi - the GDI part of VCL: devices, bitmaps, etc.
-@li vcl.gtk - Gtk+ 2/3 plugin
+@li @c rtl.string - ::rtl::OString, ::rtl::OUString, and related functionality
 
-@section Writer
 
-@li sw.uno - Writer's UNO interfaces
-@li sw.ww8 - .doc/.docx export filter, .doc import filter (not writerfilter)
-@li sw.rtf - .rtf export filter
+@section VCL
+
+@li @c vcl.gdi - the GDI part of VCL, devices, bitmaps, etc.
+@li @c vcl.gtk - Gtk+ 2/3 plugin
 
-@section StarMath
 
-@li starmath.ooxml - OOXML export/import support
+@section Writer
+
+@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)
 
 */