Add package-info.java files generated from package.html so Java 25 Javadoc picks up package docs

CodenameOne/src/com/codename1/ads/package-info.java

@@ -0,0 +1,13 @@
+/**
+ * <p>
+ *     A legacy banner Ads API. This has been replaced by more modern approaches mainly thru <a
+ *         href="https://www.codenameone.com/cn1libs.html">cn1libs</a>.
+ * </p>
+ * <p>
+ *     Currently inner-active ads Network is supported
+ *     please refer to
+ *     <a href="http://console.inner-active.com/iamp/publisher/register?ref_id=affiliate_CodenameOne">inner-active</a>
+ *     for more information
+ * </p>
+ */
+package com.codename1.ads;

CodenameOne/src/com/codename1/analytics/package-info.java

@@ -0,0 +1,11 @@
+/**
+ * <p>
+ *     The analytics API allows tracking your mobile application usage in the field to give you real-time
+ *     data on how your application is used. This API currently delegates to the Google analytics service.
+ * </p>
+ * <p>
+ *     Notice that analytics is automatically added GUI applications created by the old GUI builder, you only need
+ *     to enable Analytics specifically by invoking the init method and the pages will be logged automatically.
+ * </p>
+ */
+package com.codename1.analytics;

CodenameOne/src/com/codename1/background/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * <p>Background fetch is a mechanism whereby an application is granted permission by the operating system to update its
+ *     data periodically. At times of the native platform's choosing, an app that supports background fetch will be started
+ *     up (in the background), and its {@link com.codename1.background.BackgroundFetch#performBackgroundFetch(long,
+ *     com.codename1.util.Callback) } method will be called.</p>
+ */
+package com.codename1.background;

CodenameOne/src/com/codename1/capture/package-info.java

@@ -0,0 +1,11 @@
+/**
+ * <p>
+ *     Package for capturing photos, audio or video from the camera/microphone.
+ * </p>
+ * <p>
+ *     The code below demonstrates capturing and playing back audio files using this API:
+ * </p>
+ * <script src="https://gist.github.com/codenameone/a347dc9dcadaa759d0cb.js"></script>
+ * <img alt="Captured recordings in the demo" src="https://www.codenameone.com/img/developer-guide/capture-audio.png"/>
+ */
+package com.codename1.capture;

CodenameOne/src/com/codename1/charts/compat/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains compatibility classes for internal use
+ */
+package com.codename1.charts.compat;

CodenameOne/src/com/codename1/charts/models/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides the classes that handle the data values (data model) to be used by displaying the charts.
+ */
+package com.codename1.charts.models;

CodenameOne/src/com/codename1/charts/package-info.java

@@ -0,0 +1,97 @@
+/**
+ * <h1>The main ChartComponent Package</h1>
+ * <p>
+ *     The <code>charts</code> package enables Codename One developers to add charts and
+ *     visualizations to their apps without having to include external libraries or embedding web views.
+ *     We also wanted to harness the new features in the graphics pipeline to maximize performance.</p>
+ *
+ * <h4>Device Support</h4>
+ * <p>
+ *     Since the charts package makes use of 2D transformations and shapes, it requires some
+ *     of the graphics features that are not yet available on all platforms. Currently the following
+ *     platforms are supported:
+ * </p>
+ * <ol>
+ *     <li>Simulator</li>
+ *     <li>Android</li>
+ *     <li>iOS</li>
+ * </ol>
+ *
+ * <h4>Features</h4>
+ * <ol>
+ *     <li><strong>Built-in support for many common types of charts</strong> including bar charts,
+ *         line charts, stacked charts, scatter charts, pie charts and more.
+ *     </li>
+ *     <li><strong>Pinch Zoom</strong> - The {@link com.codename1.charts,ChartComponent}
+ *         class includes optional pinch zoom support.
+ *     </li>
+ *     <li><strong>Panning Support</strong> - The
+ *         {@link com.codename1.charts,ChartComponent} class includes optional support for panning.
+ *     </li>
+ * </ol>
+ *
+ * <h4>Chart Types</h4>
+ * <p>
+ *     The <code>com.codename1.charts</code> package includes models and renderers for many
+ *     different types of charts. It is also extensible so that you can add your own chart types if required.
+ *     The following screen shots demonstrate a small sampling of the types of charts that can be
+ *     created.
+ * </p>
+ * <img alt="Line Charts" src="https://www.codenameone.com/img/developer-guide/line_chart.png">
+ * <img alt="Cubic Line Charts" src="https://www.codenameone.com/img/developer-guide/line_chart_cubic_multi.png">
+ *
+ * <img alt="Bar Charts" src="https://www.codenameone.com/img/developer-guide/bar_chart.png">
+ * <img alt="Stacked Bar Charts" src="https://www.codenameone.com/img/developer-guide/bar_chart_stacked.png">
+ * <img alt="Range Bar Charts" src="https://www.codenameone.com/img/developer-guide/range_bar_chart.png">
+ * <img alt="Pie Charts" src="https://www.codenameone.com/img/developer-guide/pie_chart.png">
+ * <img alt="Doughnut Charts" src="https://www.codenameone.com/img/developer-guide/doughnut_chart.png">
+ * <img alt="Scatter Charts" src="https://www.codenameone.com/img/developer-guide/scatter_chart.png">
+ * <img alt="Dial Charts" src="https://www.codenameone.com/img/developer-guide/dial_chart.png">
+ * <img alt="Combined Charts" src="https://www.codenameone.com/img/developer-guide/combined.png">
+ * <img alt="Bubble Charts" src="https://www.codenameone.com/img/developer-guide/bubble_chart.png">
+ * <img alt="Time Charts" src="https://www.codenameone.com/img/developer-guide/time_chart.png">
+ *
+ * <table>
+ *     <tbody>
+ *     <tr>
+ *         <td class="icon"><i class="fa icon-note" title="Note"></i></td>
+ *         <td class="content">
+ *             The above screenshots were taken from the
+ *             <a href="https://github.com/codenameone/codenameone-demos/tree/master/ChartsDemo">ChartsDemo app</a>. Y
+ *             ou can start playing with this app by checking it out from our git repository.
+ *         </td>
+ *     </tr>
+ *     </tbody>
+ * </table>
+ *
+ * <h4>How to Create A Chart</h4>
+ * <p>Adding a chart to your app involves four steps:</p>
+ * <ol>
+ *     <li><strong>Build the model</strong>. You can construct a model (aka data set) for the chart using one of the
+ *         existing model classes in the <code>com.codename1.charts.models</code> package. Essentially, this
+ *         is just where you add the data that you want to display.
+ *     </li>
+ *     <li><strong>Set up a renderer</strong>. You can create a renderer for your chart using one of the
+ *         existing renderer classes in the <code>com.codename1.charts.renderers</code> package. The renderer
+ *         allows you to specify how the chart should look. E.g. the colors, fonts, styles, to use.
+ *     </li>
+ *     <li><strong>Create the Chart View</strong>. Use one of the existing <em>view</em> classes in the
+ *         <code>com.codename1.charts.views</code> package.
+ *     </li>
+ *     <li><strong>Create a {@link com.codename1.charts,ChartComponent} </strong>. In order to add your
+ *         chart to the UI, you need to wrap it in a {@link com.codename1.charts,ChartComponent} object.
+ *     </li>
+ * </ol>
+ *
+ * <p>You can check out the <a
+ *         href="https://github.com/codenameone/codenameone-demos/tree/master/ChartsDemo">ChartsDemo</a>
+ *     app for specific examples, but here is a high level view of some code that creates a Pie Chart.</p>
+ *
+ * <script src="https://gist.github.com/codenameone/c5b5bf22cd1db36d8c07.js"></script>
+ *
+ * <p>
+ *     The charts package is derived work from the excellent <a href="http://www.achartengine.org/">open source
+ *     aChartEngine API.</a>
+ * </p>
+ */
+package com.codename1.charts;

CodenameOne/src/com/codename1/charts/renderers/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides renderer classes that keep the chart rendering / drawing styles.
+ */
+package com.codename1.charts.renderers;

CodenameOne/src/com/codename1/charts/util/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Utility classes that provide helper methods used by most of the other packages.
+ */
+package com.codename1.charts.util;

CodenameOne/src/com/codename1/charts/views/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides the classes that handle the actual rendering / drawing of the charts, based on the provided model and renderer.
+ */
+package com.codename1.charts.views;

CodenameOne/src/com/codename1/codescan/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <p><strong>Deprecated!!</strong>: Please use the <a href="https://github.com/codenameone/cn1-codescan">cn1-codescan</a>
+ *     library instead.</p>
+ * <p>
+ *     Bar/QR code scanning API, currently based on the zxing implementation
+ * </p>
+ */
+package com.codename1.codescan;

CodenameOne/src/com/codename1/components/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * <p>
+ *     Generic elaborate components that make use of both UI elements and storage.
+ *     These are relatively high level components such as RSS reader, IO progress indication etc.
+ * </p>
+ */
+package com.codename1.components;

CodenameOne/src/com/codename1/contacts/package-info.java

@@ -0,0 +1,24 @@
+/**
+ * <p>
+ *     Provides access to the contacts list from the device address book
+ * </p>
+ * <p>
+ *     The contacts API provides us with the means to query the phone's address book, delete elements from
+ *     it and create new entries into it.
+ * </p>
+ * <p>
+ *     Notice that on some platforms this will prompt the user for permissions and the user might choose not
+ *     to grant that permission. To detect whether this is the case you can invoke
+ *     {@link com.codename1.Display#isContactsPermissionGranted()} after invoking the contact listing API.
+ *     This can help you adapt your error message to the user.
+ * </p>
+ * <p>
+ *     The sample below demonstrates listing all the contacts within the device with their photos, notice that
+ *     this API is very performance sensitive and should be invoked on a separate thread unlike most
+ *     Codename One API's:
+ * </p>
+ * <script src="https://gist.github.com/codenameone/15f39e1eef77f6059aff.js"></script>
+ * <img alt="Contacts with the default photos on the simulator, on device these will use actual user photos when available"
+ *      src="https://www.codenameone.com/img/developer-guide/contacts-with-photos.png"/>
+ */
+package com.codename1.contacts;

CodenameOne/src/com/codename1/db/package-info.java

@@ -0,0 +1,53 @@
+/**
+ * <h1>SQLite database access API</h1>
+ *
+ * <p>
+ *     Most new devices contain one version of sqlite or another; sqlite is a very lightweight SQL database
+ *     designed for embedding into devices. For portability we recommend avoiding SQL altogether since
+ *     it is both fragmented between devices (different sqlite versions) and isn't supported on all devices.
+ * </p>
+ *
+ * <p>In general SQL seems overly complex for most embedded device programming tasks.</p>
+ *
+ * <h3>Portability Of SQLite</h3>
+ * <p>SQLite is supported on iOS, Android, UWP (Universal Windows Platform), RIM, Desktop &amp; JavaScript builds. However,
+ *     the JavaScript
+ *     version of SQL has been deprecated and isn't supported on all platforms.</p>
+ * <p>You will notice that at this time support is still missing from the Windows builds.</p>
+ * <p>The biggest issue with SQLite portability is in iOS. The SQLite version for most platforms is
+ *     threadsafe and as a result very stable. However, the iOS version is not!</p>
+ * <p>This might not seem like a big deal normally, however if you forget to close a connection the GC might
+ *     close it for you thus producing a crash. This is such a common occurrence that Codename One logs
+ *     a warning when the GC collects a database resource on the simulator.</p>
+ *
+ * <h3>Using SQLite</h3>
+ * <p>SQL is pretty powerful and very well suited for common tabular data. The Codename One SQL
+ *     API is similar in spirit to JDBC but considerably simpler since many of the abstractions of JDBC
+ *     designed for pluggable database architecture make no sense for a local database.</p>
+ *
+ * <p>The {@link com.codename1.db.Database} API is a high level abstraction that allows you to open an
+ *     arbitrary database file using syntax such as:</p>
+ *
+ * <script src="https://gist.github.com/codenameone/184eb4b7303878dc4688.js"></script>
+ *
+ * <p>Some SQLite apps ship with a "ready made" database. We allow you to replace the DB file by using the code:</p>
+ *
+ * <script src="https://gist.github.com/codenameone/b1140f9c3abb44d53276.js"></script>
+ *
+ * <p>You can then use the {@link com.codename1.io.FileSystemStorage} class to write the content of your
+ *     DB file into the path. Notice that it must be a valid SQLite file!</p>
+ *
+ * <p>This is very useful for applications that need to synchronize with a central server or applications that
+ *     ship with a large database as part of their core product.</p>
+ *
+ * <p>Working with a database is pretty trivial, the application logic below can send arbitrary queries to the
+ *     database and present the results in a {@link com.codename1.ui.table.Table}. You can probably integrate
+ *     this code into your app as a debugging tool:</p>
+ *
+ * <script src="https://gist.github.com/codenameone/282b02c20e7bd067f1f0.js"></script>
+ *
+ * <img alt="Querying the temp demo generated by the SQLDemo application"
+ *      src="https://www.codenameone.com/img/developer-guide/sql-table.png">
+ * <img alt="Issuing a query" src="https://www.codenameone.com/img/developer-guide/sql-entry.png">
+ */
+package com.codename1.db;

CodenameOne/src/com/codename1/facebook/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * <p>
+ *     Legacy generic implementation of the Facebook API with simplified OAuth integration to allow social sharing.
+ *     It is recommended to migrate to the new social package services
+ * </p>
+ */
+package com.codename1.facebook;

CodenameOne/src/com/codename1/facebook/ui/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * <p>
+ *     User interface for integrating with basic Facebook features currently mostly the Like button
+ * </p>
+ */
+package com.codename1.facebook.ui;

CodenameOne/src/com/codename1/impl/package-info.java

@@ -0,0 +1,14 @@
+/**
+ * <p>
+ *     The implementation package should not be used by developers, it is an internal implementation detail
+ *     which will break compatibility between major Codename One releases. The purpose of this package is to provide
+ *     ISVs, vendors and operators with the ability to customize &amp; enhance Codename One from within without
+ *     breaking compatability with existing Codename One applications.
+ * </p>
+ * <p>
+ *     A vendor extension begins by extending the CodenameOneImplementation class and implementing the abstract
+ *     methods within. To use this version of the implementation a user can use the Display class and link
+ *     to a vendor JAR that doesn't include any portion of Codename One.
+ * </p>
+ */
+package com.codename1.impl;

CodenameOne/src/com/codename1/io/gzip/package-info.java

@@ -0,0 +1,6 @@
+/**
+ * <p>
+ *     gzip support based on <a href="https://github.com/ymnk/jzlib">https://github.com/ymnk/jzlib</a>
+ * </p>
+ */
+package com.codename1.io.gzip;