From 6eb00ea3070be91c6275d13d6befaadcab1f84b5 Mon Sep 17 00:00:00 2001
From: richard <devnull@localhost>
Date: Mon, 13 Apr 2009 05:24:12 +0200
Subject: [PATCH] Added doc comments on ZR_LogMessageFormatted function.

---
 src/zr/translation.inc | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/zr/translation.inc b/src/zr/translation.inc
index 3e24c14..f7e5cc1 100644
--- a/src/zr/translation.inc
+++ b/src/zr/translation.inc
@@ -115,6 +115,20 @@ stock ZR_TranslateMessage(String:buffer[], maxlen, any:...)
     VFormat(buffer, maxlen, "%t", 3);
 }
 
+/**
+ * Logs a formatted message with module and block info depending, on the type.
+ *
+ * @param client    Specifies the client who triggered the event/command. Use
+ *                  -1 for core events like validation, etc.
+ * @param module    what module the log event belongs to.
+ * @param block     What function or code block the log is triggered from.
+ * @param message   Log message. Formatted string.
+ * @param type      Optional. What logging type or style to use. Options:
+ *                  LOG_FORMAT_TYPE_SIMPLE - Simple, no module or block info.
+ *                  LOG_FORMAT_TYPE_FULL - Full, with module and block info.
+ *                  LOG_FORMAT_TYPE_ERROR - Full, but log to error log instead.
+ * @param any...    Formatting parameters.
+ */
 stock ZR_LogMessageFormatted(client, const String:module[], const String:block[], const String:message[], type = LOG_FORMAT_TYPE_FULL, any:...)
 {
     decl String:buffer[2048];