feat: add description to all packages

prebid · Aug 6, 2024 · 8b66834 · 8b66834
1 parent daf773b
commit 8b66834
Show file tree

Hide file tree

Showing 155 changed files with 364 additions and 218 deletions.
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Classes and Interfaces (PrebidMobile API)</title>
+<title>All Classes and Interfaces (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="class index">

diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>All Packages (PrebidMobile API)</title>
+<title>All Packages (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="package index">
@@ -55,29 +55,55 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="table-header col-first">Package</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><a href="com/applovin/mediation/adapters/package-summary.html">com.applovin.mediation.adapters</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Adapters for AppLovin MAX mediation integration of the Prebid SDK.</div>
+</div>
 <div class="col-first odd-row-color"><a href="org/prebid/mobile/package-summary.html">org.prebid.mobile</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Root package with ad units for the 'original API'
+ integration of the SDK and common classes for all SDK.</div>
+</div>
 <div class="col-first even-row-color"><a href="org/prebid/mobile/admob/package-summary.html">org.prebid.mobile.admob</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Adapters for AdMob mediation integration of the Prebid SDK.</div>
+</div>
 <div class="col-first odd-row-color"><a href="org/prebid/mobile/api/data/package-summary.html">org.prebid.mobile.api.data</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Common data classes for the SDK integration.</div>
+</div>
 <div class="col-first even-row-color"><a href="org/prebid/mobile/api/exceptions/package-summary.html">org.prebid.mobile.api.exceptions</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Common exceptions.</div>
+</div>
 <div class="col-first odd-row-color"><a href="org/prebid/mobile/api/mediation/package-summary.html">org.prebid.mobile.api.mediation</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Ad units for the mediation integration of the SDK.</div>
+</div>
 <div class="col-first even-row-color"><a href="org/prebid/mobile/api/mediation/listeners/package-summary.html">org.prebid.mobile.api.mediation.listeners</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Listeners for the mediation integration.</div>
+</div>
 <div class="col-first odd-row-color"><a href="org/prebid/mobile/api/original/package-summary.html">org.prebid.mobile.api.original</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Universal Prebid ad unit for multi-format request
+ with access to the bid response data.</div>
+</div>
 <div class="col-first even-row-color"><a href="org/prebid/mobile/api/rendering/package-summary.html">org.prebid.mobile.api.rendering</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Ad units for the rendering integration of the SDK.</div>
+</div>
 <div class="col-first odd-row-color"><a href="org/prebid/mobile/api/rendering/listeners/package-summary.html">org.prebid.mobile.api.rendering.listeners</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Listeners for the rendering API integration.</div>
+</div>
 <div class="col-first even-row-color"><a href="org/prebid/mobile/api/rendering/pluginrenderer/package-summary.html">org.prebid.mobile.api.rendering.pluginrenderer</a></div>
-<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-last even-row-color">
+<div class="block">Package for configuring custom rendering plugins.</div>
+</div>
 <div class="col-first odd-row-color"><a href="org/prebid/mobile/eventhandlers/package-summary.html">org.prebid.mobile.eventhandlers</a></div>
-<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-last odd-row-color">
+<div class="block">Adapters for Google Ad Manager mediation integration of the Prebid SDK.</div>
+</div>
 </div>
 </main>
 </div>

diff --git a/docs/com/applovin/mediation/adapters/PrebidMaxMediationAdapter.html b/docs/com/applovin/mediation/adapters/PrebidMaxMediationAdapter.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>PrebidMaxMediationAdapter (PrebidMobile API)</title>
+<title>PrebidMaxMediationAdapter (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: com.applovin.mediation.adapters, class: PrebidMaxMediationAdapter">

diff --git a/docs/com/applovin/mediation/adapters/package-summary.html b/docs/com/applovin/mediation/adapters/package-summary.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>com.applovin.mediation.adapters (PrebidMobile API)</title>
+<title>com.applovin.mediation.adapters (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="declaration: package: com.applovin.mediation.adapters">
@@ -40,7 +40,7 @@
 <div>
 <ul class="sub-nav-list">
 <li>Package:&nbsp;</li>
-<li>Description&nbsp;|&nbsp;</li>
+<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
 <li>Related Packages&nbsp;|&nbsp;</li>
 <li><a href="#class-summary">Classes and Interfaces</a></li>
 </ul>
@@ -60,6 +60,9 @@ <h1 title="Package com.applovin.mediation.adapters" class="title">Package com.ap
 </div>
 <hr>
 <div class="package-signature">package <span class="element-name">com.applovin.mediation.adapters</span></div>
+<section class="package-description" id="package-description">
+<div class="block">Adapters for AppLovin MAX mediation integration of the Prebid SDK.</div>
+</section>
 <section class="summary">
 <ul class="summary-list">
 <li>

diff --git a/docs/com/applovin/mediation/adapters/package-tree.html b/docs/com/applovin/mediation/adapters/package-tree.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>com.applovin.mediation.adapters Class Hierarchy (PrebidMobile API)</title>
+<title>com.applovin.mediation.adapters Class Hierarchy (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="tree: package: com.applovin.mediation.adapters">

diff --git a/docs/constant-values.html b/docs/constant-values.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Constant Field Values (PrebidMobile API)</title>
+<title>Constant Field Values (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="summary of constants">

diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Deprecated List (PrebidMobile API)</title>
+<title>Deprecated List (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="deprecated elements">

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>API Help (PrebidMobile API)</title>
+<title>API Help (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="help">

diff --git a/docs/index-all.html b/docs/index-all.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Index (PrebidMobile API)</title>
+<title>Index (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="index">
@@ -602,7 +602,9 @@ <h2 class="title" id="I:C">C</h2>
 <dt><a href="org/prebid/mobile/api/rendering/InterstitialView.html#closeInterstitialVideo()" class="member-name-link">closeInterstitialVideo()</a> - Method in class org.prebid.mobile.api.rendering.<a href="org/prebid/mobile/api/rendering/InterstitialView.html" title="class in org.prebid.mobile.api.rendering">InterstitialView</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="com/applovin/mediation/adapters/package-summary.html">com.applovin.mediation.adapters</a> - package com.applovin.mediation.adapters</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Adapters for AppLovin MAX mediation integration of the Prebid SDK.</div>
+</dd>
 <dt><a href="org/prebid/mobile/AdUnit.html#configuration" class="member-name-link">configuration</a> - Variable in class org.prebid.mobile.<a href="org/prebid/mobile/AdUnit.html" title="class in org.prebid.mobile">AdUnit</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/prebid/mobile/admob/PrebidNativeAdMapper.html#configure(MediationNativeAdConfiguration,%3Cany%3E)" class="member-name-link">configure(MediationNativeAdConfiguration, &lt;any&gt;)</a> - Method in class org.prebid.mobile.admob.<a href="org/prebid/mobile/admob/PrebidNativeAdMapper.html" title="class in org.prebid.mobile.admob">PrebidNativeAdMapper</a></dt>
@@ -2287,27 +2289,51 @@ <h2 class="title" id="I:O">O</h2>
 <dt><a href="org/prebid/mobile/api/rendering/InterstitialView.html#onWindowFocusChanged(boolean)" class="member-name-link">onWindowFocusChanged(boolean)</a> - Method in class org.prebid.mobile.api.rendering.<a href="org/prebid/mobile/api/rendering/InterstitialView.html" title="class in org.prebid.mobile.api.rendering">InterstitialView</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="org/prebid/mobile/package-summary.html">org.prebid.mobile</a> - package org.prebid.mobile</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Root package with ad units for the 'original API'
+ integration of the SDK and common classes for all SDK.</div>
+</dd>
 <dt><a href="org/prebid/mobile/admob/package-summary.html">org.prebid.mobile.admob</a> - package org.prebid.mobile.admob</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Adapters for AdMob mediation integration of the Prebid SDK.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/data/package-summary.html">org.prebid.mobile.api.data</a> - package org.prebid.mobile.api.data</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Common data classes for the SDK integration.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/exceptions/package-summary.html">org.prebid.mobile.api.exceptions</a> - package org.prebid.mobile.api.exceptions</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Common exceptions.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/mediation/package-summary.html">org.prebid.mobile.api.mediation</a> - package org.prebid.mobile.api.mediation</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Ad units for the mediation integration of the SDK.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/mediation/listeners/package-summary.html">org.prebid.mobile.api.mediation.listeners</a> - package org.prebid.mobile.api.mediation.listeners</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Listeners for the mediation integration.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/original/package-summary.html">org.prebid.mobile.api.original</a> - package org.prebid.mobile.api.original</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Universal Prebid ad unit for multi-format request
+ with access to the bid response data.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/rendering/package-summary.html">org.prebid.mobile.api.rendering</a> - package org.prebid.mobile.api.rendering</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Ad units for the rendering integration of the SDK.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/rendering/listeners/package-summary.html">org.prebid.mobile.api.rendering.listeners</a> - package org.prebid.mobile.api.rendering.listeners</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Listeners for the rendering API integration.</div>
+</dd>
 <dt><a href="org/prebid/mobile/api/rendering/pluginrenderer/package-summary.html">org.prebid.mobile.api.rendering.pluginrenderer</a> - package org.prebid.mobile.api.rendering.pluginrenderer</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Package for configuring custom rendering plugins.</div>
+</dd>
 <dt><a href="org/prebid/mobile/eventhandlers/package-summary.html">org.prebid.mobile.eventhandlers</a> - package org.prebid.mobile.eventhandlers</dt>
-<dd>&nbsp;</dd>
+<dd>
+<div class="block">Adapters for Google Ad Manager mediation integration of the Prebid SDK.</div>
+</dd>
 <dt><a href="org/prebid/mobile/Signals.Api.html#ORMMA" class="member-name-link">ORMMA</a> - Static variable in class org.prebid.mobile.<a href="org/prebid/mobile/Signals.Api.html" title="class in org.prebid.mobile">Signals.Api</a></dt>
 <dd>
 <div class="block">ORMMA</div>

diff --git a/docs/index.html b/docs/index.html
@@ -2,7 +2,7 @@
 <html lang="ru">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>Overview (PrebidMobile API)</title>
+<title>Overview (Prebid Mobile Android SDK. Documentation to the public API. )</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 <meta name="description" content="package index">
@@ -48,37 +48,63 @@
 <div class="flex-content">
 <main role="main">
 <div class="header">
-<h1 class="title">PrebidMobile API</h1>
+<h1 class="title"><h1>Prebid Mobile Android SDK. </h1><p>Documentation to the public API. </p></h1>
 </div>
 <div id="all-packages-table">
 <div class="caption"><span>Packages</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Package</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="com/applovin/mediation/adapters/package-summary.html">com.applovin.mediation.adapters</a></div>
-<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Adapters for AppLovin MAX mediation integration of the Prebid SDK.</div>
+</div>
 <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/package-summary.html">org.prebid.mobile</a></div>
-<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Root package with ad units for the 'original API'
+ integration of the SDK and common classes for all SDK.</div>
+</div>
 <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/admob/package-summary.html">org.prebid.mobile.admob</a></div>
-<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Adapters for AdMob mediation integration of the Prebid SDK.</div>
+</div>
 <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/data/package-summary.html">org.prebid.mobile.api.data</a></div>
-<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Common data classes for the SDK integration.</div>
+</div>
 <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/exceptions/package-summary.html">org.prebid.mobile.api.exceptions</a></div>
-<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Common exceptions.</div>
+</div>
 <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/mediation/package-summary.html">org.prebid.mobile.api.mediation</a></div>
-<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Ad units for the mediation integration of the SDK.</div>
+</div>
 <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/mediation/listeners/package-summary.html">org.prebid.mobile.api.mediation.listeners</a></div>
-<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Listeners for the mediation integration.</div>
+</div>
 <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/original/package-summary.html">org.prebid.mobile.api.original</a></div>
-<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Universal Prebid ad unit for multi-format request
+ with access to the bid response data.</div>
+</div>
 <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/rendering/package-summary.html">org.prebid.mobile.api.rendering</a></div>
-<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Ad units for the rendering integration of the SDK.</div>
+</div>
 <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/rendering/listeners/package-summary.html">org.prebid.mobile.api.rendering.listeners</a></div>
-<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Listeners for the rendering API integration.</div>
+</div>
 <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/api/rendering/pluginrenderer/package-summary.html">org.prebid.mobile.api.rendering.pluginrenderer</a></div>
-<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Package for configuring custom rendering plugins.</div>
+</div>
 <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/prebid/mobile/eventhandlers/package-summary.html">org.prebid.mobile.eventhandlers</a></div>
-<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
+<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
+<div class="block">Adapters for Google Ad Manager mediation integration of the Prebid SDK.</div>
+</div>
 </div>
 </div>
 </main>