Skip to content

Customize the order of doc comment block tag rendering #2285

@Oblarg

Description

@Oblarg

Search Terms

block tags @remarks @example @param

Problem

Currently there seems to be no way to force the "parameters" block to render above the "examples" block. This is troublesome if the @example block is lengthy.

Suggested Solution

Add an option to mandate the rendering order (top-to-bottom) of the existing block tag sections. This could be represented by a simple string array.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions