From acbd7ddf4e2f2a5162a6080fdd0fd3635636c900 Mon Sep 17 00:00:00 2001
From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com>
Date: Tue, 26 Sep 2017 09:54:56 -0400
Subject: [PATCH] docs: added @GraphElement to the docs.
---
docs/annotations/graphelement.md | 13 +++++++++++++
mkdocs.yml | 1 +
2 files changed, 14 insertions(+)
create mode 100644 docs/annotations/graphelement.md
diff --git a/docs/annotations/graphelement.md b/docs/annotations/graphelement.md
new file mode 100644
index 00000000..e57a012f
--- /dev/null
+++ b/docs/annotations/graphelement.md
@@ -0,0 +1,13 @@
+Valid on frames: **Edge** and **vertex**
+
+The `@GraphElement` annotation takes no parameters and is placed before your class decleration on an `EdgeFrame` or
+`VertexFrame`. This annotation is mostly leveraged right now when scanning classes in a package to identify frames.
+
+example:
+
+```java
+@GraphElement
+public interface FooVertex extends VertexFrame {
+ //Methods goes here
+}
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 882c2633..f36ab922 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -15,6 +15,7 @@ pages:
- Core Annotations:
- Overview: annotations/overview.md
- '@Adjacency': annotations/adjacency.md
+ - '@GraphElement': annotations/graphelement.md
- '@Incidence': annotations/incidence.md
- '@Property': annotations/property.md
- Glossary: glossary.md
--
GitLab