Skip to content

Commit

Permalink
Fix javadoc, explaining where the TimeZone is stored in the session.
Browse files Browse the repository at this point in the history
  • Loading branch information
rkiddy committed Jan 3, 2013
1 parent 5101c11 commit 57b105d
Showing 1 changed file with 6 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,17 @@

/**
* This component adds javascript to a page to grab the system time zone
* from the browser. The information is then sent to the session using
* an ajax call. It determines a time zone based on minutes offset from
* from the browser and write the time zone to the <code>timeZone</code>
* attribute of the session via a call to the <code>setTimeZone()</code>
* method. The information is sent to the session using an ajax call.
* This code determines a time zone based on minutes offset from
* GMT, whether the time zone observes DST, and if DST, whether the time
* zone is in the northern or southern hemisphere. Since there may be more
* than one time zone that matches these values, the array of possible
* values is compared against an array of preferred values if one is
* supplied. If no preferred values are supplied, the zone selected is
* pulled from the list of possible options in no particular order. Use
* of an ERXSession is expected/required.
* of an {@link ERXSession} is expected/required.
*
* @binding preferredTimeZones an array of preferred TimeZone objects. This
* array takes precedence over the preferredTimeZoneIDs binding.
Expand Down Expand Up @@ -167,4 +169,4 @@ public NSArray<TimeZone> preferredTimeZones() {
result = tzs.immutableClone();
return result;
}
}
}

0 comments on commit 57b105d

Please sign in to comment.