Skip to content

Commit 7262c63

Browse files
committed
Docs: updated documentation
1 parent 4605067 commit 7262c63

File tree

323 files changed

+121217
-64620
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

323 files changed

+121217
-64620
lines changed

docs/landing/data/releases.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
driverName = "mongo-scala-driver"
22
githubRepo = "mongo-scala-driver"
3-
current = "1.1.1"
3+
current = "1.2.0"
44

55
[[versions]]
6-
version = "1.2.0-beta1"
6+
version = "1.2.0"
77
docs = "./1.2"
88
api = "./1.2/scaladoc"
99

docs/reference/content/getting-started/installation-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ The recommended way to get started using the driver in your project is with a de
1717
## MongoDB Scala Driver
1818
The MongoDB Scala Driver
1919

20-
{{< install artifactId="mongo-scala-driver" version="1.2.0-beta1" mongoDriverVersion="3.4.0-beta1" scalaVersion="2.11">}}
20+
{{< install artifactId="mongo-scala-driver" version="1.2.0" mongoDriverVersion="3.4.0" scalaVersion="2.11">}}

docs/reference/data/mongodb.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ highlightTheme = "idea.css"
66
apiUrl = "/scaladoc/index.html"
77
coreApiUrl = "http://api.mongodb.org/java/3.4/"
88
coreDocsUrl = "http://mongodb.github.io/mongo-java-driver/3.4/"
9-
mongoDriverVersion = "3.4.0-beta1" # Update in installation-guide.md
9+
mongoDriverVersion = "3.4.0" # Update in installation-guide.md

docs/reference/static/scaladoc/buildinfo/BuildInfo$.html

Lines changed: 321 additions & 253 deletions
Large diffs are not rendered by default.
Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
<!DOCTYPE html >
2+
<html>
3+
<head>
4+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
6+
<title>Mongo Scala Driver - buildinfo</title>
7+
<meta name="description" content="Mongo Scala Driver - buildinfo" />
8+
<meta name="keywords" content="Mongo Scala Driver buildinfo" />
9+
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
10+
11+
<link href="../lib/index.css" media="screen" type="text/css" rel="stylesheet" />
12+
<link href="../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
13+
<link href="../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
14+
<script type="text/javascript" src="../lib/jquery.js"></script>
15+
<script type="text/javascript" src="../lib/jquery.panzoom.min.js"></script>
16+
<script type="text/javascript" src="../lib/jquery.mousewheel.min.js"></script>
17+
<script type="text/javascript" src="../lib/index.js"></script>
18+
<script type="text/javascript" src="../index.js"></script>
19+
<script type="text/javascript" src="../lib/scheduler.js"></script>
20+
<script type="text/javascript" src="../lib/template.js"></script>
21+
<script type="text/javascript" src="../lib/tools.tooltip.js"></script>
22+
<script type="text/javascript" src="../lib/modernizr.custom.js"></script><script type="text/javascript" src="../lib/diagrams.js" id="diagrams-js"></script>
23+
<script type="text/javascript">
24+
/* this variable can be used by the JS to determine the path to the root document */
25+
var toRoot = '../';
26+
</script>
27+
28+
</head>
29+
<body>
30+
<div id="search">
31+
<span id="doc-title">Mongo Scala Driver<span id="doc-version"></span></span>
32+
<span class="close-results"><span class="left">&lt;</span> Back</span>
33+
<div id="textfilter">
34+
<span class="input">
35+
<input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/" />
36+
<i class="clear material-icons"></i>
37+
<i id="search-icon" class="material-icons"></i>
38+
</span>
39+
</div>
40+
</div>
41+
<div id="search-results">
42+
<div id="search-progress">
43+
<div id="progress-fill"></div>
44+
</div>
45+
<div id="results-content">
46+
<div id="entity-results"></div>
47+
<div id="member-results"></div>
48+
</div>
49+
</div>
50+
<div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;">
51+
<div id="content-container" style="-webkit-overflow-scrolling: touch;">
52+
<div id="subpackage-spacer">
53+
<div id="packages">
54+
<h1>Packages</h1>
55+
<ul>
56+
<li name="_root_.root" visbl="pub" class="indented0 " data-isabs="false" fullComment="yes" group="Ungrouped">
57+
<a id="_root_"></a><a id="root:_root_"></a>
58+
<span class="permalink">
59+
<a href="index.html#_root_" title="Permalink">
60+
<i class="material-icons"></i>
61+
</a>
62+
</span>
63+
<span class="modifier_kind">
64+
<span class="modifier"></span>
65+
<span class="kind">package</span>
66+
</span>
67+
<span class="symbol">
68+
<a title="This is the documentation for the MongoDB Scala driver." href="../index.html">
69+
<span class="name">root</span>
70+
</a>
71+
</span>
72+
73+
<p class="shortcomment cmt">This is the documentation for the MongoDB Scala driver.</p><div class="fullcomment"><div class="comment cmt"><p>This is the documentation for the MongoDB Scala driver.</p><h4> Driver structure </h4><p>The <a href="http://mongodb.org" target="_blank">mongodb</a> scala driver.</p><p>To get started you need a <a href="../org/mongodb/scala/MongoClient.html" class="extype" name="org.mongodb.scala.MongoClient">MongoClient</a> instance, either from a
74+
<a href="http://docs.mongodb.org/manual/reference/connection-string/" target="_blank">connection string</a> or via a <a href="../org/mongodb/scala/index.html#MongoClientSettings=com.mongodb.async.client.MongoClientSettings" class="extmbr" name="org.mongodb.scala.MongoClientSettings">org.mongodb.scala.MongoClientSettings</a>.</p><p>Notable packages include:</p><ul><li><a href="../org/mongodb/scala/MongoClient.html" class="extype" name="org.mongodb.scala.MongoClient">MongoClient</a> The MongoClient used to connect and access MongoDB</li><li><a href="../org/mongodb/scala/MongoDatabase.html" class="extype" name="org.mongodb.scala.MongoDatabase">MongoDatabase</a> Providing access to a specific database</li><li><a href="../org/mongodb/scala/MongoCollection.html" class="extype" name="org.mongodb.scala.MongoCollection">MongoCollection</a> Providing access to a specific collection in a database.</li></ul></div><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../index.html" class="extype" name="_root_">root</a></dd></dl></div>
75+
</li><li name="_root_.buildinfo" visbl="pub" class="indented1 current" data-isabs="false" fullComment="yes" group="Ungrouped">
76+
<a id="buildinfo"></a><a id="buildinfo:buildinfo"></a>
77+
<span class="permalink">
78+
<a href="index.html#buildinfo" title="Permalink">
79+
<i class="material-icons"></i>
80+
</a>
81+
</span>
82+
<span class="modifier_kind">
83+
<span class="modifier"></span>
84+
<span class="kind">package</span>
85+
</span>
86+
<span class="symbol">
87+
<span class="name">buildinfo</span>
88+
</span>
89+
90+
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd><a href="../index.html" class="extype" name="_root_">root</a></dd></dl></div>
91+
</li><li class="current-entities indented1">
92+
<span class="separator"></span>
93+
<a class="object" href="BuildInfo$.html" title="This object was generated by sbt-buildinfo."></a>
94+
<a href="BuildInfo$.html" title="This object was generated by sbt-buildinfo.">
95+
BuildInfo
96+
</a>
97+
</li>
98+
</ul>
99+
</div>
100+
</div>
101+
<div id="content">
102+
<body class="package value">
103+
<div id="definition">
104+
<div class="big-circle package">p</div>
105+
106+
<h1>buildinfo<span class="permalink">
107+
<a href="../buildinfo/index.html" title="Permalink">
108+
<i class="material-icons"></i>
109+
</a>
110+
</span></h1>
111+
112+
</div>
113+
114+
<h4 id="signature" class="signature">
115+
<span class="modifier_kind">
116+
<span class="modifier"></span>
117+
<span class="kind">package</span>
118+
</span>
119+
<span class="symbol">
120+
<span class="name">buildinfo</span>
121+
</span>
122+
</h4>
123+
124+
125+
<div id="comment" class="fullcommenttop"></div>
126+
127+
128+
<div id="mbrsel">
129+
<div class="toggle"></div>
130+
<div id="memberfilter">
131+
<i class="material-icons arrow"></i>
132+
<span class="input">
133+
<input id="mbrsel-input" placeholder="Filter all members" type="text" accesskey="/" />
134+
</span>
135+
<i class="clear material-icons"></i>
136+
</div>
137+
<div id="filterby">
138+
<div id="order">
139+
<span class="filtertype">Ordering</span>
140+
<ol>
141+
142+
<li class="alpha in"><span>Alphabetic</span></li>
143+
144+
</ol>
145+
</div>
146+
147+
<div id="visbl">
148+
<span class="filtertype">Visibility</span>
149+
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
150+
</div>
151+
</div>
152+
</div>
153+
154+
<div id="template">
155+
<div id="allMembers">
156+
157+
158+
159+
160+
161+
162+
<div class="values members">
163+
<h3>Value Members</h3>
164+
<ol>
165+
<li name="buildinfo.BuildInfo" visbl="pub" class="indented0 " data-isabs="false" fullComment="no" group="Ungrouped">
166+
<a id="BuildInfo"></a><a id="BuildInfo:BuildInfo"></a>
167+
<span class="permalink">
168+
<a href="../buildinfo/index.html#BuildInfo" title="Permalink">
169+
<i class="material-icons"></i>
170+
</a>
171+
</span>
172+
<span class="modifier_kind">
173+
<span class="modifier"></span>
174+
<span class="kind">object</span>
175+
</span>
176+
<span class="symbol">
177+
<a title="This object was generated by sbt-buildinfo." href="BuildInfo$.html">
178+
<span class="name">BuildInfo</span>
179+
</a><span class="result"> extends <a href="http://www.scala-lang.org/api/2.12.0/index.html#scala.Product" class="extype" target="_top">Product</a> with <a href="http://www.scala-lang.org/api/2.12.0/index.html#scala.Serializable" class="extype" target="_top">Serializable</a></span>
180+
</span>
181+
182+
<p class="shortcomment cmt">This object was generated by sbt-buildinfo.</p>
183+
</li>
184+
</ol>
185+
</div>
186+
187+
188+
189+
190+
</div>
191+
192+
<div id="inheritedMembers">
193+
194+
195+
</div>
196+
197+
<div id="groupedMembers">
198+
<div class="group" name="Ungrouped">
199+
<h3>Ungrouped</h3>
200+
201+
</div>
202+
</div>
203+
204+
</div>
205+
206+
<div id="tooltip"></div>
207+
208+
<div id="footer"> </div>
209+
</body>
210+
</div>
211+
</div>
212+
</div>
213+
</body>
214+
</html>

docs/reference/static/scaladoc/buildinfo/package.html

Lines changed: 0 additions & 118 deletions
This file was deleted.

docs/reference/static/scaladoc/deprecated-list.html

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)