Skip to content

Commit cbe1fd5

Browse files
committed
docs
1 parent ca5f412 commit cbe1fd5

File tree

6 files changed

+311
-309
lines changed

6 files changed

+311
-309
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## NEXT
44

5+
- [#114](https://github.com/dm3/clojure.java-time/pull/114): fix doc typo ([@metayan](https://github.com/metayan))
6+
57
## 1.4.2
68

79
- [#105](https://github.com/dm3/clojure.java-time/issues/105): fix `not-{before,after}?` on unconverted values

docs/java-time.api.html

+153-153
Large diffs are not rendered by default.

docs/java-time.html

+153-153
Large diffs are not rendered by default.

docs/java-time.repl.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!DOCTYPE html PUBLIC ""
22
"">
3-
<html><head><meta charset="UTF-8" /><title>java-time.repl documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure.java-time</span> <span class="project-version">1.4.3-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="README.html"><div class="inner"><span>Clojure.Java-Time</span></div></a></li><li class="depth-1 "><a href="CHANGELOG.html"><div class="inner"><span>Changelog</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><a href="java-time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>java-time</span></div></a></li><li class="depth-2 branch"><a href="java-time.api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>api</span></div></a></li><li class="depth-2 current"><a href="java-time.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="java-time.repl.html#var-show-adjusters"><div class="inner"><span>show-adjusters</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-fields"><div class="inner"><span>show-fields</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-formatters"><div class="inner"><span>show-formatters</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-graph"><div class="inner"><span>show-graph</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-path"><div class="inner"><span>show-path</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-timezones"><div class="inner"><span>show-timezones</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-units"><div class="inner"><span>show-units</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">java-time.repl</h1><div class="doc"><div class="markdown"></div></div><div class="public anchor" id="var-show-adjusters"><h3>show-adjusters</h3><div class="usage"><code>(show-adjusters)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L11">view source</a></div></div><div class="public anchor" id="var-show-fields"><h3>show-fields</h3><div class="usage"><code>(show-fields)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L17">view source</a></div></div><div class="public anchor" id="var-show-formatters"><h3>show-formatters</h3><div class="usage"><code>(show-formatters)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L20">view source</a></div></div><div class="public anchor" id="var-show-graph"><h3>show-graph</h3><div class="usage"><code>(show-graph)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L26">view source</a></div></div><div class="public anchor" id="var-show-path"><h3>show-path</h3><div class="usage"><code>(show-path from to)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L30">view source</a></div></div><div class="public anchor" id="var-show-timezones"><h3>show-timezones</h3><div class="usage"><code>(show-timezones)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L23">view source</a></div></div><div class="public anchor" id="var-show-units"><h3>show-units</h3><div class="usage"><code>(show-units)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/f81b3dd4c3478685efb90876b630d23279aaa11a/src/java_time/repl.clj#L14">view source</a></div></div></div></body></html>
3+
<html><head><meta charset="UTF-8" /><title>java-time.repl documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure.java-time</span> <span class="project-version">1.4.3-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="README.html"><div class="inner"><span>Clojure.Java-Time</span></div></a></li><li class="depth-1 "><a href="CHANGELOG.html"><div class="inner"><span>Changelog</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><a href="java-time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>java-time</span></div></a></li><li class="depth-2 branch"><a href="java-time.api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>api</span></div></a></li><li class="depth-2 current"><a href="java-time.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="java-time.repl.html#var-show-adjusters"><div class="inner"><span>show-adjusters</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-fields"><div class="inner"><span>show-fields</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-formatters"><div class="inner"><span>show-formatters</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-graph"><div class="inner"><span>show-graph</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-path"><div class="inner"><span>show-path</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-timezones"><div class="inner"><span>show-timezones</span></div></a></li><li class="depth-1"><a href="java-time.repl.html#var-show-units"><div class="inner"><span>show-units</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">java-time.repl</h1><div class="doc"><div class="markdown"></div></div><div class="public anchor" id="var-show-adjusters"><h3>show-adjusters</h3><div class="usage"><code>(show-adjusters)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L11">view source</a></div></div><div class="public anchor" id="var-show-fields"><h3>show-fields</h3><div class="usage"><code>(show-fields)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L17">view source</a></div></div><div class="public anchor" id="var-show-formatters"><h3>show-formatters</h3><div class="usage"><code>(show-formatters)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L20">view source</a></div></div><div class="public anchor" id="var-show-graph"><h3>show-graph</h3><div class="usage"><code>(show-graph)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L26">view source</a></div></div><div class="public anchor" id="var-show-path"><h3>show-path</h3><div class="usage"><code>(show-path from to)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L30">view source</a></div></div><div class="public anchor" id="var-show-timezones"><h3>show-timezones</h3><div class="usage"><code>(show-timezones)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L23">view source</a></div></div><div class="public anchor" id="var-show-units"><h3>show-units</h3><div class="usage"><code>(show-units)</code></div><div class="doc"><div class="markdown"></div></div><div class="src-link"><a href="https://github.com/dm3/clojure.java-time/blob/ca5f4127b7395518b61e0603f6bd10822720d8e8/src/java_time/repl.clj#L14">view source</a></div></div></div></body></html>

src/java_time.clj

+1-1
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@
123123
(def ^{:arglists (quote ([f initial v & vs])), :doc "Returns a lazy sequence of `initial` , `(apply f initial v vs)`, etc.\n\n Useful when you want to produce a sequence of temporal entities, for\n example:\n\n ```\n (iterate plus (days 0) 1)\n => (#<Period P0D> #<Period P1D> #<Period P2D> ...)\n\n (iterate plus (local-date 2010 1 1) (years 1))\n => (#<LocalDate 2010-01-01> #<LocalDate 2011-01-01> ...)\n\n (iterate adjust (local-date 2010 1 1) :next-working-day)\n => (#<LocalDate 2010-01-01> #<LocalDate 2010-01-04> ...)\n ```"} iterate java-time.seqs/iterate)
124124
(def ^{:arglists (quote ([entity adjuster & args])), :doc "Adjusts the temporal `entity` using the provided `adjuster` with optional `args`.\n\n The adjuster should either be a keyword which resolves to one of the\n predefined adjusters (see [[java-time.repl/show-adjusters]]) an instance of\n `TemporalAdjuster` or a function which returns another temporal entity when\n applied to the given one:\n\n ```\n (adjust (local-date 2015 1 1) :next-working-day)\n => #<LocalDate 2015-1-2>\n\n (adjust (local-date 2015 1 1) :first-in-month :monday)\n => #<LocalDate 2015-1-5>\n\n (adjust (local-date 2015 1 1) plus (days 1))\n => #<LocalDate 2015-1-2>\n ```"} adjust java-time.adjuster/adjust)
125125
(def ^{:arglists (quote ([o] [fmt o])), :doc "Formats the given time entity as a string.\n\n Accepts something that can be converted to a `DateTimeFormatter` or a\n formatter key, e.g. `:iso-offset-time`, as a first argument. Given one\n argument uses the default format.\n\n ```\n (format (zoned-date-time))\n => \"2015-03-21T09:22:46.677800+01:00[Europe/London]\"\n\n (format :iso-date (zoned-date-time))\n \"2015-03-21+01:00\"\n ```"} format java-time.format/format)
126-
(def ^{:arglists (quote ([fmt] [fmt arg1])), :doc "Constructs a DateTimeFormatter out of a\n\n * format string - \"yyyy/MM/dd\", \"HH:mm\", etc.\n * formatter name - :iso-date, :iso-time, etc.\n\n Accepts a map of options as an optional second argument:\n\n * `resolver-style` - either `:strict`, `:smart `or `:lenient`\n * `case` - either `:insensitive` or `:sensitive` (defaults to :sensitive)", :tag java.time.format.DateTimeFormatter} formatter java-time.format/formatter)
126+
(def ^{:arglists (quote ([fmt] [fmt arg1])), :doc "Constructs a DateTimeFormatter out of a\n\n * format string - \"yyyy/MM/dd\", \"HH:mm\", etc.\n * formatter name - :iso-date, :iso-time, etc.\n\n Accepts a map of options as an optional second argument:\n\n * `resolver-style` - either `:strict`, `:smart` or `:lenient`\n * `case` - either `:insensitive` or `:sensitive` (defaults to :sensitive)", :tag java.time.format.DateTimeFormatter} formatter java-time.format/formatter)
127127
(def ^{:arglists (quote ([] [a] [a b])), :doc "Creates a `java.util.Date` out of any combination of arguments valid for\n [[instant]] or the Instant itself.\n\n A `java.util.Date` represents an instant in time. It's a direct analog of the\n `java.time.Instant` type introduced in the JSR-310. Please consider using the\n `java.time.Instant` (through [[instant]]) directly.", :tag java.util.Date} java-date java-time.pre-java8/java-date)
128128
(def ^{:arglists (quote ([] [arg0] [arg0 arg1] [arg0 arg1 arg2])), :doc "Creates a `java.sql.Date` out of any combination of arguments valid for\n [[local-date]] or the `LocalDate` itself.\n\n Please consider using the JSR-310 Java Time types instead of `java.sql.Date`\n if your drivers support them.\n\n Even though `java.sql.Date` extends a `java.util.Date`, it's supposed to be\n used as a local date (no time component or time zone) for the purposes of\n conversion from/to native JDBC driver DATE types.", :tag java.sql.Date} sql-date java-time.pre-java8/sql-date)
129129
(def ^{:arglists (quote ([] [arg0] [arg0 arg1] [arg0 arg1 arg2] [arg0 arg1 arg2 arg3] [arg0 arg1 arg2 arg3 arg4] [arg0 arg1 arg2 arg3 arg4 arg5] [arg0 arg1 arg2 arg3 arg4 arg5 arg6])), :doc "Creates a `java.sql.Timestamp` in the local time zone out of any combination\n of arguments valid for [[local-date-time]] or the `LocalDateTime`\n itself.\n\n Does not support `Timestamp` construction from an `Instant` or a long millis value---please use\n [[instant->sql-timestamp]] for this purpose.\n\n Please consider using the JSR-310 Java Time types instead of\n `java.sql.Timestamp` if your drivers support them.\n\n `java.sql.Timestamp` is a version of a `java.util.Date` supposed to be used\n as a local date-time (no time zone) for the purposes of conversion from/to native\n JDBC driver TIMESTAMP types.", :tag java.sql.Timestamp} sql-timestamp java-time.pre-java8/sql-timestamp)

0 commit comments

Comments
 (0)