From b891ae7fc69eb3ee88c9b22fbe0b1848cf035b21 Mon Sep 17 00:00:00 2001
From: pouillot <pouillot@30fe4595-0a0c-4342-8851-515496e4dcbd>
Date: Sun, 24 Feb 2013 14:48:15 +0000
Subject: [PATCH] Re #788 Improved comments

git-svn-id: https://svn.code.sf.net/p/speed-dreams/code/trunk@5195 30fe4595-0a0c-4342-8851-515496e4dcbd

Former-commit-id: 37938e2e9f826c6d986dec3641f2ff95b1aaa881
Former-commit-id: 823ffc42cfe1825cb962d098ce72737ec161b895
---
 src/libs/tgf/tgf.h | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/libs/tgf/tgf.h b/src/libs/tgf/tgf.h
index 6b0940fd3..e15ab33d4 100644
--- a/src/libs/tgf/tgf.h
+++ b/src/libs/tgf/tgf.h
@@ -464,19 +464,22 @@ class TGF_API GfLogger
 	//! Destructor.
 	virtual ~GfLogger();
 
-	//! Accessors.
+	//! Name.
 	const std::string& name() const;
 
+	//! Criticity level threshold (ascending level means descending criticity).
 	int levelThreshold() const;
 	void setLevelThreshold(int nLevel);
 
+	//! Output lines header columns selection (order not customisable, only there or not).
 	enum { eNone=0, eTime=0x01, eLogger=0x02, eLevel=0x04, eAll=eTime|eLogger|eLevel };
 	unsigned headerColumns() const;
 	void setHeaderColumns(unsigned bfHdrCols);
 
+	//! Output stream.
 	FILE* stream() const;
 	void setStream(FILE* pFile, bool bLogFileChange=true);
-	void setStream(const std::string& strPathname);
+	void setStream(const std::string& strPathname); // "stdout" or "stderr" also supported.
 	
 	//! Tracing functions (name gives the trace level / criticity).
 	void fatal(const char *pszFmt, ...); // Warning : This one calls exit(1) at the end !