Skip to content

Commit f3430cf

Browse files
committed
Fix/improve N&N documentation
1 parent e1bda36 commit f3430cf

File tree

3 files changed

+46
-49
lines changed

3 files changed

+46
-49
lines changed

news/4.39/jdt.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,57 +24,53 @@ A special thanks to everyone who [contributed to JDT](acknowledgements.md#java-d
2424
</details>
2525

2626
Folding can now be used in the Java Editor when `Window` > `Preferences` > `Java` > `Editor` > `Only show the selected Java element` is enabled.
27-
2827
In previous releases, this option automatically disabled code folding.
2928

30-
### Show Javadoc From Annotation/QuickFix Hover
29+
### Show Javadoc From Annotation/Quick-Fix Hover
3130
<details>
3231
<summary>Contributors</summary>
3332

3433
- [Raghunandana M](https://github.com/raghucssit)
3534
- [Andrey Loskutov](https://github.com/iloveeclipse)
3635
</details>
3736

38-
The annotation/quick‑fix hover now includes a “Javadoc” proposal that opens the Javadoc information pop‑up for the Java element referenced by the annotation.
39-
40-
You can now view an element’s API documentation directly from an annotation hover without navigating to the element’s source file.
41-
42-
Previously annotation hover took precedence and blocked the usual Javadoc pop‑up for the element under the annotation.
37+
The annotation/quick-fix hover now includes a Javadoc proposal that opens the Javadoc information pop-up for the Java element referenced by the annotation.
38+
You can now view an element's API documentation directly from an annotation hover without navigating to the element's source file.
39+
Previously, annotation hover took precedence and blocked the usual Javadoc pop-up for the element under the annotation.
4340
To read the Javadoc you had to open or navigate to the original Java source.
44-
45-
The fix removes that friction.
41+
The change removes that friction.
4642

4743
#### Annotation Hover Javadoc Behavior
48-
- When an annotation/quickfix hover is shown and the annotation refers to a Java element that has Javadoc, a Show Javadoc entry appears in the hovers proposals list.
49-
- Activating the proposal opens the standard Javadoc information control (the same browserbased Javadoc popup used elsewhere).
50-
- The Javadoc popup replaces the annotation hover for a natural, contextual display.
51-
- The Javadoc popup is closed automatically when the user clicks outside preventing stale popups.
44+
- When an annotation/quick-fix hover is shown and the annotation refers to a Java element that has Javadoc, a `Show Javadoc` entry appears in the hover's proposals list.
45+
- Activating the proposal opens the standard Javadoc information control (the same browser-based Javadoc pop-up used elsewhere).
46+
- The Javadoc pop-up replaces the annotation hover for a natural, contextual display.
47+
- The Javadoc pop-up is closed automatically when the user clicks outside preventing stale pop-ups.
5248

53-
New Show Javadoc proposal in annotation hover
49+
New Show Javadoc proposal in annotation hover:
5450

5551
![Show Javadoc proposal in annotation hover](images/ShowJavadocQuickfix.png)
5652

57-
Javadoc popup shown after activating the proposal
53+
Javadoc pop-up shown after activating the proposal:
5854

59-
![Javadoc popup shown after activating the proposal](images/JavadocControl.png)
55+
![Javadoc pop-up shown after activating the proposal](images/JavadocControl.png)
6056

61-
### New Convert Class To Record Quick-assist / Refactoring
57+
### New Convert Class to Record Quick-assist / Refactoring
6258

6359
<details>
6460
<summary>Contributors</summary>
6561

6662
- [Jeff Johnston](https://github.com/jjohnstn)
6763
</details>
6864

69-
A new refactoring has been added: `Right-click` -> `Refactoring` -> `Convert Class to Record...`, which will convert an appropriate class into a record.
65+
A new refactoring has been added, `Right-click` -> `Refactoring` -> `Convert Class to Record...`, which will convert an appropriate class into a record.
7066

7167
1. The class must have only one or more private instance field members that are all initialized in a single constructor by simple assignment and no static members.
7268
2. The class must have at most one getter method per instance field that simply returns the field value.
7369
3. The class can only extend Object and cannot implement any interface.
7470
4. The class may override `equals()`, `hashCode()`, or `toString()` from Object and these will be copied into the record but it cannot have any other methods except for the aforementioned constructor and getter methods.
7571

76-
The refactoring may note that the conversion is not possible or issue a warning before conversion:
77-
for example, if there is a field that does not have a getter, a warning will be issued that the field will be exposed via an accessor and the user may choose to continue or not.
72+
The refactoring may note that the conversion is not possible or issue a warning before conversion.
73+
For example, if there is a field that does not have a getter, a warning will be issued that the field will be exposed via an accessor and the user may choose to continue or not.
7874

7975
When the record is created, all references to the previous getters will be changed to call the appropriate record accessors.
8076

@@ -100,7 +96,7 @@ will be converted to:
10096

10197
A new quick-assist has been added to disable or enable a JUnit test in the editor.
10298
To disable an active test, select within the JUnit test and perform `Ctrl-1` -> `Disable test with @Disabled`.
103-
To enable a disabled test, select within the JUnit test and perform `Ctrl-1` -> `Enable test (remove @Enabled)`
99+
To enable a disabled test, select within the JUnit test and perform `Ctrl-1` -> `Enable test (remove @Disabled)`.
104100

105101
For example:
106102

@@ -131,8 +127,8 @@ results in:
131127
- [Mateusz Matela](https://github.com/mateusz-matela)
132128
</details>
133129

134-
When `Enable Markdown Javadoc formatting` is enabled, the `formatter` now recognizes structured Markdown syntax inside `///` comments and formats it appropriately instead of treating it as plain text.
135-
Supported elements include __headings__, __ordered__ and __unordered lists__ (with proper nesting), __fenced__ and __indented code blocks__, __tables__ and __markdown-style tag annotations__.
130+
When `Enable Markdown Javadoc formatting` is enabled, the `formatter` now recognizes structured Markdown syntax inside `///` comments and formats it appropriately instead of treating it as plain text.
131+
Supported elements include __headings__, __ordered__ and __unordered lists__ (with proper nesting), __fenced__, and __indented code blocks__, __tables__, and __markdown-style tag annotations__.
136132

137133
Nested lists are aligned consistently, wrapped list items preserve correct indentation, and fenced code blocks (both ` ``` ` and `~~~` styles) are recognized and their enclosed code snippets are formatted while preserving structure.
138134
The formatter also validates and handles malformed list or numbering patterns gracefully without disrupting the surrounding content.
@@ -144,7 +140,7 @@ The formatting behavior follows the [CommonMark specification](https://spec.comm
144140
## Debugger
145141

146142

147-
### Improved Highlighting For Inline Chained Lambdas
143+
### Improved Highlighting for Inline Chained Lambdas
148144

149145
<details>
150146
<summary>Contributors</summary>
@@ -156,7 +152,7 @@ Building on the `inline lambda breakpoint` support added in **Eclipse 4.38**, th
156152

157153
Previously, selecting or focusing a lambda stack frame in a chained expression highlighted the entire line, making it difficult to identify the exact lambda.
158154

159-
Now only the suspended lambda is highlighted, making it much easier to follow execution in complex chained expressions.
155+
Now, only the suspended lambda is highlighted, making it much easier to follow execution in complex chained expressions.
160156

161157
![Lambda Highlighting](images/LambdaHighlight.gif)
162158

@@ -169,8 +165,8 @@ Now only the suspended lambda is highlighted, making it much easier to follow ex
169165
- [Sougandh S](https://github.com/SougandhS)
170166
</details>
171167

172-
The `Debug Shell` now supports drag and drop from the `Variables` and `Expressions` views.
173-
You can drag a variable or expression directly into the `Debug Shell`, where it is inserted at the caret location.
168+
The `Debug Shell` now supports drag and drop from the `Variables` and `Expressions` views.
169+
You can drag a variable or expression directly into the `Debug Shell`, where it is inserted at the caret location.
174170
This makes it easier to reuse existing expressions and quickly build new ones using variables during a debug session, without manual typing or copying.
175171

176172
#### Variable Drop

news/4.39/platform.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ A special thanks to everyone who [contributed to Eclipse-Platform](acknowledgeme
2121
<details>
2222
<summary>Contributors</summary>
2323

24-
- [Elsa Zacharia ](https://github.com/elsazac)
24+
- [Elsa Zacharia](https://github.com/elsazac)
2525
</details>
2626

27-
The `Colors and Fonts` preferences page now displays descriptions for the top level theme categories in addition to the individual sub tree elements.
28-
Previously, only child entries in the tree provided descriptive text.
29-
With this update, parent categories such as `Java`, `Basic`, `Debug`, `Text Compare` etc. also include descriptions, helping users better understand what each category covers and making it easier to locate relevant settings.
27+
The `Colors and Fonts` preferences page now displays descriptions for the top-level theme categories in addition to the individual subtree elements.
28+
Previously, only child entries in the tree provided descriptive text.
29+
With this update, parent categories such as `Java`, `Basic`, `Debug`, `Text Compare`, etc. also include descriptions, helping users better understand what each category covers and making it easier to locate relevant settings.
3030

3131
![Theme category description](images/ColorsandFonts.png)
3232

@@ -81,7 +81,7 @@ The Equinox launcher executable still contained a manifest that defines a DPI aw
8181

8282
Until now, this led to the splash screen not properly being scaled and to potentially incorrect results at the handover of the splash screen to SWT and the Platform Workbench.
8383
With this release, the Equinox launcher process defaults to DPI awareness "PerMonitorV2" and uses the same autoscale defaults as SWT again.
84-
For information about the SWT defaults, which also have been updated and unified with this release, see [the according news](platform_isv.md#monitor-specific-scaling-by-default-windows).
84+
For information about the SWT defaults, which also have been updated and unified with this release, see [the related news](platform_isv.md#monitor-specific-scaling-by-default-windows).
8585

8686
Monitor-specific scaling can be disabled via `-Dswt.autoScale.updateOnRuntime=false`, which will also make the Equinox launcher use the preexisting autoscaling defaults for the splash screen.
87-
The process will still use DPI awareness "PerMonitorV2", but this will automatically be overwritten by SWT for a Display's UI thread to be "System" again.
87+
The process will still use DPI awareness "PerMonitorV2", but this will automatically be overwritten by SWT for a Display's UI thread to be "System" again.

0 commit comments

Comments
 (0)