Skip to content

Add Highlight.js to Maven Javadoc and remove BUILDING.md note#4499

Merged
shai-almog merged 8 commits intomasterfrom
codex/add-syntax-highlighting-to-javadoc-generation
Feb 6, 2026
Merged

Add Highlight.js to Maven Javadoc and remove BUILDING.md note#4499
shai-almog merged 8 commits intomasterfrom
codex/add-syntax-highlighting-to-javadoc-generation

Conversation

@shai-almog
Copy link
Collaborator

Motivation

  • Ensure generated Javadoc includes client-side syntax highlighting for code samples by injecting a lightweight highlighter into the Maven Javadoc output.
  • Remove the previously added explanatory note from BUILDING.md to restore the prior documentation state.

Description

  • Updated maven/pom.xml maven-javadoc-plugin configuration to add a <bottom> block that injects Highlight.js CSS/JS and initializes highlighting for pre code elements using hljs.highlightElement.
  • Kept the --allow-script-in-comments additionalOption to permit the injected script to run in generated Javadoc pages.
  • Reverted BUILDING.md to its prior content and removed the JavaDoc syntax-highlighting note.

Testing

  • No automated tests were run for these configuration and documentation changes.
  • The BUILDING.md content was inspected to confirm the revert was applied successfully.

Codex Task

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

✅ Continuous Quality Report

Test & Coverage

Static Analysis

Generated automatically by the PR CI workflow.

@shai-almog
Copy link
Collaborator Author

shai-almog commented Feb 6, 2026

Compared 30 screenshots: 30 matched.

Native Android coverage

  • 📊 Line coverage: 7.14% (3622/50725 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
    • Other counters: instruction 5.57% (17791/319446), branch 2.72% (844/31079), complexity 3.32% (985/29700), method 5.83% (806/13829), class 9.52% (174/1827)
    • 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/712 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: 7.14% (3622/50725 lines covered) [HTML preview] (artifact android-coverage-report, jacocoAndroidReport/html/index.html)
    • Other counters: instruction 5.57% (17791/319446), branch 2.72% (844/31079), complexity 3.32% (985/29700), method 5.83% (806/13829), class 9.52% (174/1827)
    • 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/712 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)

@shai-almog shai-almog merged commit 05d99c2 into master Feb 6, 2026
14 checks passed
@shai-almog
Copy link
Collaborator Author

shai-almog commented Feb 6, 2026

Compared 30 screenshots: 30 matched.
✅ Native Android screenshot tests passed.

Benchmark Results

  • VM Translation Time: 354 seconds
  • Compilation Time: 268 seconds

Detailed Performance Metrics

Metric Duration
Build Time Statistics
Setup & Unzip 31071 ms
Extract Extensions 21 ms
Google Services Setup 2 ms
Scan Classes 558 ms
Extract Libs 1326 ms
Inject Build Hints 31 ms
Generate Unit Tests 2 ms
Generate Stubs 1128 ms
Compile Stubs 2537 ms
Generate Icons 1489 ms
Prepare ParparVM 219 ms
ParparVM Execution 186208 ms
Post-VM Setup 179 ms
CocoaPods 5632 ms
Finalize 21 ms
Total Time 230425 msMaven Overhead : 124000 ms
CocoaPods Install (Script) 1000 ms
Simulator Boot 256000 ms
Simulator Boot (Run) 3000 ms
App Install 17000 ms
App Launch 42000 ms
Test Execution 166000 ms

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant