aboutsummaryrefslogtreecommitdiff
path: root/test/highlight/notation.api
blob: f161647212c80f415dac001309618c522381cf01 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
Forum.Models.Post
// <- type.definition
//    ^ type.definition
//           ^ type.definition
  +glyphs <Array<String>>
  //<- operator
  //^ method
  //      ^ punctuation
  //       ^ type.definition
  //            ^ punctuation
  //             ^ type.definition
  //                    ^ punctuation

  -id <UUID>
  -created_at <Date>
  -parent_id <UUID>
  -text <String>
  -author <Author>
  ~>textUpdated(text <String>)
  //<- operator
  //^ method
  //           ^ function
  //            ^ parameter
  //                 ^ punctuation
  //                  ^ type.definition
  //                        ^ punctuation
  //                         ^ function
  ->authorUpdated(author <Author>)
  <~textWillUpdate(text <String>)
  <-postWillRender(post <Forum.Models.Post>)
  +>authorUpdated(author <Author>)
  <+textWillUpdate(text <String>)
  ::getAll(parent_id <UUID>) => Promise<Array<Forum.Models.Post>> #> NotFoundError,DisplayError
  //<- operator
  //^ method
  //      ^ function
  //       ^ parameter
  //                 ^ punctuation
  //                  ^ type.definition
  //                      ^ punctuation
  //                       ^ function
  //                         ^ operator
  //                            ^ type.definition
  //                                                              ^ operator
  //                                                                 ^ type.definition
  ::get(id <UUID>) => Promise<Forum.Models.Post>
  #update(text <String>) => Promise<void>
  #transform([transformer] <Function<T>(T) => boolean>)
  //<- operator
  //^ method
  //        ^ function
  //          ^ parameter.optional
  //                       ^ punctuation
  //                        ^ type.definition