Unverified Commit 6adf8a64 authored by Jeffrey Phillips Freeman's avatar Jeffrey Phillips Freeman 💥
Browse files

docs: added direction annotationa rgument to several examples in the docs.

parent e7d1c398
......@@ -47,7 +47,7 @@ VertexFrame addFoobar();
```java
@Adjacency(value = "Foo", operation = Adjacency.Operation.ADD)
VertexFrame addFoobar();
VertexFrame includeFoobar();
```
......@@ -72,7 +72,7 @@ BarVertex addFoobar(BarVertex existingVertex);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends VertexFrame> E addFoobar(E existingVertex);
```
......@@ -102,7 +102,7 @@ BarVertex addFoobar(ClassInitializer<? extends BarVertex> vertexInitializer);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends VertexFrame> E addFoobar(ClassInitializer<? extends E> vertexInitializer);
```
......@@ -135,7 +135,7 @@ BarVertex addFoobar(ClassInitializer<? extends BarVertex> vertexInitializer,
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends VertexFrame> E addFoobar(ClassInitializer<? extends E> vertexInitializer,
ClassInitializer<? extends FooEdge> edgeInitializer);
```
......@@ -170,7 +170,7 @@ BarVertex addFoobar(BarVertex vertex,
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends VertexFrame> E addFoobar(BarVertex vertex,
ClassInitializer<? extends FooEdge> edgeInitializer);
```
......@@ -240,7 +240,7 @@ List<BarVertex> getFoobar();
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
Set<BarVertex> getFoobar();
```
......@@ -300,7 +300,7 @@ List<BarVertex> getFoobar(Class<? extends BarVertex> filter);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
Set<BarVertex> getFoobar(Class<? extends BarVertex> filter);
```
......@@ -355,7 +355,7 @@ void removeFoobar(BarVertex vertex);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends VertexFrame> void removeFoobar(E vertex);
```
......@@ -390,7 +390,7 @@ void setFoobar(BarVertex vertex);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends BarVertex> void setFoobar(E vertex);
```
......@@ -420,13 +420,13 @@ void setFoobar(Iterator<BaBarVertexr> vertex);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends BarVertex> void setFoobar(Iterator<? extends E> vertex);
```
```java
@Adjacency("Foo")
<E extends VertexFrame> void setFoobar(Iterator<? extends E> vertex);
@Adjacency("Foo", operation = Adjacency.Operation.SET)
<E extends VertexFrame> void includeFoobar(Iterator<? extends E> vertex);
```
### Signature: `(Iterable)`
......@@ -467,12 +467,12 @@ void setFoobar(Set<BarVertex> vertex);
```
```java
@Adjacency("Foo")
@Adjacency("Foo", direction = Direction.IN)
<E extends BarVertex> void setFoobar(Iterable<? extends E> vertex);
```
```java
@Adjacency("Foo")
<E extends VertexFrame> void setFoobar(Iterable<? extends E> vertex);
@Adjacency("Foo", operation = Adjacency.Operation.SET)
<E extends VertexFrame> void includeFoobar(Iterable<? extends E> vertex);
```
......@@ -72,7 +72,7 @@ EdgeFrame addFoobar(BarVertex existingVertex);
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
<E extends EdgeFrame> E addFoobar(BarVertex existingVertex);
```
......@@ -103,7 +103,7 @@ FooEdge addFoobar(ClassInitializer<? extends FooEdge> vertexInitializer);
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
<E extends FooEdge> E addFoobar(ClassInitializer<? extends BarVertex> vertexInitializer);
```
......@@ -135,7 +135,7 @@ FooEdge addFoobar(BarVertex bar,
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
<E extends EdgeFrame> E addFoobar(VertexFrame vertex,
ClassInitializer<? extends E> edgeInitializer);
```
......@@ -170,7 +170,7 @@ FooEdge addFoobar(ClassInitializer<? extends BarVertex> vertexInitializer,
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
<E extends EdgeFrame> E addFoobar(ClassInitializer<? extends BarVertex> vertexInitializer,
ClassInitializer<? extends E> edgeInitializer);
```
......@@ -240,7 +240,7 @@ List<FooEdge> getFoobar();
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
Set<FooEdge> getFoobar();
```
......@@ -300,7 +300,7 @@ List<FooEdge> getFoobar(Class<? extends FooEdge> filter);
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
Set<FooEdge> getFoobar(Class<? extends FooEdge> filter);
```
......@@ -335,7 +335,7 @@ void removeFoobar(FooEdge edge);
```
```java
@Incidence("Foo")
@Incidence("Foo", direction = Direction.IN)
<E extends EdgeFrame> void removeFoobar(E edge);
```
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment