summaryrefslogtreecommitdiff
path: root/example-syntax.api
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2019-02-05 22:35:04 +0100
committerBen Beltran <ben@nsovocal.com>2019-02-05 22:35:04 +0100
commit55ab0586626b0a833e7b3801164699e4b3a640c2 (patch)
tree7ebd3f76327b8d9f5e4840592ce3f37e9fe63827 /example-syntax.api
parent4549164147a331c583651f87d3d0490eb0a0397f (diff)
parentb1cf6d7ccd532b35c845ba93170996f700ce59a7 (diff)
Merge branch 'release/1.0.0'1.0.0
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>)