Add N&N for Javadoc styling improvements

See eclipse-jdt/eclipse.jdt.ui#1074
RedeemerSK · Apr 2, 2024 · 59caf92 · 59caf92
1 parent 54d09c8
commit 59caf92
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 1 deletion.
diff --git a/news/4.32/images/javadoc_styling_menu.png b/news/4.32/images/javadoc_styling_menu.png
diff --git a/news/4.32/images/javadoc_styling_new.png b/news/4.32/images/javadoc_styling_new.png
diff --git a/news/4.32/images/javadoc_styling_old.png b/news/4.32/images/javadoc_styling_old.png
diff --git a/news/4.32/jdt.html b/news/4.32/jdt.html
@@ -17,7 +17,7 @@
 table.news tr td.content {vertical-align: top;}
 ul {padding-left: 13px;}
 </style>
-<title>Eclipse Project 4.x - New and Noteworthy</title>
+<title>Eclipse Project 4.32 - New and Noteworthy</title>
 </head>
 
 <body>
@@ -73,6 +73,32 @@ <h2>Java Editor </h2>
     <h2>Java Views and Dialogs</h2>
     </td>
   </tr>
+  <tr id="javadocStylingImprovements">
+    <!-- https://github.com/eclipse-jdt/eclipse.jdt.ui/pull/1074 -->
+    <td class="title">Javadoc styling improvements</td>
+    <td class="content">
+      Styling of the method signatures displayed in Javadoc view & hover has been improved to make them easier
+      to read.
+      <p>
+      Until now, whole signature has been rendered as one continuous text making it little bit hard to tell apart specific parts.
+      Especially when signature contained type variables of generic declarations:
+      </p>
+      <p><img src="images/javadoc_styling_old.png" alt="Old Javadoc styling"/></p>
+      Now, by default, parts of the signature are visually distinguished by using italic, lighter or colorized text or placing
+      them on separate lines.
+      <p><img src="images/javadoc_styling_New.png" alt="New Javadoc styling"/></p>
+      <p>
+      Coloring is used to tell apart different types used as type variables. Four different colors are pre-configured and are also
+      re-used repeatedly in case more unique types are present in displayed Javaoc, unless custom colors have been configured.
+      </p>
+      <p>
+      All aspects of new styling can be customized through Javadoc styling menu accessible via new menu button added to the toolbar
+      of the Javadoc view and Javadoc hover (here visible after pressing F2), where the button itself toggles whole new styling
+      functionality on/off.
+      </p>
+      <p><img src="images/javadoc_styling_menu.png" alt="New Javadoc styling menu"/></p>
+    </td>
+  </tr>
   <!-- ******************* End of Java Views and Dialogs ************************************* -->
 
   <!-- ******************* Java Compiler ************************************* -->