Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lots of missing documentation entries #376

Open
Half-Shot opened this issue Nov 23, 2021 · 0 comments
Open

Lots of missing documentation entries #376

Half-Shot opened this issue Nov 23, 2021 · 0 comments
Labels
T-Documentation Improvements or additions to documentation

Comments

@Half-Shot
Copy link
Contributor

➜ matrix-appservice-bridge git:(develop) ✗ yarn gendoc
yarn run v1.22.17
$ typedoc
Warning: MembershipQueueOptsWithDefaults, defined at src/components/membership-queue.ts:68, is referenced by DEFAULT_OPTS but not included in the documentation.
Warning: VettedBridgeOpts, defined at src/bridge.ts:288, is referenced by Bridge.opts but not included in the documentation.
Warning: BridgeContextRoom, defined at src/components/bridge-context.ts:36, is referenced by BridgeContext.rooms but not included in the documentation.
Warning: BridgeContextSenders, defined at src/components/bridge-context.ts:24, is referenced by BridgeContext.senders but not included in the documentation.
Warning: BridgeContextTargets, defined at src/components/bridge-context.ts:30, is referenced by BridgeContext.targets but not included in the documentation.
Warning: OnEventSentHook, defined at src/components/intent.ts:35, is referenced by IntentOpts.onEventSent but not included in the documentation.
Warning: UserActivityMetadata, defined at src/components/user-activity.ts:17, is referenced by UserActivity.metadata but not included in the documentation.
Warning: CliArgs, defined at src/components/cli.ts:87, is referenced by Cli.getArgs.getArgs but not included in the documentation.
Warning: RoomStoreEntryDoc, defined at src/components/room-bridge-store.ts:442, is referenced by RoomBridgeStoreEntry.serializeEntry.serializeEntry but not included in the documentation.
Warning: StateLookupRoom, defined at src/components/state-lookup.ts:25, is referenced by StateLookup.trackRoom.trackRoom but not included in the documentation.
Warning: PossiblePromise, defined at src/bridge.ts:124, is referenced by BridgeController.onAliasQueried.onAliasQueried but not included in the documentation.
Warning: Opts, defined at src/components/bridge-info-state.ts:37, is referenced by BridgeInfoStateSyncer.constructor.new BridgeInfoStateSyncer.opts but not included in the documentation.
Warning: Query, defined at src/components/bridge-store.ts:19, is referenced by BridgeStore.delete.delete.query but not included in the documentation.
Warning: ClientFactoryOpts, defined at src/components/client-factory.ts:41, is referenced by ClientFactory.constructor.new ClientFactory.opts but not included in the documentation.
Warning: UserProfileKeys, defined at src/components/intent.ts:80, is referenced by EncryptedIntent.getProfileInfo.getProfileInfo.info but not included in the documentation.
Warning: BridgeErrorReason, defined at src/errors.ts:20, is referenced by EncryptedIntent.unstableSignalBridgeError.unstableSignalBridgeError.reason but not included in the documentation.
Warning: QueueUserItem, defined at src/components/membership-queue.ts:11, is referenced by MembershipQueue.queueMembership.queueMembership.item but not included in the documentation.
Warning: CollectorFunction, defined at src/components/prometheusmetrics.ts:23, is referenced by PrometheusMetrics.addCollector.addCollector.func but not included in the documentation.
Warning: CounterOpts, defined at src/components/prometheusmetrics.ts:37, is referenced by PrometheusMetrics.addCounter.addCounter.opts but not included in the documentation.
Warning: GagueOpts, defined at src/components/prometheusmetrics.ts:47, is referenced by PrometheusMetrics.addGauge.addGauge.opts but not included in the documentation.
Warning: HistogramOpts, defined at src/components/prometheusmetrics.ts:43, is referenced by PrometheusMetrics.addTimer.addTimer.opts but not included in the documentation.
Warning: HandlerFunction, defined at src/components/request-factory.ts:17, is referenced by RequestFactory.addDefaultRejectCallback.addDefaultRejectCallback.fn but not included in the documentation.
Warning: TimeoutFunction, defined at src/components/request-factory.ts:18, is referenced by RequestFactory.addDefaultTimeoutCallback.addDefaultTimeoutCallback.fn but not included in the documentation.
Warning: StateLookupOpts, defined at src/components/state-lookup.ts:18, is referenced by StateLookup.constructor.new StateLookup.opts but not included in the documentation.
Warning: ChangesCallback, defined at src/components/user-activity.ts:62, is referenced by UserActivityTracker.constructor.new UserActivityTracker.onChanges but not included in the documentation.
Warning: ThirdpartyLocationResponse, defined at src/thirdparty.ts:20, is referenced by BridgeController.__type.getLocation.getLocation but not included in the documentation.
Warning: ThirdpartyProtocolResponse, defined at src/thirdparty.ts:7, is referenced by BridgeController.__type.getProtocol.getProtocol but not included in the documentation.
Warning: ThirdpartyUserResponse, defined at src/thirdparty.ts:26, is referenced by BridgeController.__type.getUser.getUser but not included in the documentation.
Info: Documentation generated at ./.typedoc
Done in 3.15s.

@Half-Shot Half-Shot added the T-Documentation Improvements or additions to documentation label May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant