Skip to content

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

Closed
@augusttty

Description

@augusttty

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    templateRequires a change to a dmd partial/helper

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions