Add package-info.java descriptors for 15 undocumented packages by shai-almog · Pull Request #5040 · codenameone/CodenameOne

shai-almog · 2026-05-25T16:24:50Z

Summary

Adds package-info.java for the 15 packages under CodenameOne/src that contain Java sources but had no package descriptor, so Javadoc and IDEs have a real summary instead of an empty page.
Covers recently added packages (io.webauthn, io.oidc, io.bonjour, io.wifi, io.usb, nfc, plugin, plugin.event, util.promise) plus older ones that had simply never received one (annotations, charts.transitions, cloud, compat.java.util, ui.css, ui.layouts.mig).
Matches the existing /// Javadoc style and is ASCII-only (per ParparVM Android encoding constraint).

Test plan

git grep -L package-info CodenameOne/src/... shows no source-bearing package left undocumented
file CodenameOne/src/com/codename1/**/package-info.java reports ASCII for all new files
mvn -Plocal-dev-javase -DskipTests install (core module) still compiles cleanly

Fills in the 15 packages under CodenameOne/src that contain Java sources but lacked a package-info.java, so Javadoc and IDEs have a real description for them instead of an empty package summary. Matches the existing /// Javadoc style and stays ASCII-only. Covered packages: annotations, charts.transitions, cloud, compat.java.util, io.bonjour, io.oidc, io.usb, io.webauthn, io.wifi, nfc, plugin, plugin.event, ui.css, ui.layouts.mig, util.promise. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

github-actions · 2026-05-25T16:56:56Z

✅ Continuous Quality Report

Test & Coverage

✅ Tests: 2646 total, 0 failed, 0 skipped
📊 Line coverage: 53.28% [HTML preview] [Download]
- Lowest covered classes
  - com.codename1.io.oidc.OidcClient – 0.00%
  - com.codename1.social.Auth0Connect – 0.00%
  - com.codename1.social.AppleSignIn – 0.00%
  - com.codename1.nfc.NdefMessage – 0.00%
  - com.codename1.nfc.NdefRecord – 0.00%
  - com.codename1.components.OtpField – 0.00%
  - com.codename1.nfc.NfcReadOptions – 0.00%
  - com.codename1.social.FirebaseAuth$FirebaseUser – 0.00%
  - com.codename1.nfc.Tag – 0.00%
  - com.codename1.security.AuthenticationOptions – 0.00%

Static Analysis

SpotBugs [Report archive]
- ✅ ByteCodeTranslator: 0 findings (no issues)
- ✅ android: 0 findings (no issues)
- ✅ codenameone-maven-plugin: 0 findings (no issues)
- ✅ core-unittests: 0 findings (no issues)
- ✅ ios: 0 findings (no issues)
✅ PMD: 0 findings (no issues) [Report archive]
✅ Checkstyle: 0 findings (no issues) [Report archive]

Generated automatically by the PR CI workflow.

shai-almog · 2026-05-25T17:02:35Z

Compared 110 screenshots: 110 matched.
✅ Native iOS screenshot tests passed.

Benchmark Results

VM Translation Time: 0 seconds
Compilation Time: 164 seconds

Build and Run Timing

Metric	Duration
Simulator Boot	58000 ms
Simulator Boot (Run)	1000 ms
App Install	11000 ms
App Launch	4000 ms
Test Execution	300000 ms

Detailed Performance Metrics

Metric	Duration
Base64 payload size	8192 bytes
Base64 benchmark iterations	6000
Base64 native encode	1118.000 ms
Base64 CN1 encode	2201.000 ms
Base64 encode ratio (CN1/native)	1.969x (96.9% slower)
Base64 native decode	472.000 ms
Base64 CN1 decode	1443.000 ms
Base64 decode ratio (CN1/native)	3.057x (205.7% slower)
Base64 SIMD encode	666.000 ms
Base64 encode ratio (SIMD/native)	0.596x (40.4% faster)
Base64 encode ratio (SIMD/CN1)	0.303x (69.7% faster)
Base64 SIMD decode	571.000 ms
Base64 decode ratio (SIMD/native)	1.210x (21.0% slower)
Base64 decode ratio (SIMD/CN1)	0.396x (60.4% faster)
Image encode benchmark iterations	100
Image createMask (SIMD off)	61.000 ms
Image createMask (SIMD on)	10.000 ms
Image createMask ratio (SIMD on/off)	0.164x (83.6% faster)
Image applyMask (SIMD off)	185.000 ms
Image applyMask (SIMD on)	115.000 ms
Image applyMask ratio (SIMD on/off)	0.622x (37.8% faster)
Image modifyAlpha (SIMD off)	277.000 ms
Image modifyAlpha (SIMD on)	105.000 ms
Image modifyAlpha ratio (SIMD on/off)	0.379x (62.1% faster)
Image modifyAlpha removeColor (SIMD off)	247.000 ms
Image modifyAlpha removeColor (SIMD on)	157.000 ms
Image modifyAlpha removeColor ratio (SIMD on/off)	0.636x (36.4% faster)
Image PNG encode (SIMD off)	1515.000 ms
Image PNG encode (SIMD on)	1162.000 ms
Image PNG encode ratio (SIMD on/off)	0.767x (23.3% faster)
Image JPEG encode	651.000 ms

shai-almog · 2026-05-25T17:09:46Z

Compared 110 screenshots: 110 matched.

Native Android coverage

📊 Line coverage: 11.82% (6796/57481 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
- Other counters: instruction 9.62% (34128/354909), branch 4.13% (1395/33740), complexity 5.17% (1674/32374), method 9.00% (1363/15146), class 14.44% (303/2099)
- Lowest covered classes
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysKt – 0.00% (0/6327 lines covered)
  - kotlin.collections.unsigned.kotlin.collections.unsigned.UArraysKt___UArraysKt – 0.00% (0/2384 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.ClassReader – 0.00% (0/1519 lines covered)
  - kotlin.collections.kotlin.collections.CollectionsKt___CollectionsKt – 0.00% (0/1148 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.MethodWriter – 0.00% (0/923 lines covered)
  - kotlin.sequences.kotlin.sequences.SequencesKt___SequencesKt – 0.00% (0/730 lines covered)
  - kotlin.text.kotlin.text.StringsKt___StringsKt – 0.00% (0/623 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.Frame – 0.00% (0/564 lines covered)
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysJvmKt – 0.00% (0/495 lines covered)
  - kotlinx.coroutines.kotlinx.coroutines.JobSupport – 0.00% (0/423 lines covered)

✅ Native Android screenshot tests passed.

Native Android coverage

📊 Line coverage: 11.82% (6796/57481 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
- Other counters: instruction 9.62% (34128/354909), branch 4.13% (1395/33740), complexity 5.17% (1674/32374), method 9.00% (1363/15146), class 14.44% (303/2099)
- Lowest covered classes
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysKt – 0.00% (0/6327 lines covered)
  - kotlin.collections.unsigned.kotlin.collections.unsigned.UArraysKt___UArraysKt – 0.00% (0/2384 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.ClassReader – 0.00% (0/1519 lines covered)
  - kotlin.collections.kotlin.collections.CollectionsKt___CollectionsKt – 0.00% (0/1148 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.MethodWriter – 0.00% (0/923 lines covered)
  - kotlin.sequences.kotlin.sequences.SequencesKt___SequencesKt – 0.00% (0/730 lines covered)
  - kotlin.text.kotlin.text.StringsKt___StringsKt – 0.00% (0/623 lines covered)
  - org.jacoco.agent.rt.internal_b6258fc.asm.org.jacoco.agent.rt.internal_b6258fc.asm.Frame – 0.00% (0/564 lines covered)
  - kotlin.collections.kotlin.collections.ArraysKt___ArraysJvmKt – 0.00% (0/495 lines covered)
  - kotlinx.coroutines.kotlinx.coroutines.JobSupport – 0.00% (0/423 lines covered)

Benchmark Results

Detailed Performance Metrics

Metric	Duration
Base64 payload size	8192 bytes
Base64 benchmark iterations	6000
Base64 native encode	663.000 ms
Base64 CN1 encode	126.000 ms
Base64 encode ratio (CN1/native)	0.190x (81.0% faster)
Base64 native decode	1070.000 ms
Base64 CN1 decode	163.000 ms
Base64 decode ratio (CN1/native)	0.152x (84.8% faster)
Image encode benchmark status	skipped (SIMD unsupported)

shai-almog · 2026-05-25T17:18:24Z

Compared 110 screenshots: 110 matched.
✅ Native iOS Metal screenshot tests passed.

Benchmark Results

VM Translation Time: 0 seconds
Compilation Time: 503 seconds

Build and Run Timing

Metric	Duration
Simulator Boot	107000 ms
Simulator Boot (Run)	2000 ms
App Install	20000 ms
App Launch	19000 ms
Test Execution	330000 ms

Detailed Performance Metrics

Metric	Duration
Base64 payload size	8192 bytes
Base64 benchmark iterations	6000
Base64 native encode	1152.000 ms
Base64 CN1 encode	2371.000 ms
Base64 encode ratio (CN1/native)	2.058x (105.8% slower)
Base64 native decode	615.000 ms
Base64 CN1 decode	2286.000 ms
Base64 decode ratio (CN1/native)	3.717x (271.7% slower)
Base64 SIMD encode	622.000 ms
Base64 encode ratio (SIMD/native)	0.540x (46.0% faster)
Base64 encode ratio (SIMD/CN1)	0.262x (73.8% faster)
Base64 SIMD decode	560.000 ms
Base64 decode ratio (SIMD/native)	0.911x (8.9% faster)
Base64 decode ratio (SIMD/CN1)	0.245x (75.5% faster)
Image encode benchmark iterations	100
Image createMask (SIMD off)	61.000 ms
Image createMask (SIMD on)	10.000 ms
Image createMask ratio (SIMD on/off)	0.164x (83.6% faster)
Image applyMask (SIMD off)	152.000 ms
Image applyMask (SIMD on)	77.000 ms
Image applyMask ratio (SIMD on/off)	0.507x (49.3% faster)
Image modifyAlpha (SIMD off)	188.000 ms
Image modifyAlpha (SIMD on)	88.000 ms
Image modifyAlpha ratio (SIMD on/off)	0.468x (53.2% faster)
Image modifyAlpha removeColor (SIMD off)	205.000 ms
Image modifyAlpha removeColor (SIMD on)	68.000 ms
Image modifyAlpha removeColor ratio (SIMD on/off)	0.332x (66.8% faster)
Image PNG encode (SIMD off)	1877.000 ms
Image PNG encode (SIMD on)	1241.000 ms
Image PNG encode ratio (SIMD on/off)	0.661x (33.9% faster)
Image JPEG encode	698.000 ms

@route

Conflict was in CodenameOne/src/com/codename1/annotations/package-info.java where both sides added the file. PR #5040 on master shipped a broader description covering the whole annotations package (build pipeline + ParparVM bytecode translator) while this branch had a routing-only blurb. Took master's wording verbatim; it accurately covers the new @route / @RouteParam additions as build-pipeline annotations alongside the existing ParparVM-direction ones. Also aligned the two other new package-info.java files (com.codename1.router, com.codename1.router.generated) to master's convention: a `///` description with no copyright header, matching io/package-info.java, ui/package-info.java, and the package-info files PR #5040 added. Tests still pass: 19 plugin tests + the routing parts of core remain green locally.

shai-almog merged commit 04c2163 into master May 25, 2026
22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add package-info.java descriptors for 15 undocumented packages#5040

Add package-info.java descriptors for 15 undocumented packages#5040
shai-almog merged 1 commit into
masterfrom
add-package-info-descriptors

shai-almog commented May 25, 2026

Uh oh!

github-actions Bot commented May 25, 2026

Uh oh!

shai-almog commented May 25, 2026 •

edited

Loading

Uh oh!

shai-almog commented May 25, 2026 •

edited

Loading

Uh oh!

shai-almog commented May 25, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

shai-almog commented May 25, 2026

Summary

Test plan

Uh oh!

github-actions Bot commented May 25, 2026

✅ Continuous Quality Report

Test & Coverage

Static Analysis

Uh oh!

shai-almog commented May 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmark Results

Build and Run Timing

Detailed Performance Metrics

Uh oh!

shai-almog commented May 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Native Android coverage

Native Android coverage

Benchmark Results

Detailed Performance Metrics

Uh oh!

shai-almog commented May 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmark Results

Build and Run Timing

Detailed Performance Metrics

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

shai-almog commented May 25, 2026 •

edited

Loading

shai-almog commented May 25, 2026 •

edited

Loading

shai-almog commented May 25, 2026 •

edited

Loading