Commit c81ff7c
committed
Docs: Improve KDoc for public API
This commit enhances the KDoc documentation across several public API classes and handlers to improve clarity and developer experience.
* **Ad Handlers:**
* Added `@property` documentation for the `state` property in `InterstitialAdHandler`, `RewardedAdHandler`, and `RewardedInterstitialAdHandler`.
* Added `@property` documentation for `state` and `adSize` in `BannerAdHandler`.
* **`RewardItem`:**
* Added a class-level KDoc summary and `@property` documentation for `amount` and `type`.
* **`RequestConfiguration`:**
* Added descriptive comments for all constants related to child-directed treatment, age of consent, and maximum ad content rating.
* **`ConsentDebugSettings`:**
* Updated the KDoc for the `DebugGeography` enum to use `@property` tags for better readability in generated documentation.1 parent 4ba1a90 commit c81ff7c
7 files changed
Lines changed: 29 additions & 6 deletions
File tree
- basic-ads/src/commonMain/kotlin/app/lexilabs/basic/ads
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| 57 | + | |
| 58 | + | |
57 | 59 | | |
58 | 60 | | |
59 | 61 | | |
| |||
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
99 | | - | |
100 | | - | |
101 | | - | |
102 | | - | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
| |||
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| |||
Lines changed: 11 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
| 40 | + | |
40 | 41 | | |
| 42 | + | |
41 | 43 | | |
| 44 | + | |
42 | 45 | | |
| 46 | + | |
43 | 47 | | |
| 48 | + | |
44 | 49 | | |
| 50 | + | |
45 | 51 | | |
| 52 | + | |
46 | 53 | | |
| 54 | + | |
47 | 55 | | |
| 56 | + | |
48 | 57 | | |
| 58 | + | |
49 | 59 | | |
| 60 | + | |
50 | 61 | | |
51 | 62 | | |
52 | 63 | | |
| |||
Lines changed: 8 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
3 | 9 | | |
| 10 | + | |
4 | 11 | | |
| 12 | + | |
5 | 13 | | |
6 | 14 | | |
7 | | - | |
| |||
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| 35 | + | |
35 | 36 | | |
36 | 37 | | |
37 | 38 | | |
| |||
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| 35 | + | |
35 | 36 | | |
36 | 37 | | |
37 | 38 | | |
| |||
0 commit comments