Skip to content

syncing javadoc files #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 25, 2024
Merged

syncing javadoc files #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6e4688a
syncing javadoc files
carimura May 31, 2024
3df9323
fixing links
carimura May 31, 2024
6758e2b
Add missing code for processing JavaFx documentation.
ammbra Jun 1, 2024
8f73850
Update documentation to JDK 23.
ammbra Sep 25, 2024
c8fa898
Merge branch 'main' into sync-javadocs
ammbra Sep 25, 2024
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
237 changes: 197 additions & 40 deletions app/data/javadoc.json
View file
Open in desktop

Large diffs are not rendered by default.

55 changes: 27 additions & 28 deletions app/data/javafxdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"current_release": "19",
"current_release": "23",
"release_uuid": "343fae14109c42b09c0437fc90a10d4b",

"javafx-documentation": "https://openjfx.io/javadoc/@@CURRENT_RELEASE@@/",
"javafxdoc_root": "https://openjfx.io/javadoc/@@CURRENT_RELEASE@@/",
"javafxdoc_root": "https://download.java.net/java/GA/javafx@@CURRENT_RELEASE@@/@@RELEASE_UUID@@/docs/api/",

"Application": "javafx.graphics/javafx/application/Application.html",

Expand Down Expand Up @@ -54,28 +54,27 @@

"FXMLLoader": "javafx.fxml/javafx/fxml/FXMLLoader.html",
"Initializable": "javafx.fxml/javafx/fxml/Initializable.html",

"AnimationPackageSummary": "javafx.graphics/javafx/animation/package-summary",
"WritableValue": "javafx.base/javafx/beans/value/WritableValue",
"Animation": "javafx.graphics/javafx/animation/Animation",
"Duration": "javafx.base/javafx/util/Duration",
"Node": "javafx.graphics/javafx/scene/Node",
"FadeTransition": "javafx.graphics/javafx/animation/FadeTransition",
"FillTransition": "javafx.graphics/javafx/animation/FillTransition",
"PathTransition": "javafx.graphics/javafx/animation/PathTransition",
"ScaleTransition": "javafx.graphics/javafx/animation/ScaleTransition",
"StrokeTransition": "javafx.graphics/javafx/animation/StrokeTransition",
"TranslateTransition": "javafx.graphics/javafx/animation/TranslateTransition",
"Timeline": "javafx.graphics/javafx/animation/Timeline",
"KeyFrame": "javafx.graphics/javafx/animation/KeyFrame",
"KeyValue": "javafx.graphics/javafx/animation/KeyValue",
"Interpolator": "javafx.graphics/javafx/animation/Interpolator",
"Interpolator.DISCRETE": "javafx.graphics/javafx/animation/Interpolator#DISCRETE",
"Interpolator.LINEAR": "javafx.graphics/javafx/animation/Interpolator#LINEAR",
"Interpolator.EASE_IN": "javafx.graphics/javafx/animation/Interpolator#EASE_IN",
"Interpolator.EASE_OUT": "javafx.graphics/javafx/animation/Interpolator#EASE_OUT",
"Interpolator.EASE_BOTH": "javafx.graphics/javafx/animation/Interpolator#EASE_BOTH",
"Interpolator.SPLINE": "javafx.graphics/javafx/animation/Interpolator#SPLINE(double,double,double,double)",
"Interpolator.TANGENT": "javafx.graphics/javafx/animation/Interpolator#TANGENT(javafx.util.Duration,double,javafx.util.Duration,double)",
"AnimationTimer": "javafx.graphics/javafx/animation/AnimationTimer"
}
"AnimationPackageSummary": "javafx.graphics/javafx/animation/package-summary.html",
"WritableValue": "javafx.base/javafx/beans/value/WritableValue.html",
"Animation": "javafx.graphics/javafx/animation/Animation.html",
"Duration": "javafx.base/javafx/util/Duration.html",
"Node": "javafx.graphics/javafx/scene/Node.html",
"FadeTransition": "javafx.graphics/javafx/animation/FadeTransition.html",
"FillTransition": "javafx.graphics/javafx/animation/FillTransition.html",
"PathTransition": "javafx.graphics/javafx/animation/PathTransition.html",
"ScaleTransition": "javafx.graphics/javafx/animation/ScaleTransition.html",
"StrokeTransition": "javafx.graphics/javafx/animation/StrokeTransition.html",
"TranslateTransition": "javafx.graphics/javafx/animation/TranslateTransition.html",
"Timeline": "javafx.graphics/javafx/animation/Timeline.html",
"KeyFrame": "javafx.graphics/javafx/animation/KeyFrame.html",
"KeyValue": "javafx.graphics/javafx/animation/KeyValue.html",
"Interpolator": "javafx.graphics/javafx/animation/Interpolator.html",
"Interpolator.DISCRETE": "javafx.graphics/javafx/animation/Interpolator.html#DISCRETE",
"Interpolator.LINEAR": "javafx.graphics/javafx/animation/Interpolator.html#LINEAR",
"Interpolator.EASE_IN": "javafx.graphics/javafx/animation/Interpolator.html#EASE_IN",
"Interpolator.EASE_OUT": "javafx.graphics/javafx/animation/Interpolator.html#EASE_OUT",
"Interpolator.EASE_BOTH": "javafx.graphics/javafx/animation/Interpolator.html#EASE_BOTH",
"Interpolator.SPLINE": "javafx.graphics/javafx/animation/Interpolator.html#SPLINE(double,double,double,double)",
"Interpolator.TANGENT": "javafx.graphics/javafx/animation/Interpolator.html#TANGENT(javafx.util.Duration,double,javafx.util.Duration,double)",
"AnimationTimer": "javafx.graphics/javafx/animation/AnimationTimer.html"
}
73 changes: 73 additions & 0 deletions app/data/jep.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{
"root": "https://openjdk.org/jeps/",

"1": "JDK Enhancement-Proposal & Roadmap Process",
"11": "Incubator Modules",
"12": "Preview Features",

"110": "HTTP/2 Client (Incubator)",

"220": "Modular Run-Time Images",
"225": "Javadoc Search",
"286": "Local-Variable Type Inference",

"310": "Application Class-Data Sharing",
"321": "HTTP Client",
"325": "Switch Expressions (Preview)",
"326": "Raw String Literals (Preview)",
"328": "Flight Recorder",
"333": "ZGC: A Scalable Low-Latency Garbage Collector (Experimental)",
"345": "NUMA-Aware Memory Allocation for G1",
"346": "Promptly Return Unused Committed Memory from G1",
"349": "JFR Event Streaming",
"354": "Switch Expressions (Second Preview)",
"357": "Migrate from Mercurial to Git",
"358": "Helpful NullPointerExceptions",
"361": "Switch Expressions",
"363": "Remove the Concurrent Mark Sweep (CMS) Garbage Collector",
"369": "Migrate to GitHub",
"372": "Remove the Nashorn JavaScript Engine",
"374": "Disable and Deprecate Biased Locking",
"376": "ZGC: Concurrent Thread-Stack Processing",
"377": "ZGC: A Scalable Low-Latency Garbage Collector (Production)",
"384": "Records (Second Preview)",
"387": "Elastic Metaspace",
"391": "macOS/AArch64 Port",
"395": "Records",
"397": "Sealed Classes (Second Preview)",
"398": "Deprecate the Applet for Removal",

"400": "UTF-8 by Default",
"407": "Remove RMI Activation",
"408": "Simple Web Server",
"409": "Sealed Classes",
"411": "Deprecate the Security Manager for Removal",
"413": "Code Snippets in Java API Documentation",
"415": "Context-Specific Deserialization Filters",
"416": "Reimplement Core Reflection with Method Handle",
"418": "Internet-Address Resolution API",
"421": "Deprecate Finalization for Removal",
"445": {
"title": "Implicitly Declared Classes and Instance Main Methods (Second Preview)",
"status": "preview",
"version": "22"
},
"460": {
"title": "Vector API (Seventh Incubator)",
"status": "incubator",
"version": "22"
},
"463": {
"title": "Implicitly Declared Classes and Instance Main Methods (Second Preview)",
"status": "preview",
"version": "22"
},

"481": {
"title": "Scoped Values (Third Preview)",
"status": "preview",
"version": "22"
},

"8300604": "JEP draft: Preview Features: A Look Back, and A Look Ahead"
}
14 changes: 7 additions & 7 deletions app/pages/future/innovation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ subheader_select: innovation

## Amber

The goal of Project Amber is to explore and incubate smaller, productivity-oriented Java language features that have been accepted as candidate JEPs under the [OpenJDK JEP process](https://openjdk.java.net/jeps/1). This Project is sponsored by the [Compiler Group](https://openjdk.java.net/groups/compiler/).
The goal of Project Amber is to explore and incubate smaller, productivity-oriented Java language features that have been accepted as candidate JEPs under [JDK Enhancement-Proposal & Roadmap Process](jep:1). This Project is sponsored by the [Compiler Group](https://openjdk.org/groups/compiler/).

Most Project Amber features go through at least one round of Preview before becoming an official part of Java SE. See [JEP 12](https://openjdk.java.net/jeps/12) for an explanation of the Preview process, and [our tutorial](id:new_features.using_preview) on how to use preview features. For a given feature, there are separate JEPs for each round of preview and for final standardization.
Most Project Amber features go through at least one round of Preview before becoming an official part of Java SE. See [Preview Features](jep:12) for an explanation of the Preview process, and [our tutorial](id:new_features.using_preview) on how to use preview features. For a given feature, there are separate JEPs for each round of preview and for final standardization.

Learn more at Project Amber's [Wiki](https://openjdk.java.net/projects/amber/), as well as Inside.java's [Amber page](https://inside.java/tag/amber).
Learn more at Project Amber's [Wiki](https://openjdk.org/projects/amber/), as well as Inside.java's [Amber page](https://inside.java/tag/amber).

## Loom

Expand All @@ -23,7 +23,7 @@ Project Loom is to intended to explore, incubate and deliver Java VM features an

This OpenJDK project is sponsored by the HotSpot Group.

Learn more at Project Loom's [Wiki](https://wiki.openjdk.java.net/display/loom/Main), as well as Inside.java's [Loom page](https://inside.java/tag/loom).
Learn more at Project Loom's [Wiki](https://wiki.openjdk.org/display/loom/Main), as well as Inside.java's [Loom page](https://inside.java/tag/loom).

## Panama

Expand All @@ -43,7 +43,7 @@ To this end, Project Panama will include most or all of these components:
* tooling or wrapper interposition for safety
* exploratory work with difficult-to-integrate native libraries

Learn more at Project Panama's [Wiki](https://openjdk.java.net/projects/panama/), as well as Inside.java's [Panama page](https://inside.java/tag/panama).
Learn more at Project Panama's [Wiki](https://openjdk.org/projects/panama/), as well as Inside.java's [Panama page](https://inside.java/tag/panama).


## Valhalla
Expand All @@ -58,7 +58,7 @@ The three main goals are:

A number of people describe Valhalla recently as being "primarily about performance". While it is understandable why people might come to that conclusion -- many of the motivations for Valhalla are, in fact, rooted in performance considerations -- this characterization misses something very important. Yes, performance is an important part of the story -- but so are safety, abstraction, encapsulation, expressiveness, maintainability, and compatible library evolution.

Learn more at the Valhalla Project [Wiki](https://wiki.openjdk.java.net/display/valhalla/Main), as well as Inside.java's [Valhalla page](https://inside.java/tag/valhalla).
Learn more at the Valhalla Project [Wiki](https://wiki.openjdk.org/display/valhalla/Main), as well as Inside.java's [Valhalla page](https://inside.java/tag/valhalla).


## ZGC
Expand All @@ -81,5 +81,5 @@ At a glance, ZGC is:
At its core, ZGC is a concurrent garbage collector, meaning all heavy lifting work is done while Java threads continue to execute. This greatly limits the impact garbage collection will have on your application's response time.


Learn more at the ZGC [Wiki](https://wiki.openjdk.java.net/display/zgc/Main), as well as Inside.java's [GC page](https://inside.java/tag/gc).
Learn more at the ZGC [Wiki](https://wiki.openjdk.org/display/zgc/Main), as well as Inside.java's [GC page](https://inside.java/tag/gc).

8 changes: 4 additions & 4 deletions ...earn/01_tutorial/03_getting-to-know-the-language/04_classes_objects/01_enums.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ toc:
- Precautions {precautions}
- Conclusion {conclusion}
description: "Working with enums."
last_update: 2023-09-29
last_update: 2023-10-02
author: ["DanielSchmid"]
---
<a id="intro">&nbsp;</a>
Expand Down Expand Up @@ -71,11 +71,11 @@ switch (someDay) {
}
```

With [Switch Expressions](id:lang.classes-objects.switch-expression),
With [Switch Expressions](id:lang.basics.switch_expressions),
the compiler can check whether all values of the enum are handled.
If any possible value is missing in a switch expression, there will be a compiler error.
This is referred to as Exhaustiveness and can also be achieved with regular classes
through [Sealed Classes](https://openjdk.org/jeps/409).
through [Sealed Classes](jep:409).

```java
DayOfWeek someDay = DayOfWeek.FRIDAY;
Expand Down Expand Up @@ -210,6 +210,6 @@ and reading these configuration files in the program in cases like this.
<a id="conclusion">&nbsp;</a>
## Conclusion

Enums provide a simple and safe way of representing a fixed set of constants while keeping most of the flexibilities of classes. They are a special type of class that can be used to write code that is elegant, readable, and maintainable, and work well with other newer modern features like [Switch Expressions](id:lang.classes-objects.switch-expression). Another special class is the Record class introduced in Java 19. Visit our [Records tutorial](id:lang.records) to learn more.
Enums provide a simple and safe way of representing a fixed set of constants while keeping most of the flexibilities of classes. They are a special type of class that can be used to write code that is elegant, readable, and maintainable, and work well with other newer modern features like [Switch Expressions](id:lang.basics.switch_expressions). Another special class is the Record class introduced in Java 19. Visit our [Records tutorial](id:lang.records) to learn more.

To learn more about enums, visit the [`java.lang.Enum`](javadoc:Enum) javadoc.
Loading