Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature request] Support optional instantiate parent name prefix #293

Open
augusttty opened this issue Apr 6, 2023 · 0 comments
Open

Comments

@augusttty
Copy link

By default, the instance method of a class output with a instantiate parent class name prefix on every method.
When the className getting longer, or the methods getting too many , it seems unnecessary to give every "local" method a prefix.
I expected to omit the parent name, and I do tried the partial and the helper, but none of theme can achieve without a sideEffect(the signature is shared).And I have to change the dmd the source code to achieve that.Can jsdoc2md add a configuration to achieve this?
For example:

=>source:


/**
 * Chat Service
 */
class ChatService {
  constructor(){}

  /**
   * send a message to a person
   */
  send() {}

  /**
   * receiving message
   */
  receive() {}
}

=>default jsdoc2md output:

ChatService

Chat Service

Kind: global class

chatService.send()

send a message to a person

Kind: instance method of ChatService

chatService.receive()

receiving message

Kind: instance method of ChatService

=>expected output:

//...

send()

send a message to a person

Kind: instance method of ChatService

receive()

receiving message

Kind: instance method of ChatService

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant