summaryrefslogtreecommitdiff
path: root/time.c
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-10-28 12:05:17 (GMT)
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2018-10-28 12:05:17 (GMT)
commitc4be18c28bf40b13674d0bd224b8029e87ea0257 (patch)
tree722df32ec33a8cdda1578ca2a9a726c91f6ebc42 /time.c
parentde925b4f3c69fe5c7221cb2bdeb1504dceed6f24 (diff)
time.c: [DOC] add description and fix markups [ci skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@65419 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'time.c')
-rw-r--r--time.c31
1 files changed, 19 insertions, 12 deletions
diff --git a/time.c b/time.c
index a5268dd..d0c1d47 100644
--- a/time.c
+++ b/time.c
@@ -5285,18 +5285,25 @@ rb_time_zone_abbreviation(VALUE zone, VALUE time)
*
* == Timezone argument
*
- * A timezone argument must have #local_to_utc, #utc_to_local, #name methods,
- * and may have #abbr method.
- *
- * The +#local_to_utc+ method should convert a Time-like object from the
- * timezone to UTC, and +#utc_to_local+ is the opposite. The Time-like
- * argument to these methods is similar to a Time object in UTC without
- * sub-second; it has attribute readers for the parts, and #to_i. The
- * sub-second attributes are fixed as 0, and #utc_offset, #zone, #isdst, and
- * the aliases are same as a Time object in UTC.
- *
- * The #name method is used for marshaling, and the #abbr method is used by
- * '%Z' in #strftime.
+ * A timezone argument must have +local_to_utc+ and +utc_to_local+
+ * methods, and may have +name+ and +abbr+ methods.
+ *
+ * The +local_to_utc+ method should convert a Time-like object from
+ * the timezone to UTC, and +utc_to_local+ is the opposite. The
+ * result also should be a Time or Time-like object (not necessary to
+ * be the same class). The #zone of the result is just ignored.
+ * Time-like argument to these methods is similar to a Time object in
+ * UTC without sub-second; it has attribute readers for the parts,
+ * e.g. #year, #month, and so on, and epoch time readers, #to_i. The
+ * sub-second attributes are fixed as 0, and #utc_offset, #zone,
+ * #isdst, and their aliases are same as a Time object in UTC.
+ * Also #to_time method is defined.
+ *
+ * The +name+ method is used for marshaling. If this method is not
+ * defined on a timezone object, Time objects using that timezone
+ * object are not able to dump by Marshal.
+ *
+ * The +abbr+ method is used by '%Z' in #strftime.
*/
void