Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/scripts/validate-java25-markdown-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#!/usr/bin/env bash
set -euo pipefail
cd "$(cd "$(dirname "$0")/../.." && pwd)"
[ -d CodenameOne ] && [ -d Ports/CLDC11 ] || { echo 'ERROR: Expected CodenameOne and Ports/CLDC11 directories.' >&2; exit 1; }
failed=0

javadoc_hits="$(mktemp)" && package_hits="$(mktemp)"
if grep -R -nE --include='*.java' '^[[:space:]]*/\*\*' CodenameOne Ports/CLDC11 >"$javadoc_hits"; then
cat "$javadoc_hits"; echo 'ERROR: Found classic Javadoc markers (/**). Use /// markdown comments.' >&2; failed=1
else
grep_status=$?
[ "$grep_status" -eq 1 ] || { echo 'ERROR: Failed while scanning for /** markers.' >&2; exit "$grep_status"; }
fi
find CodenameOne Ports/CLDC11 -type f -name 'package.html' >"$package_hits"
if [ -s "$package_hits" ]; then cat "$package_hits"; echo 'ERROR: Found package.html files. Use package-info.java with /// markdown comments.' >&2; failed=1; fi

[ "$failed" -eq 0 ] && echo 'Validation passed: no /** markers and no package.html files found in CodenameOne or Ports/CLDC11.'
rm -f "$javadoc_hits" "$package_hits"
exit "$failed"
2 changes: 2 additions & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ jobs:

steps:
- uses: actions/checkout@v1
- name: Validate Java 25 markdown docs style (CodenameOne + CLDC11)
run: ./.github/scripts/validate-java25-markdown-docs.sh
- name: Set up Java
run: |
if [ "${{ matrix.java-version }}" = "8" ]; then
Expand Down
18 changes: 0 additions & 18 deletions CodenameOne/src/com/codename1/ads/package.html

This file was deleted.

16 changes: 0 additions & 16 deletions CodenameOne/src/com/codename1/analytics/package.html

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* Marks a method so ParparVM omits emitted debug line information.
*/
/// Marks a method so ParparVM omits emitted debug line information.
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface DisableDebugInfo {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* Marks a method so ParparVM omits emitted null and array bounds checks.
*/
/// Marks a method so ParparVM omits emitted null and array bounds checks.
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface DisableNullChecksAndArrayBoundsChecks {
Expand Down
12 changes: 0 additions & 12 deletions CodenameOne/src/com/codename1/background/package.html

This file was deleted.

16 changes: 0 additions & 16 deletions CodenameOne/src/com/codename1/capture/package.html

This file was deleted.

6 changes: 0 additions & 6 deletions CodenameOne/src/com/codename1/charts/compat/package.html

This file was deleted.

6 changes: 0 additions & 6 deletions CodenameOne/src/com/codename1/charts/models/package.html

This file was deleted.

99 changes: 0 additions & 99 deletions CodenameOne/src/com/codename1/charts/package.html

This file was deleted.

6 changes: 0 additions & 6 deletions CodenameOne/src/com/codename1/charts/renderers/package.html

This file was deleted.

6 changes: 0 additions & 6 deletions CodenameOne/src/com/codename1/charts/util/package.html

This file was deleted.

6 changes: 0 additions & 6 deletions CodenameOne/src/com/codename1/charts/views/package.html

This file was deleted.

13 changes: 0 additions & 13 deletions CodenameOne/src/com/codename1/codescan/package.html

This file was deleted.

12 changes: 0 additions & 12 deletions CodenameOne/src/com/codename1/components/package.html

This file was deleted.

29 changes: 0 additions & 29 deletions CodenameOne/src/com/codename1/contacts/package.html

This file was deleted.

60 changes: 0 additions & 60 deletions CodenameOne/src/com/codename1/db/package.html

This file was deleted.

12 changes: 0 additions & 12 deletions CodenameOne/src/com/codename1/facebook/package.html

This file was deleted.

Loading
Loading