]> git.r.bdr.sh - rbdr/dotfiles/blame - atom/packages/api-notation/example-syntax.api
Update atoms
[rbdr/dotfiles] / atom / packages / api-notation / example-syntax.api
CommitLineData
455f099b
BB
1HypotheticalModule <IModuleInterface>
2 +staticProperty <String>
3 +anotherStaticProperty <Boolean>
4 ::toggleAnotherStaticProperty()
5 ::setStaticProperty(newValue <String>)
6 -instanceProperty <Number>
7 -anotherInstanceProperty <String>
8 #instanceMethodSync([optionalParameter]<Boolean>) => resultOfCall <String>
9 #instanceMethodAsync(someValue <Number>, [callback] <Function>) ->(error <String|null>, result <Number|null>)
10
11
12// Comment
13EventHypotheticalClass
14 +>AnotherClass<+staticEventToListen(eventData <PredefinedObject>) // More Comments
15 <+staticEventDispatched(someData <SomeData>)
16 ~>listenedSocketEvent(eventData <SomeObject>)
17 <~dispatchedSocketEvent(eventData <BlaBla>)
18 ->AnotherClass<-instanceEventToListen(eventData <Object>)
19 <-instanceEventDispatched(specificDataType <DefinedObject>)