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

Kinda Sorted list of method names. #114

Open
demmings opened this issue Jan 8, 2023 · 1 comment
Open

Kinda Sorted list of method names. #114

demmings opened this issue Jan 8, 2023 · 1 comment

Comments

@demmings
Copy link

demmings commented Jan 8, 2023

The method names of the class are sorted to a point, then it starts over again. (unless this is intended behavior).

You can see in this example, it is sorted up until whereCondition and then starts in a sorted order from dateToMs

image

My jsdoc.json

{
    "source": {
        "include": [
            "SQL"
        ],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "./node_modules/jsdoc/plugins/markdown"
    ],
    "templates": {
        "cleverLinks": true,
        "monospaceLinks": true
    },
    "opts": {
        "recurse": true,
        "destination": "./docs/",
        "template": "./node_modules/docdash"
    },
    "docdash": {
        "sort": [
            true
        ]
    }
}

UPDATE
I see that the STATIC methods are grouped after the non-static methods. I guess this must be the expected behaviour, but it was not initially obvious to me.

@ar2rsawseen
Copy link
Collaborator

Yes, I think properties are also there in the mix before methods.
But at least properties have # before their name. Maybe something similar is needed for static methods too?
Or just put (static)
I wonder how the original JSdoc template distinguishes it.

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

No branches or pull requests

2 participants