xref: /aosp_15_r20/frameworks/base/libs/WindowManager/Shell/src/com/android/wm/shell/docs/patterns/TEMPLATE.md (revision d57664e9bc4670b3ecf6748a746a57c557b6bc9e)
1# Pattern (one line description)
2
3### What this pattern solves
4
5Give detailed information about the problem that this pattern addresses, include when it
6should/should not be used.
7
8### How it works
9
10Give a high level overview of how this pattern works technically with sufficient links for the
11relevant dependencies for folks to read more.
12
13### Code examples
14
15Explain how this pattern is used in code.
16
17File.kt:
18```kotlin
19fun someFunction() {
20    // Use this code
21}
22```
23
24### Relevant links
25
26Add relevant links to other files that implement this pattern, design docs, or other important
27info.
28
29Link 1: [More info](some_example_link) \
30Link 2: [More info](some_example_link)