akka/akka-http

Allow linking to javadoc members

Open

#2,073 opened on Jun 14, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docs

Description

This requires some additional script to be included in the javadocs, which Lagom successfully does as described at https://github.com/lightbend/paradox/pull/160/files#r144705425

Contributor guide

Tech stack
scalajava
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
ScalaSBTParadox documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Review the linked PR in lightbend/paradox (https://github.com/lightbend/paradox/pull/160) to understand the approach for adding a script to javadocs. Then identify where akka http's javadoc generation is configured, likely in the SBT build file or Paradox configuration. The issue requires adding a similar script to akka http's javadocs to enable linking to members. No existing comments or assignees indicate prior work.