From 5b60c95f3254a3e14a9b967175fbf19e1ff76774 Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com>
Date: Tue, 26 Sep 2017 10:30:54 -0400
Subject: [PATCH] docs: added @InVertex and @OutVertex to the docs.

---
 docs/annotations/invertex.md  | 32 ++++++++++++++++++++++++++++++++
 docs/annotations/outvertex.md | 32 ++++++++++++++++++++++++++++++++
 docs/annotations/property.md  |  2 --
 mkdocs.yml                    |  2 ++
 4 files changed, 66 insertions(+), 2 deletions(-)
 create mode 100644 docs/annotations/invertex.md
 create mode 100644 docs/annotations/outvertex.md

diff --git a/docs/annotations/invertex.md b/docs/annotations/invertex.md
new file mode 100644
index 00000000..2f60f318
--- /dev/null
+++ b/docs/annotations/invertex.md
@@ -0,0 +1,32 @@
+Valid on frames: **Edge**
+
+Allowed prefixes when operation is AUTO: `get`
+
+The `@InVertex` takes no parameters and is used only on get methods that themself take no parameters. It specifies the
+`VertexFrame` at the head of an edge.
+
+example:
+
+```java
+@InVertex
+//Method declared here
+```
+
+
+## GET Operation
+
+Valid method signatures: `( )`
+
+
+### Signature: `( )`
+
+Valid return types: `VertexFrame`.
+
+Get the head vertex of the edge.
+
+example:
+
+```java
+@InVertex
+BarVertex getFoobar();
+```
diff --git a/docs/annotations/outvertex.md b/docs/annotations/outvertex.md
new file mode 100644
index 00000000..0bd72a8e
--- /dev/null
+++ b/docs/annotations/outvertex.md
@@ -0,0 +1,32 @@
+Valid on frames: **Edge**
+
+Allowed prefixes when operation is AUTO: `get`
+
+The `@OutVertex` takes no parameters and is used only on get methods that themself take no parameters. It specifies the
+`VertexFrame` at the tail of an edge.
+
+example:
+
+```java
+@OutVertex
+//Method declared here
+```
+
+
+## GET Operation
+
+Valid method signatures: `( )`
+
+
+### Signature: `( )`
+
+Valid return types: `VertexFrame`.
+
+Get the tail vertex of the edge.
+
+example:
+
+```java
+@OutVertex
+BarVertex getFoobar();
+```
diff --git a/docs/annotations/property.md b/docs/annotations/property.md
index 941fd2dd..920bcc97 100644
--- a/docs/annotations/property.md
+++ b/docs/annotations/property.md
@@ -11,8 +11,6 @@ Defaults to `AUTO`.
 
 The following would bind the method it is used on to the property named `foo`:
 
-example:
-
 ```java
 @Property("foo")
 //Method declared here
diff --git a/mkdocs.yml b/mkdocs.yml
index f36ab922..79a25fa6 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -17,6 +17,8 @@ pages:
         - '@Adjacency': annotations/adjacency.md
         - '@GraphElement': annotations/graphelement.md
         - '@Incidence': annotations/incidence.md
+        - '@InVertex': annotations/invertex.md
+        - '@OutVertex': annotations/outvertex.md
         - '@Property': annotations/property.md
     - Glossary: glossary.md
 extra:
-- 
GitLab