aboutsummaryrefslogtreecommitdiff
path: root/example-syntax.api
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2015-09-05 14:03:22 -0500
committerBen Beltran <ben@nsovocal.com>2015-09-05 14:03:22 -0500
commitcbfc88790b27d31ecd58590db502a09b6f0cac7a (patch)
tree20313b55dec95cd42a6681efd656862268d9eff3 /example-syntax.api
parent52942a9aaf674980c47e1d074466a3d833decc38 (diff)
Adds example API notation file for testing
Diffstat (limited to 'example-syntax.api')
-rw-r--r--example-syntax.api19
1 files changed, 19 insertions, 0 deletions
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>)