Saljack opened a new issue, #7355:
URL: https://github.com/apache/netbeans/issues/7355

   ### Description
   
   It would be nice to have rendered javadoc comments in code. This can 
increase the readability of code. The same functionality has IDEA and it helps 
a lot see it in their documentation 
https://www.jetbrains.com/help/idea/javadocs.html#toggle-rendered-view . 
   
   ### Use case/motivation
   
   When a method, class etc. has a javadoc comment then this comment is 
rendered in code as you can see in the Javadoc window instead of raw javadoc. 
   E.g.:
   ```java
   /**
    * Represents an operation that accepts a single input argument and returns 
no
    * result. Unlike most other functional interfaces, {@code Consumer} is 
expected
    * to operate via side-effects.
    *
    * <p>This is a <a href="package-summary.html">functional interface</a>
    * whose functional method is {@link #accept(Object)}.
    *
    * @param <T> the type of the input to the operation
    *
    * @since 1.8
    */
   ```
   there will be rendered javadoc:
   """
   Represents an operation that accepts a single input argument and returns no 
result. Unlike most other functional interfaces, Consumer is expected to 
operate via side-effects.
   
   This is a [functional 
interface](https://github.com/apache/netbeans/issues/package-summary.html) 
whose functional method is 
[accept(Object)](https://github.com/apache/netbeans/issues/*2).
   
   Type Parameters:
   &nbsp;&nbsp; T - the type of the input to the operation 
   Since:
   &nbsp;&nbsp; 1.8
   """
   
   And it will be changed back to raw javadoc if the user click into this 
rendered part. 
   
   Current raw javadoc:
   
![image](https://github.com/apache/netbeans/assets/614424/179739f1-4dd0-45d6-8896-b153df27f810)
   vs
   Rendered javadoc example:
   
![image](https://github.com/apache/netbeans/assets/614424/dd57c4ac-7587-4795-abcc-ed66393ccd68)
   
   
   
   
   ### Related issues
   
   _No response_
   
   ### Are you willing to submit a pull request?
   
   No


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists

Reply via email to