Skip to content

Fix open help with new menu item "Source or javadoc for class or package..." #46

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.

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 7 commits into from
Nov 29, 2020

Conversation

acardona
Copy link
Collaborator

Create new menu item "Source or javadoc for class or package..." which fixes or replaces the "Open Help" menu item, by using ClassUtils and showing a UI that lists all matching classes with buttons to open their source code in github or gitlab and the javadoc when available (will guess the URL, load it, and not show a link to it when 404).

Can match partial text (the list of possible classes may be longer) and can also match package names or partial package names. Any substring of a fully qualified class name will be matched, which is fabulous.

(Compare with current implementation of "Open Help..." which requires a fully qualified class name to work, which is not useful as often one does not know it or not have it handy in a script.)

This can happen when using a networked account across different computers
or with different monitors.
and collect info and URLs from their pom.xml
fixes or replaces the "Open Help" menu item, by using ClassUtils and
showing a UI that lists all matching classes with buttons to open their
source code in github or gitlab and the javadoc when available
(will guess the URL, load it, and not show a link to it when 404).

Can match partial text (the list of possible classes may be longer)
and can also match package names or partial package names. Any substring
of a fully qualified class name will be matched, which is fabulous.

(Compare with current implementatio nof "Open Help..." which requires
a fully qualified class name to work, which is not useful as often
one does not know it or not have it handy in a script.)
@imagesc-bot
Copy link

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/fixing-open-help-in-the-script-editor-find-documentation-and-source-code-for-java-classes/45330/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants