Skip to content

Cross-linking for argument types in typescript #130

Open
@Luthaf

Description

@Luthaf

Hi, and thanks a lot for this package! I am using it to document a typescript project, and I have a feature request.


Code like this

interface Person {
   age: number;
   city: string;
}

class Bar {
    private drinks: string[] = [];
}

/**
 * get_out description
 * @param  person description
 * @param  bar    description
 */
function get_out(person: Person, bar: Bar) {}
.. js:autoclass:: Person

.. js:autoclass:: Bar

.. js:autofunction:: get_out

currently renders as

screenshot

It would greatly improve navigation if the types of parameters (index.Person and index.Bar) where links to the documentation for the type.

Is it currently possible to do this?

Thanks for your time

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions