summaryrefslogtreecommitdiff
path: root/sql/tztime.h
diff options
context:
space:
mode:
authorunknown <cmiller@zippy.cornsilk.net>2007-10-16 16:11:50 -0400
committerunknown <cmiller@zippy.cornsilk.net>2007-10-16 16:11:50 -0400
commit94e41712130a838e72876785d880e62dbda6ca0c (patch)
tree8b9e521083780437237f38683ce7cab9518c7e78 /sql/tztime.h
parent4a0ec7864ea5c97bb51954c26674f1b6db04b13f (diff)
downloadmariadb-git-94e41712130a838e72876785d880e62dbda6ca0c.tar.gz
Doxygenize comments.
Diffstat (limited to 'sql/tztime.h')
-rw-r--r--sql/tztime.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/sql/tztime.h b/sql/tztime.h
index ddd80b88bf2..3d77a3eefa3 100644
--- a/sql/tztime.h
+++ b/sql/tztime.h
@@ -20,7 +20,7 @@
#if !defined(TESTTIME) && !defined(TZINFO2SQL)
-/*
+/**
This class represents abstract time zone and provides
basic interface for MYSQL_TIME <-> my_time_t conversion.
Actual time zones which are specified by DB, or via offset
@@ -30,7 +30,7 @@ class Time_zone: public Sql_alloc
{
public:
Time_zone() {} /* Remove gcc warning */
- /*
+ /**
Converts local time in broken down MYSQL_TIME representation to
my_time_t (UTC seconds since Epoch) represenation.
Returns 0 in case of error. Sets in_dst_time_gap to true if date provided
@@ -38,19 +38,19 @@ public:
*/
virtual my_time_t TIME_to_gmt_sec(const MYSQL_TIME *t,
my_bool *in_dst_time_gap) const = 0;
- /*
+ /**
Converts time in my_time_t representation to local time in
broken down MYSQL_TIME representation.
*/
virtual void gmt_sec_to_TIME(MYSQL_TIME *tmp, my_time_t t) const = 0;
- /*
+ /**
Because of constness of String returned by get_name() time zone name
have to be already zeroended to be able to use String::ptr() instead
of c_ptr().
*/
virtual const String * get_name() const = 0;
- /*
+ /**
We need this only for surpressing warnings, objects of this type are
allocated on MEM_ROOT and should not require destruction.
*/
@@ -65,7 +65,7 @@ extern my_bool my_tz_init(THD *org_thd, const char *default_tzname, my_bool
extern void my_tz_free();
extern my_time_t sec_since_epoch_TIME(MYSQL_TIME *t);
-/*
+/**
Number of elements in table list produced by my_tz_get_table_list()
(this table list contains tables which are needed for dynamical loading
of time zone descriptions). Actually it is imlementation detail that