]> git.r.bdr.sh - rbdr/api-notation-atom/commitdiff
Adds example API notation file for testing
authorBen Beltran <redacted>
Sat, 5 Sep 2015 19:03:22 +0000 (14:03 -0500)
committerBen Beltran <redacted>
Sat, 5 Sep 2015 19:03:22 +0000 (14:03 -0500)
example-syntax.api [new file with mode: 0644]

diff --git a/example-syntax.api b/example-syntax.api
new file mode 100644 (file)
index 0000000..8c52870
--- /dev/null
@@ -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>)