docs: clarify ScalaDoc syntax and semantics with practical notes#3254
Open
Dev-CodeBox wants to merge 1 commit intoscala:mainfrom
Open
docs: clarify ScalaDoc syntax and semantics with practical notes#3254Dev-CodeBox wants to merge 1 commit intoscala:mainfrom
Dev-CodeBox wants to merge 1 commit intoscala:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a focused update to the Scaladoc guide, clarifying commonly confusing
aspects of ScalaDoc syntax and semantics.
It covers companion object links, custom link text, nested lists,
@definescope rules, and macro inheritance behavior.
The aim is to document practical details often learned by trial and error,
while keeping the change minimal and consistent with existing docs.