aboutsummaryrefslogtreecommitdiff
path: root/example-syntax.api
blob: ecc4c3c54fa8d709130e4ac7955a87e412400916 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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>)