code review and inline documentation

1 files changed, 27 insertions, 0 deletions

diff --git a/generic/tclClock.c b/generic/tclClock.c
index efa9120..c63f425 100644
--- a/generic/tclClock.c
+++ b/generic/tclClock.c
@@ -412,7 +412,19 @@ NormTimezoneObj(
 
 /*
  *----------------------------------------------------------------------
+ *
+ * ClockGetSystemLocale --
+ *
+ *	Returns system locale.
+ *
+ *	Executes ::tcl::clock::GetSystemLocale in given interpreter.
+ *
+ * Results:
+ *	Returns system locale tcl object.
+ *
+ *----------------------------------------------------------------------
  */
+
 static inline Tcl_Obj *
 ClockGetSystemLocale(
     ClockClientData *dataPtr,	/* Opaque pointer to literal pool, etc. */
@@ -426,7 +438,19 @@ ClockGetSystemLocale(
 }
 /*
  *----------------------------------------------------------------------
+ *
+ * ClockGetCurrentLocale --
+ *
+ *	Returns current locale.
+ *
+ *	Executes ::tcl::clock::mclocale in given interpreter.
+ *
+ * Results:
+ *	Returns current locale tcl object.
+ *
+ *----------------------------------------------------------------------
  */
+
 static inline Tcl_Obj *
 ClockGetCurrentLocale(
     ClockClientData *dataPtr,	/* Client data containing literal pool */
@@ -978,6 +1002,9 @@ ClockGetTZData(
  *
  *	Returns system (current) timezone.
  *
+ *	If system zone not yet cached, it executes ::tcl::clock::GetSystemTimeZone
+ *	in given interpreter and caches its result.
+ *
  * Results:
  *	Returns normalized timezone object.
  *