aboutsummaryrefslogtreecommitdiff
path: root/example-syntax.api
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2015-09-05 15:35:42 -0500
committerBen Beltran <ben@nsovocal.com>2015-09-05 15:35:42 -0500
commit76da60c63cc6623c9da9929d01cc7cf3420bb031 (patch)
tree86440c05be0551199702b783a9b7a85f6c8f2c22 /example-syntax.api
parent3421ec3df3e3350f2a931a30798cae65230a8d0c (diff)
Adds example notation for testing
Diffstat (limited to 'example-syntax.api')
-rw-r--r--example-syntax.api18
1 files changed, 18 insertions, 0 deletions
diff --git a/example-syntax.api b/example-syntax.api
new file mode 100644
index 0000000..ecc4c3c
--- /dev/null
+++ b/example-syntax.api
@@ -0,0 +1,18 @@
+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>)