Open erickzhao opened 3 weeks ago
Do we also need to add explicit external link config for osx-sign
and windows-sign
? Plus any other dependency where we proxy the options that I'm forgetting.
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 89.06%. Comparing base (
2f92bbd
) to head (9080e0d
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Cleanup PR based on learnings from the TypeDoc PRs.
npx typedoc
rather than JavaScript API removes legacybuild_docs.js
from code. Their JavaScript API has minimal documentation, and most options are available viatypedoc.json
configuration anyways.externalSymbolLinkMappings
to show links to types available via external Electron packages (e.g. get and notarize).Tag changes:
@example
tag.[[link tag syntax]]
to use{@link tag syntax}
.@interface
to expand utility types whenever possible (e.g. instead ofOmit<TypeA, 'KeyB' | 'KeyC'>
, adding the@interface
tag makes it so that all ofTypeA
's properties are displayed in the API documentation excludingKeyB
andKeyC
.@internal
andexcludeInternals
to hide types that should not be used by end users of Electron Packager.