eclipse-xtext / eclipse-xtext/xtext

Xtend IDE: Add support for hovering/hyperlinking on method references in Javadoc

Open
#2,269 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
831
Forks
330
Avg merge
3d 7h
Merged PRs (30d)
12

Description

With the issue https://github.com/eclipse/xtext-xtend/issues/372 hovering/hyperlinknig on Javadoc links has been added to the Xtend IDE.

Hovewer, currently this feature works only for types, not for method references. See also comment from @tivervac .

This functionality should be extended to also work for method references: @see Bar#foo should refer to the foo method in the Bar class.

Example:

screenshot

package foo

/**
 * @see Bar#foo
 */
class Bar {
	
	/**
	 * Description of the method {@link #foo}
	 */
	def foo() {}
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named. Start by tracing the existing Xtend IDE Javadoc hover and hyperlink support added for issue 372, then compare how type links are resolved with method references. Done means @see Bar#foo and {@link #foo} navigate to the foo method in Bar.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.