From cbfc88790b27d31ecd58590db502a09b6f0cac7a Mon Sep 17 00:00:00 2001
From: Ben Beltran <ben@nsovocal.com>
Date: Sat, 5 Sep 2015 14:03:22 -0500
Subject: Adds example API notation file for testing

---
 example-syntax.api | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 example-syntax.api

(limited to 'example-syntax.api')

diff --git a/example-syntax.api b/example-syntax.api
new file mode 100644
index 0000000..8c52870
--- /dev/null
+++ b/example-syntax.api
@@ -0,0 +1,19 @@
+HypotheticalModule <IModuleInterface>
+  +staticProperty <String>
+  +anotherStaticProperty <Boolean>
+  ::toggleAnotherStaticProperty()
+  ::setStaticProperty(newValue <String>)
+  -instanceProperty <Number>
+  -anotherInstanceProperty <String>
+  #instanceMethodSync([optionalParameter]<Boolean>) => resultOfCall <String>
+  #instanceMethodAsync(someValue <Number>, [callback] <Function>) ->(error <String|null>, result <Number|null>)
+
+
+// Comment
+EventHypotheticalClass
+  +>AnotherClass<+staticEventToListen(eventData <PredefinedObject>) // More Comments
+  <+staticEventDispatched(someData <SomeData>)
+  ~>listenedSocketEvent(eventData <SomeObject>)
+  <~dispatchedSocketEvent(eventData <BlaBla>)
+  ->AnotherClass<-instanceEventToListen(eventData <Object>)
+  <-instanceEventDispatched(specificDataType <DefinedObject>)
-- 
cgit