microsoft / microsoft/tsdoc

Document inline parameters

Open
#161 2 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

Hello,

I would like to know if there is currently a defined way to document such a function:
function error(message: string, mOptions?: { onClose?: () => void, title?: string})

I tried for example this approach:

       /**
         * Error ! 
         * @param {string} message - a message
         * @param {any=} mOptions - some options
         * @param {any=} mOptions.onClose - a callback function
         * @param {string=} mOptions.title - a title, as string
         * @returns {void}
         */

Of course in "pure" TypeScript an interface would be created and documented. That would be the way to go. But here The function exists and already has such a signature. I only need to add some documentation to help using it.

Do you know if I am filling a feature request here, or if this is already supported by tsdoc ? I can't find it :(

Thanks !

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

The issue provides no repository file, test, or entry point to start from. Begin by reviewing the inline function signature and the shown @param syntax, then determine whether TSDoc already defines a representation for nested inline parameters. Done should be a documented specification decision or a clearly scoped feature proposal.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.