Paul King created GROOVY-11482:
----------------------------------
Summary: Improve documentation using method categories
Key: GROOVY-11482
URL: https://issues.apache.org/jira/browse/GROOVY-11482
Project: Groovy
Issue Type: Improvement
Reporter: Paul King
Attachments: image-2024-09-23-20-34-29-532.png,
image-2024-09-23-20-39-02-272.png
This is a placeholder to investigate whether we can use the ideas in the
following article to improve our documentation:
[https://donraab.medium.com/associating-method-categories-with-emojis-in-intellij-and-javadoc-a82aebe1e903]
The structure view within IDEA might look like this:
!image-2024-09-23-20-39-02-272.png!
The Javadoc might look like this:
!image-2024-09-23-20-34-29-532.png!
These pictures are for a mock up of {{DefaultGroovyMethods}}.
We'd need to consider several issues including:
* Can we use some of the ideas without any tooling tweaks needed?
* Would we apply these ideas to extension methods (as per above) or
non-extension methods, or both?
* Do we need to adapt DocGenerator to better support these ideas?
* Do we need to adapt Groovydoc to better support these ideas?
* For some classes we arrange methods in alphabetical order. We'd possibly have
to re-order to be alphabetical within the regions. Would we be happy with this?
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
