Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@OlenaPostindustria
OlenaPostindustria committed Aug 9, 2024
1 parent 5f59dc7 commit 061264b
Show file tree
Hide file tree
Showing 186 changed files with 13,572 additions and 22,268 deletions.
256 changes: 110 additions & 146 deletions docs/Classes.html
View file

Large diffs are not rendered by default.

132 changes: 80 additions & 52 deletions docs/Classes/AdFormat.html
View file

Large diffs are not rendered by default.

358 changes: 299 additions & 59 deletions docs/Classes/AdUnit.html
View file

Large diffs are not rendered by default.

106 changes: 65 additions & 41 deletions docs/Classes/BannerAdUnit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="BannerAdUnit Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">PrebidMobile 2.2.3 Docs</a> (27% documented)</p>
<p><a href="../index.html">PrebidMobile 2.2.3 Docs</a> (94% documented)</p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -88,23 +88,20 @@
<li class="nav-group-task">
<a href="../Classes/InterstitialAdUnit.html">InterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/InterstitialController.html">InterstitialController</a>
</li>
<li class="nav-group-task">
<a href="../Classes/InterstitialRenderingAdUnit.html">InterstitialRenderingAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationBannerAdUnit.html">MediationBannerAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationInterstitialAdUnit.html">MediationInterstitialAdUnit</a>
<a href="../Classes/MediationBaseInterstitialAdUnit.html">MediationBaseInterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationNativeAdUnit.html">MediationNativeAdUnit</a>
<a href="../Classes/MediationInterstitialAdUnit.html">MediationInterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationNativeUtils.html">MediationNativeUtils</a>
<a href="../Classes/MediationNativeAdUnit.html">MediationNativeAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationRewardedAdUnit.html">MediationRewardedAdUnit</a>
Expand Down Expand Up @@ -254,36 +251,15 @@
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/BannerBasedAdUnitProtocol.html">BannerBasedAdUnitProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/BannerEventHandler.html">BannerEventHandler</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/BannerViewDelegate.html">BannerViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/BaseInterstitialAdUnitProtocol.html">BaseInterstitialAdUnitProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/DisplayViewInteractionDelegate.html">DisplayViewInteractionDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/DisplayViewLoadingDelegate.html">DisplayViewLoadingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialAdUnitDelegate.html">InterstitialAdUnitDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialControllerInteractionDelegate.html">InterstitialControllerInteractionDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialControllerLoadingDelegate.html">InterstitialControllerLoadingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialEventHandlerProtocol.html">InterstitialEventHandlerProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/NativeAdDelegate.html">NativeAdDelegate</a>
</li>
Expand All @@ -299,9 +275,6 @@
<li class="nav-group-task">
<a href="../Protocols/RewardedEventHandlerProtocol.html">RewardedEventHandlerProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/VideoBasedAdUnitProtocol.html">VideoBasedAdUnitProtocol</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -321,11 +294,11 @@ <h1>BannerAdUnit</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BannerAdUnit</span> <span class="p">:</span> <span class="kt"><a href="../Classes/AdUnit.html">AdUnit</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/BannerBasedAdUnitProtocol.html">BannerBasedAdUnitProtocol</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/VideoBasedAdUnitProtocol.html">VideoBasedAdUnitProtocol</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BannerAdUnit</span> <span class="p">:</span> <span class="kt"><a href="../Classes/AdUnit.html">AdUnit</a></span><span class="p">,</span> <span class="kt">BannerBasedAdUnitProtocol</span><span class="p">,</span> <span class="kt">VideoBasedAdUnitProtocol</span></code></pre>

</div>
</div>
<p>Undocumented</p>
<p>A class representing a banner ad unit for original type of integration.</p>

</section>
<section class="section task-group-section">
Expand All @@ -344,14 +317,15 @@ <h1>BannerAdUnit</h1>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>A deprecated property for banner ad parameters.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Classes/BannerParameters.html">BannerParameters</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"This property is deprecated. Please, use bannerParameters instead."</span><span class="p">)</span>
<span class="kd">public</span> <span class="k">var</span> <span class="nv">parameters</span><span class="p">:</span> <span class="kt"><a href="../Classes/BannerParameters.html">BannerParameters</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

</div>
</div>
Expand All @@ -371,7 +345,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The banner ad parameters used to configure the ad unit.</p>

</div>
<div class="declaration">
Expand All @@ -398,7 +372,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The video ad parameters used to configure the ad unit.</p>

</div>
<div class="declaration">
Expand All @@ -425,7 +399,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The set of ad formats for the ad unit.</p>

</div>
<div class="declaration">
Expand All @@ -452,7 +426,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Initializes a new <code>BannerAdUnit</code> with the specified configuration ID and size.</p>

</div>
<div class="declaration">
Expand All @@ -463,6 +437,37 @@ <h4>Declaration</h4>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>configId</em>
</code>
</td>
<td>
<div>
<p>The unique identifier for the ad unit configuration.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>size</em>
</code>
</td>
<td>
<div>
<p>The size of the banner ad unit.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
Expand All @@ -479,7 +484,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Adds additional sizes to the banner ad unit&rsquo;s configuration.</p>

</div>
<div class="declaration">
Expand All @@ -490,6 +495,25 @@ <h4>Declaration</h4>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>sizes</em>
</code>
</td>
<td>
<div>
<p>An array of <code>CGSize</code> objects representing additional sizes.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
Expand All @@ -498,7 +522,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-08-06)</p>
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-08-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
45 changes: 9 additions & 36 deletions docs/Classes/BannerParameters.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="BannerParameters Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">PrebidMobile 2.2.3 Docs</a> (27% documented)</p>
<p><a href="../index.html">PrebidMobile 2.2.3 Docs</a> (94% documented)</p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -88,23 +88,20 @@
<li class="nav-group-task">
<a href="../Classes/InterstitialAdUnit.html">InterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/InterstitialController.html">InterstitialController</a>
</li>
<li class="nav-group-task">
<a href="../Classes/InterstitialRenderingAdUnit.html">InterstitialRenderingAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationBannerAdUnit.html">MediationBannerAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationInterstitialAdUnit.html">MediationInterstitialAdUnit</a>
<a href="../Classes/MediationBaseInterstitialAdUnit.html">MediationBaseInterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationNativeAdUnit.html">MediationNativeAdUnit</a>
<a href="../Classes/MediationInterstitialAdUnit.html">MediationInterstitialAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationNativeUtils.html">MediationNativeUtils</a>
<a href="../Classes/MediationNativeAdUnit.html">MediationNativeAdUnit</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MediationRewardedAdUnit.html">MediationRewardedAdUnit</a>
Expand Down Expand Up @@ -254,36 +251,15 @@
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/BannerBasedAdUnitProtocol.html">BannerBasedAdUnitProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/BannerEventHandler.html">BannerEventHandler</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/BannerViewDelegate.html">BannerViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/BaseInterstitialAdUnitProtocol.html">BaseInterstitialAdUnitProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/DisplayViewInteractionDelegate.html">DisplayViewInteractionDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/DisplayViewLoadingDelegate.html">DisplayViewLoadingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialAdUnitDelegate.html">InterstitialAdUnitDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialControllerInteractionDelegate.html">InterstitialControllerInteractionDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialControllerLoadingDelegate.html">InterstitialControllerLoadingDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/InterstitialEventHandlerProtocol.html">InterstitialEventHandlerProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/NativeAdDelegate.html">NativeAdDelegate</a>
</li>
Expand All @@ -299,9 +275,6 @@
<li class="nav-group-task">
<a href="../Protocols/RewardedEventHandlerProtocol.html">RewardedEventHandlerProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/VideoBasedAdUnitProtocol.html">VideoBasedAdUnitProtocol</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand Down Expand Up @@ -372,7 +345,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Min width percentage value for interstitial</p>

</div>
<div class="declaration">
Expand All @@ -399,7 +372,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Min height percentage value for interstitial</p>

</div>
<div class="declaration">
Expand All @@ -426,7 +399,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Ad sizes of the ad</p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -466,7 +439,7 @@ <h3 class="section-name"><span>Helpers</span>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Helper for <code><a href="../Classes/BannerParameters.html#/c:@M@PrebidMobile@objc(cs)BannerParameters(py)api">api</a></code> values</p>

</div>
<div class="declaration">
Expand All @@ -485,7 +458,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-08-06)</p>
<p>&copy; 2024 <a class="link" href="https://www.prebid.org" target="_blank" rel="external noopener">Prebid</a>. All rights reserved. (Last updated: 2024-08-09)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 061264b

Please sign in to comment.