typedoc: referenced files "not included in the documentation"

[NMaghfurUsman]

A lot of files don't get included in the document generation by typedoc.

📦[nabil@npm masto.js]$ npm run docs:build

> [email protected] docs:build
> typedoc ./src/index.ts && touch ./docs/.nojekyll

./src/mastodon/rest/v1/featured-tag-repository.ts:15:5 - [warning] Encountered an unknown block tag @done

15       * @done

[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.follow has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.unfollow has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.note.__type.create has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.note.__type.create has an @param with name "param", which was not used
[warning] The signature mastodon.rest.v1.DomainBlockRepository.create has an @param with name "domain", which was not used
[warning] The signature mastodon.rest.v1.DomainBlockRepository.remove has an @param with name "domain", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.remove has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.accounts.__type.list has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.accounts.__type.create has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.accounts.__type.remove has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.MediaAttachmentRepository.$select.__type.fetch has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.MediaAttachmentRepository.$select.__type.update has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.TimelineRepository.tag.__type.$select.__type.list has an @param with name "hashtag", which was not used
[warning] The signature mastodon.rest.v1.TimelineRepository.list.__type.$select.__type.list has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v2.FilterRepository.$select.__type.keywords.__type.create has an @param with name "id", which was not used
[warning] BaseCreateTokenParams, defined in ./src/mastodon/oauth/token-repository.ts, is referenced by mastodon.oauth.CreateTokenWithClientCredentialsParams but not included in the documentation
[warning] BaseEvent, defined in ./src/mastodon/streaming/event.ts, is referenced by mastodon.streaming.AnnouncementDeleteEvent but not included in the documentation
[warning] BaseNotificationWithReport, defined in ./src/mastodon/entities/v1/notification.ts, is referenced by mastodon.v1.AdminReportNotification but not included in the documentation
[warning] NotificationGroupWithReport, defined in ./src/mastodon/entities/v1/grouped-notifications.ts, is referenced by mastodon.v1.AdminReportNotificationGroup but not included in the documentation
[warning] BaseNotificationPlain, defined in ./src/mastodon/entities/v1/notification.ts, is referenced by mastodon.v1.AdminSignUpNotification but not included in the documentation
[warning] NotificationGroupPlain, defined in ./src/mastodon/entities/v1/grouped-notifications.ts, is referenced by mastodon.v1.AdminSignUpNotificationGroup but not included in the documentation
[warning] BaseNotificationWithStatus, defined in ./src/mastodon/entities/v1/notification.ts, is referenced by mastodon.v1.FavouriteNotification but not included in the documentation
[warning] NotificationGroupWithStatusId, defined in ./src/mastodon/entities/v1/grouped-notifications.ts, is referenced by mastodon.v1.FavouriteNotificationGroup but not included in the documentation
[warning] NotificationGroupWithModerationWarning, defined in ./src/mastodon/entities/v1/grouped-notifications.ts, is referenced by mastodon.v1.ModerationWarningNotificationGroup but not included in the documentation
[warning] NotificationGroupWithEvent, defined in ./src/mastodon/entities/v1/grouped-notifications.ts, is referenced by mastodon.v1.SeveredRelationshipsNotificationGroup but not included in the documentation
[warning] MastoHttpConfigProps, defined in ./src/adapters/config/http-config.ts, is referenced by createOAuthAPIClient.props but not included in the documentation
[warning] LogConfigProps, defined in ./src/adapters/clients.ts, is referenced by createOAuthAPIClient.props but not included in the documentation
[warning] WebSocketConfigProps, defined in ./src/adapters/config/web-socket-config.ts, is referenced by createStreamingAPIClient.props but not included in the documentation
[warning] WebSocketCustomImplProps, defined in ./src/adapters/clients.ts, is referenced by createStreamingAPIClient.props but not included in the documentation
[warning] AccountRepository, defined in ./src/mastodon/rest/v1/admin/account-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.accounts but not included in the documentation
[warning] CanonicalEmailBlockRepository, defined in ./src/mastodon/rest/v1/admin/canonical-email-block-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.canonicalEmailBlocks but not included in the documentation
[warning] DimensionRepository, defined in ./src/mastodon/rest/v1/admin/dimension-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.dimensions but not included in the documentation
[warning] DomainAllowRepository, defined in ./src/mastodon/rest/v1/admin/domain-allow-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.domainAllows but not included in the documentation
[warning] DomainBlockRepository, defined in ./src/mastodon/rest/v1/admin/domain-block-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.domainBlocks but not included in the documentation
[warning] EmailDomainBlockRepository, defined in ./src/mastodon/rest/v1/admin/email-domain-block-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.emailDomainBlocks but not included in the documentation
[warning] IpBlockRepository, defined in ./src/mastodon/rest/v1/admin/ip-block-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.ipBlocks but not included in the documentation
[warning] MeasureRepository, defined in ./src/mastodon/rest/v1/admin/measure-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.measures but not included in the documentation
[warning] ReportRepository, defined in ./src/mastodon/rest/v1/admin/report-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.reports but not included in the documentation
[warning] RetentionRepository, defined in ./src/mastodon/rest/v1/admin/retention-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.retention but not included in the documentation
[warning] TrendRepository, defined in ./src/mastodon/rest/v1/admin/trend-repository.ts, is referenced by mastodon.rest.v1.AdminRepository.trends but not included in the documentation
[warning] WebPushSubscriptionRepository, defined in ./src/mastodon/rest/v1/push/web-push-subscription-repository.ts, is referenced by mastodon.rest.v1.PushRepository.subscription but not included in the documentation
[warning] AccountWarning, defined in ./src/mastodon/entities/v1/account-warning.ts, is referenced by mastodon.v1.ModerationWarningNotification.__type.moderationWarning but not included in the documentation
[warning] HttpMetaParams, defined in ./src/interfaces/http.ts, is referenced by mastodon.oauth.Client.revoke.meta but not included in the documentation
[warning] UpdateStatusMediaAttribute, defined in ./src/mastodon/rest/v1/status-repository.ts, is referenced by mastodon.rest.v1.UpdateStatusParams.__type.mediaAttributes but not included in the documentation
[info] Documentation generated at ./docs
[warning] Found 0 errors and 45 warnings

The warnings were not very helpful, so I tried using the --treatWarningsAsErrors flag to see if I could get typedoc to give me more descriptive errors, but surprisingly this just fixed the issue immediately: the referenced files now get included by typedoc. This behaviour might be an upstream bug, but I'm unsure.

📦[nabil@npm masto.js]$ npm run docs:build

> [email protected] docs:build
> typedoc ./src/index.ts --treatWarningsAsErrors && touch ./docs/.nojekyll

./src/mastodon/rest/v1/featured-tag-repository.ts:15:5 - [warning] Encountered an unknown block tag @done

15       * @done

[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.follow has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.unfollow has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.note.__type.create has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.AccountRepository.$select.__type.note.__type.create has an @param with name "param", which was not used
[warning] The signature mastodon.rest.v1.DomainBlockRepository.create has an @param with name "domain", which was not used
[warning] The signature mastodon.rest.v1.DomainBlockRepository.remove has an @param with name "domain", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.remove has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.accounts.__type.list has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.accounts.__type.create has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.ListRepository.$select.__type.accounts.__type.remove has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.MediaAttachmentRepository.$select.__type.fetch has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.MediaAttachmentRepository.$select.__type.update has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v1.TimelineRepository.tag.__type.$select.__type.list has an @param with name "hashtag", which was not used
[warning] The signature mastodon.rest.v1.TimelineRepository.list.__type.$select.__type.list has an @param with name "id", which was not used
[warning] The signature mastodon.rest.v2.FilterRepository.$select.__type.keywords.__type.create has an @param with name "id", which was not used
[warning] Found 0 errors and 16 warnings

typedoc version:

TypeDoc 0.26.11
Using TypeScript 5.6.3 from ./node_modules/typescript/lib