typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
725 stars 177 forks source link

Table mode for type displays functions without parentheses #696

Closed Sytten closed 1 month ago

Sytten commented 1 month ago

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

When using the table mode for --typeDeclarationFormat, it will display the functions without the parentheses which is very confusing visually since you have no way of knowing if it's a function or a property. It is a bit annoying that those are considers properties in the first place (guessing this is a limitation of the compiler).

For example:

# Type Alias: Response

> **Response**: `object`

An immutable saved Response.

## Type declaration

| Name | Type |
| ------ | ------ |
| `getBody` | `undefined` \| [`Body`](../classes/Body.md) |
| `getCode` | `number` |
| `getCreatedAt` | `Date` |
| `getHeader` | `undefined` \| `string`[] |
| `getHeaders` | [`Record`](Record.md)\<`string`, `string`[]\> |
| `getId` | [`ID`](ID.md) |
| `getRaw` | [`ResponseRaw`](ResponseRaw.md) |
| `getRoundtripTime` | `number` |

TypeDoc configuration

--typeDeclarationFormat=table

Expected behavior

Display the name with (...args)

tgreyuk commented 1 month ago

Thanks - agreed. This will go into next release;

tgreyuk commented 1 month ago

fix in fix in typedoc-plugin-markdown@4.2.9.