spring-projects / spring-projects/spring-hateoas

Broken class level JavaDoc in ControllerEntityLinks

Open
#687 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
1.1k
Forks
476
PR merge metrics
No merged PRs in 30d

Description

It's not displaying properly in IDEA 2017.3.2.
I suggest the following fix

/**
 * {@link EntityLinks} implementation which assumes a certain URI mapping structure:
 * <ol>
 * <li>A class-level mapping annotation that can contain template variables. The URI needs to expose the collection
 * resource, which means the controller has to expose a handler method mapped to an empty path: e.g.
 * {@code @RequestMapping(method = RequestMethod.GET)} in case of a Spring MVC controller.</li>
 * <li>Individual resources are exposed via a nested mapping consisting of the id of the managed entity, e.g.
 * {@code @RequestMapping("/{id}")}.
 * </ol>
 * Full example:
 * <pre>{@code
 * @literal @Controller
 * @literal @ExposesResourceFor(Order.class)
 * @literal @RequestMapping("/orders")
 *  class OrderController {
 *
 *  @literal @RequestMapping
 *   ResponseEntity orders(…) { … }
 *
 *  @literal @RequestMapping("/{id}")
 *   ResponseEntity order(@PathVariable("id") … ) { … }
 *  }
 *  }</pre>
 *
 * @author Oliver Gierke
 */

Contributor guide

No contributing guide indexed for this repository

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

Locate the ControllerEntityLinks class and read its class-level JavaDoc. Compare it with the replacement shown in the issue; done means the JavaDoc renders correctly in IDEA 2017.3.2.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.