Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Consider allowing method parameter links #150

Closed
abgruszecki opened this issue Aug 25, 2020 · 0 comments
Closed

Consider allowing method parameter links #150

abgruszecki opened this issue Aug 25, 2020 · 0 comments
Labels
consider Should be considered before we go public. nice-to-have Would be nice to have for the first release, but not necessary.

Comments

@abgruszecki
Copy link
Collaborator

See #149 (comment):

If it isn't available already ... it would be nice to reference a function parameter in the documentation text (such that it is seen as a function parameter and picked up during refactoring and such)

/**
 * Adds one to the specified ???
 *
 * @param number given number to add 1 to
 * @return ??? incremented by 1
 **/
def addOne(number: Int): Int = ...

A way to specify number, say [[@param number]] or something like that.

@abgruszecki abgruszecki added nice-to-have Would be nice to have for the first release, but not necessary. consider Should be considered before we go public. labels Aug 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
consider Should be considered before we go public. nice-to-have Would be nice to have for the first release, but not necessary.
Projects
None yet
Development

No branches or pull requests

2 participants