From 016afcf3dafbcbe67d1c1f6af2d1c735463fcf16 Mon Sep 17 00:00:00 2001
From: Joshua Sled <jsled@asynchronous.org>
Date: Wed, 14 Feb 2007 01:34:02 +0000
Subject: [PATCH] More doc updates.

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@15579 57a11ea4-9604-0410-9ed3-97b8803252fd
---
 lib/libqof/qof/qoflog.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/lib/libqof/qof/qoflog.h b/lib/libqof/qof/qoflog.h
index 3d233c2c93..2dbfbc34e8 100644
--- a/lib/libqof/qof/qoflog.h
+++ b/lib/libqof/qof/qoflog.h
@@ -63,6 +63,21 @@
  * Trailing newlines (e.g. <tt>PINFO("...\n", ...)</tt>) are removed; the logger
  * will newline separate output.
  *
+ * @section best Best Practices
+ *
+ * Code should:
+ *
+ * @li Define both <tt>static QofLogModule log_module</tt> and <tt>#define
+ *   G_LOG_DOMAIN</tt> to the same value.
+ * @li Define a logical, specific path as the log domain;
+ *   @c "gnc.gui.plugin-pages.sx-list" or
+ *   @c "gnc.register.gnome.cell.quickfill" are
+ *   good examples.
+ * @li Use glib-provided @c g_debug(...), @c g_message(...),
+ *   @c g_warning(...), @c g_critical(...) and
+ *   @c g_error(...) functions in preference to the historical qof/gnc @c
+ *   PINFO, @c PERR (&c.) macros
+ *
  * @see qof_log_parse_log_config(const char*)
  **/