Permalink
Browse files

autodoc update

  • Loading branch information...
wagjo committed Mar 9, 2011
1 parent 0e8db6c commit 4fb65de6cefe453e02d32ef3b70f7d3dc659f192
Showing with 48 additions and 42 deletions.
  1. +48 −42 borneo.core-api.html
View
@@ -173,7 +173,7 @@ <h2 id="borneo.core/*neo-db*">*neo-db*</h2>
<pre id="var-docstr">Holds the current database instance.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L48" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L48" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -187,7 +187,7 @@ <h2 id="borneo.core/ReturnableEvaluator">ReturnableEvaluator</h2>
position map.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L174" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L195" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -200,7 +200,7 @@ <h2 id="borneo.core/StopEvaluator">StopEvaluator</h2>
pos will be current position map.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L120" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L141" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -211,7 +211,7 @@ <h2 id="borneo.core/all-nodes">all-nodes</h2>
<pre id="var-docstr">Returns lazy-seq of all nodes in the db.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L574" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L607" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -222,7 +222,7 @@ <h2 id="borneo.core/all-rel-types">all-rel-types</h2>
<pre id="var-docstr">Returns lazy seq of all relationship types currently in database.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L445" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L478" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -237,7 +237,7 @@ <h2 id="borneo.core/create-child!">create-child!</h2>
This is a convenience function.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L533" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L566" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -249,7 +249,7 @@ <h2 id="borneo.core/create-node!">create-node!</h2>
<pre id="var-docstr">Creates a new node, not linked with any other nodes.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L520" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L553" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -260,7 +260,7 @@ <h2 id="borneo.core/create-rel!">create-rel!</h2>
<pre id="var-docstr">Creates relationship of a supplied type between from and to nodes.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L438" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L471" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -272,7 +272,7 @@ <h2 id="borneo.core/delete!">delete!</h2>
Only node which has no relationships attached to it can be deleted.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L389" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L422" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -284,7 +284,7 @@ <h2 id="borneo.core/delete-node!">delete-node!</h2>
This is a convenience function.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L547" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L580" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -295,7 +295,7 @@ <h2 id="borneo.core/end-node">end-node</h2>
<pre id="var-docstr">Returns end node for given relationship.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L422" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L455" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -307,7 +307,7 @@ <h2 id="borneo.core/get-id">get-id</h2>
Note that ids are not very good as unique identifiers.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L383" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L416" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -318,7 +318,7 @@ <h2 id="borneo.core/get-path">get-path</h2>
<pre id="var-docstr">Returns path to where the database is stored.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L290" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L312" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -329,7 +329,7 @@ <h2 id="borneo.core/index">index</h2>
<pre id="var-docstr">Returns the IndexManager paired with this graph database service.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L300" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L322" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -341,7 +341,7 @@ <h2 id="borneo.core/node-by-id">node-by-id</h2>
Note that ids are not very good as unique identifiers.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L579" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L612" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -353,7 +353,7 @@ <h2 id="borneo.core/other-node">other-node</h2>
This is a convenience function.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L427" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L460" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -362,10 +362,12 @@ <h2 id="borneo.core/prop">prop</h2>
<pre id="var-usage">Usage: (prop c k)
</pre>
<pre id="var-docstr">Returns property value based on its key.
-If property is not found, returns nil.</pre>
+If property is not found, returns nil.
+If property value is string which starts with colon,
+it is converted to keyword.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L333" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L361" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -377,7 +379,7 @@ <h2 id="borneo.core/prop?">prop?</h2>
property with a given key.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L327" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L355" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -387,10 +389,12 @@ <h2 id="borneo.core/props">props</h2>
</pre>
<pre id="var-docstr">Returns map of properties for a given node or relationship.
Fetches all properties and can be very resource consuming if node
-contains many large properties. This is a convenience function.</pre>
+contains many large properties. This is a convenience function.
+If property value is string which starts with colon,
+is is converted to keyword.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L345" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L375" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -401,7 +405,7 @@ <h2 id="borneo.core/purge!">purge!</h2>
<pre id="var-docstr">Deletes all nodes from database together with all relationships.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L311" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L337" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -412,7 +416,7 @@ <h2 id="borneo.core/read-only?">read-only?</h2>
<pre id="var-docstr">Returns true if database is read only.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L295" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L317" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -424,7 +428,7 @@ <h2 id="borneo.core/rel-by-id">rel-by-id</h2>
Note that ids are not very good as unique identifiers.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L585" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L618" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -436,7 +440,7 @@ <h2 id="borneo.core/rel-nodes">rel-nodes</h2>
This is a convenience function.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L411" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L444" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -447,7 +451,7 @@ <h2 id="borneo.core/rel-type">rel-type</h2>
<pre id="var-docstr">Returns type of given relationship.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L433" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L466" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -475,7 +479,7 @@ <h2 id="borneo.core/rel?">rel?</h2>
(rel? node :foo nil) ; Use (rel? node :foo) instead</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L453" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L486" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -503,7 +507,7 @@ <h2 id="borneo.core/rels">rels</h2>
(rels node :foo nil) ; Use (rel node :foo) instead</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L482" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L515" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -514,7 +518,7 @@ <h2 id="borneo.core/root">root</h2>
<pre id="var-docstr">Returns reference/root node.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L591" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L624" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -524,12 +528,13 @@ <h2 id="borneo.core/set-prop!">set-prop!</h2>
(set-prop! c key value)
</pre>
<pre id="var-docstr">Sets or remove property for a given node or relationship.
-The property value must be one of the valid property types (see Neo4j docs).
+The property value must be one of the valid property types
+(see Neo4j docs) or a keyword.
If a property value is nil, removes this property from the given
node or relationship.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L354" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L386" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -538,12 +543,13 @@ <h2 id="borneo.core/set-props!">set-props!</h2>
<pre id="var-usage">Usage: (set-props! c props)
</pre>
<pre id="var-docstr">Sets properties for a given node or relationship.
-The property value must be one of the valid property types (see Neo4j docs).
+The property value must be one of the valid property types
+(see Neo4j docs) or a keyword.
If a property value is nil, removes this property from the given
node or relationship. This is a convenience function.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L372" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L404" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -557,7 +563,7 @@ <h2 id="borneo.core/single-rel">single-rel</h2>
Valid directions are :in :out and :both, defaults to :out.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L511" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L544" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -570,7 +576,7 @@ <h2 id="borneo.core/start!">start!</h2>
Do not use this function, use with-db! or with-local-db! instead.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L230" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L252" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -581,7 +587,7 @@ <h2 id="borneo.core/start-node">start-node</h2>
<pre id="var-docstr">Returns start node for given relationship.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L417" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L450" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -593,7 +599,7 @@ <h2 id="borneo.core/stop!">stop!</h2>
Do not use this function, use with-db! or with-local-db! instead.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L239" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L261" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -625,7 +631,7 @@ <h2 id="borneo.core/traverse">traverse</h2>
relation type keywords and values are directions (:in or :out).</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L605" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L638" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -638,7 +644,7 @@ <h2 id="borneo.core/walk">walk</h2>
Throws NotFoundException if path is ambiguous.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L596" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L629" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -651,7 +657,7 @@ <h2 id="borneo.core/with-db!">with-db!</h2>
not call this macro often. Also note that this macro is not threadsafe.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L246" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L268" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -668,7 +674,7 @@ <h2 id="borneo.core/with-local-db!">with-local-db!</h2>
this function together with with-db! in one program.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L260" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L282" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -683,7 +689,7 @@ <h2 id="borneo.core/with-tx">with-tx</h2>
functions into a bigger transactions.</pre>
- <a href="http://github.com/wagjo/borneo/blob/21930ea7b909e10254fb3a62d200b094929d05cd/src/borneo/core.clj#L276" id="var-source">Source</a>
+ <a href="http://github.com/wagjo/borneo/blob/b8bca3797d9d191983a416ec1a8610971d372d65/src/borneo/core.clj#L298" id="var-source">Source</a>
</div>

0 comments on commit 4fb65de

Please sign in to comment.