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

Definable @param format #1

Closed
GeekyEggo opened this issue Jan 16, 2017 · 2 comments
Closed

Definable @param format #1

GeekyEggo opened this issue Jan 16, 2017 · 2 comments
Assignees

Comments

@GeekyEggo
Copy link

GeekyEggo commented Jan 16, 2017

I was wondering if it's currently possible to define the @param format?

Within Commenter.hx#L186 the construction of param comments could provide the current item's information as parameters; these could then be used in conjunction with a user-definable @param format, e.g.

{
    "codedox": {
        "paramformat": "@param {{${type}}} ${name}"
    }
   ...
}

Then for a given parameter name: string, the result would be @param {string} name

@wiggin77
Copy link
Member

Good idea. I'll add this soon.

@wiggin77 wiggin77 self-assigned this Jan 16, 2017
@wiggin77
Copy link
Member

As of 1.2.1 you can customize @params and @return. To add types to @params:

{
    "codedox": {
        "paramFormat": "@param {${type}} ${name}"
    }
   ...
}

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

No branches or pull requests

2 participants