]> git.r.bdr.sh - rbdr/api-notation.vim/commitdiff
Updates example for module data types and comments
authorBen Beltran <redacted>
Sat, 5 Sep 2015 19:16:44 +0000 (14:16 -0500)
committerBen Beltran <redacted>
Sat, 5 Sep 2015 19:16:44 +0000 (14:16 -0500)
example-syntax.api

index 670be570e7e3fcb3484a6075fbb7042cbe92e787..8c5287055dd339c6ae8bcb0a84fc0cdd2388ed39 100644 (file)
@@ -1,4 +1,4 @@
-HypotheticalModule
+HypotheticalModule <IModuleInterface>
   +staticProperty <String>
   +anotherStaticProperty <Boolean>
   ::toggleAnotherStaticProperty()
@@ -8,8 +8,10 @@ HypotheticalModule
   #instanceMethodSync([optionalParameter]<Boolean>) => resultOfCall <String>
   #instanceMethodAsync(someValue <Number>, [callback] <Function>) ->(error <String|null>, result <Number|null>)
 
+
+// Comment
 EventHypotheticalClass
-  +>AnotherClass<+staticEventToListen(eventData <PredefinedObject>)
+  +>AnotherClass<+staticEventToListen(eventData <PredefinedObject>) // More Comments
   <+staticEventDispatched(someData <SomeData>)
   ~>listenedSocketEvent(eventData <SomeObject>)
   <~dispatchedSocketEvent(eventData <BlaBla>)