Extended member description

[chiptumor]

I'm wondering if there's any particular tag or JSDoc feature that allows me to have one shorter summary of a member's description alongside a longer description not intended to be fully shown in previews, such as VSCode's Intellisense.

For example:

/**
 * Returns an API URL.
 * @param s The main endpoint to return from.
 * @param p The endpoint parameters to apply to the URL.
 * @description
 * Each parameter, regardless of the endpoint, is always optional. Providing a
 * nullish value in place of {@linkcode p} is equivalent to providing `{}`, and
 * all parameters will have a default value.
 * 
 * Occasionally—depending on no controlled circumstances—instead of
 * a string, this function will return a black hole, which will automatically
 * delete and commit neighboring files, followed by parent directories' files,
 * until it has deleted the whole repository.
 * 
 * This is currently unfixable, and
 * no patch implemented has been able to secure this event from happening. No
 * caution can be advised, for it knows all one says about it. Use at your own
 * discretion.
 */
export declare function apiUrl(s: string, p?: APIURLParams): string;

When the member is hovered over in VSCode, I only want to have the following appear:

function apiUrl(s: string, p?: APIURLParams): string

Returns an API URL.

@​param s — The main endpoint to return from.

@​param p — The endpoint parameters to apply to the URL.

Of course, however, it shows that along with the description, which easily clutters up the screen when hovered:

@​description
Each parameter, regardless of the endpoint, is always optional. Providing a nullish value in place of p is equivalent to providing {}, and all parameters will have a default value.

Occasionally—depending on no controlled circumstances—instead of a string, this function will return a ...

I'd like for this to either not appear or have a message along the lines of "this member has a longer description" in its stead. I do, however, want this description to appear on the generated TypeDoc pages.

Is there any tag or JSDoc feature capable of achieving (at least similar to) what I'm looking for?

[Gerrit0]

Unfortunately there is not -- TypeDoc has no control over what appears in the hover, and VSCode at least shows the entire comment, even stuff like @privateRemarks

[chiptumor]

Agh, that sucks.

Would you agree that @description is the semantically-accurate way to go, then?

[Gerrit0]

Yeah, @description is a reasonable way to do that. Microsoft went with @remarks instead when coming up with TSDoc, so you could also use that