Updated JavaDoc to markdown format (#4498)

* Updated JavaDoc to markdown format

* Fixed unused import warnings exposed by replacing JavaDocs

* Fixed bad quote characters in the project

* Fixed whitespace in markdown comments

Author: shai-almog

.github/workflows/scripts-android.yml

@@ -58,14 +58,14 @@ name: Test Android build scripts
 # The token in secrets.CN1SS_GH_TOKEN was generated on
 # Oct 16th 2025. If in Oct 2026 builds start failing, it
 # means the token needs to be regenerated:
-#	1.	Go to https://github.com/settings/tokens → “Developer settings” → “Personal access tokens”.
+#	1.	Go to https://github.com/settings/tokens -> "Developer settings" -> "Personal access tokens".
 #	2.	Choose Fine-grained token (recommended).
 #	3.	Grant:
-#	•	Repository access → select Codename One
-#	•	Permissions:
-#	•	Contents → Read and Write
-#	•	Pull requests → Read and Write
-#	•	Issues → Read and Write
+#	*	Repository access -> select Codename One
+#	*	Permissions:
+#	*	Contents -> Read and Write
+#	*	Pull requests -> Read and Write
+#	*	Issues -> Read and Write
 #	4.	Copy the generated token
 #   5. Go to https://github.com/codenameone/CodenameOne/settings/secrets/actions
 #     and edit the CN1SS_GH_TOKEN to use the new token

CodenameOne/src/com/codename1/ads/AdsService.java

@@ -32,28 +32,22 @@
 import java.io.IOException;
 import java.io.InputStream;
 
-/**
- * This is an abstract Ads Service.
- * Each supported Ad network needs to extend this Service and to implement
- * the initService method
- *
- * @author Chen Fishbein
- */
+/// This is an abstract Ads Service.
+/// Each supported Ad network needs to extend this Service and to implement
+/// the initService method
+///
+/// @author Chen Fishbein
 public abstract class AdsService extends ConnectionRequest {
 
     private static Class service = InnerActive.class;
     private String currentAd;
     private boolean initialized = false;
 
-    /**
-     * Empty constructor
-     */
+    /// Empty constructor
     protected AdsService() {
     }
 
-    /**
-     * Creates a new AdsService to be used by the Ads Component
-     */
+    /// Creates a new AdsService to be used by the Ads Component
     public static AdsService createAdsService() {
         try {
             return (AdsService) service.newInstance();
@@ -66,47 +60,37 @@ public static AdsService createAdsService() {
 
     }
 
-    /**
-     * Sets the provider of the ads service.
-     *
-     * @param provider this class needs to extend the AdsService class
-     */
+    /// Sets the provider of the ads service.
+    ///
+    /// #### Parameters
+    ///
+    /// - `provider`: this class needs to extend the AdsService class
     public static void setAdsProvider(Class provider) {
         service = provider;
     }
 
-    /**
-     * Initialize the ads service.
-     */
+    /// Initialize the ads service.
     public void initialize(Ads adsComponent) {
         if (!initialized) {
             initService(adsComponent);
             initialized = true;
         }
     }
 
-    /**
-     * init the service requests.
-     */
+    /// init the service requests.
     public abstract void initService(Ads adsComponent);
 
-    /**
-     * Returns the last requested ad
-     */
+    /// Returns the last requested ad
     public String getCurrentAd() {
         return currentAd;
     }
 
-    /**
-     * Schedule this service on the Network thread and executes the request
-     */
+    /// Schedule this service on the Network thread and executes the request
     public void requestAd() {
         NetworkManager.getInstance().addToQueue(this);
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /// {@inheritDoc}
     @Override
     protected void readResponse(InputStream input) throws IOException {
         ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -124,35 +108,29 @@ protected void readResponse(InputStream input) throws IOException {
         }
     }
 
-    /**
-     * This a callback method to inform to the service the Ad is displayed
-     *
-     * @param cmp
-     */
+    /// This a callback method to inform to the service the Ad is displayed
+    ///
+    /// #### Parameters
+    ///
+    /// - `cmp`
     public void onAdDisplay(HTMLComponent cmp) {
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /// {@inheritDoc}
     @Override
     protected void handleErrorResponseCode(int code, String message) {
         //do nothing, ads failure should not interfere with application flow
         System.err.println("error=" + code + " " + message);
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /// {@inheritDoc}
     @Override
     protected void handleRuntimeException(RuntimeException err) {
         //do nothing, ads failure should not interfere with application flow
         err.printStackTrace();
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /// {@inheritDoc}
     @Override
     protected void handleException(Exception err) {
         //do nothing, ads failure should not interfere with application flow

CodenameOne/src/com/codename1/ads/InnerActive.java

@@ -30,12 +30,10 @@
 import java.io.IOException;
 import java.io.InputStream;
 
-/**
- * This is an Ad service implementation by InnerActive see:
- * http://console.inner-active.com/iamp/publisher/register?ref_id=affiliate_CodenameOne
- *
- * @author Chen
- */
+/// This is an Ad service implementation by InnerActive see:
+/// http://console.inner-active.com/iamp/publisher/register?ref_id=affiliate_CodenameOne
+///
+/// @author Chen
 public class InnerActive extends AdsService { // PMD Fix: UnusedPrivateField removed obsolete field
 
     private static final String protocolVersion = "Sm2m-1.5.3";
@@ -54,27 +52,25 @@ private static void addParam(ConnectionRequest req, String key, String val) {
         }
     }
 
-    /**
-     * If true and no ads exists the network will return house holds ads
-     *
-     * @param test
-     */
+    /// If true and no ads exists the network will return house holds ads
+    ///
+    /// #### Parameters
+    ///
+    /// - `test`
     public static void setTestAds(boolean test) {
         testAds = test;
     }
 
-    /**
-     * Sets this ads type, by default this a banner type.
-     *
-     * @param banner sets the ads to banners or text ads
-     */
+    /// Sets this ads type, by default this a banner type.
+    ///
+    /// #### Parameters
+    ///
+    /// - `banner`: sets the ads to banners or text ads
     public void setBanner(boolean banner) {
         this.banner = banner;
     }
 
-    /**
-     * initialize the ads service
-     */
+    /// initialize the ads service
     @Override
     public void initService(Ads ads) {
         this.os = Display.getInstance().getPlatformName();
@@ -164,9 +160,7 @@ public boolean equals(Object o) {
                 (hid == null ? that.hid == null : hid.equals(that.hid));
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /// {@inheritDoc}
     @Override
     public int hashCode() {
         int result = super.hashCode();
@@ -177,9 +171,7 @@ public int hashCode() {
         return result;
     }
 
-    /**
-     * {@inheritDoc}
-     */
+    /// {@inheritDoc}
     @Override
     protected void readResponse(InputStream input) throws IOException {
         StringBuffer buf = new StringBuffer();

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

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