docdash icon indicating copy to clipboard operation
docdash copied to clipboard

Kinda Sorted list of method names.

Open demmings opened this issue 2 years ago • 1 comments

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.

demmings avatar Jan 08 '23 19:01 demmings

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.

ar2rsawseen avatar Jan 09 '23 12:01 ar2rsawseen