Skip to content

Commit 63ac570

Browse files
committed
Fix all at-internal comments, which need to be attached to a declaration
1 parent b8bbc7b commit 63ac570

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1123
-512
lines changed

Diff for: src/api-extractor-base.json

+19-2
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,23 @@
379379
"default": {
380380
"logLevel": "warning"
381381
// "addToApiReportFile": false
382+
},
383+
384+
"ae-internal-missing-underscore": {
385+
"logLevel": "none",
386+
"addToApiReportFile": false
387+
},
388+
389+
// TODO(jakebailey): should we explicitly mark things as public?
390+
"ae-missing-release-tag": {
391+
"logLevel": "none",
392+
"addToApiReportFile": false
393+
},
394+
395+
// TODO(jakebailey): Fix these?
396+
"ae-unresolved-link": {
397+
"logLevel": "none",
398+
"addToApiReportFile": false
382399
}
383400

384401
// "ae-extra-release-tag": {
@@ -398,8 +415,8 @@
398415
*/
399416
"tsdocMessageReporting": {
400417
"default": {
401-
"logLevel": "warning"
402-
// "addToApiReportFile": false
418+
"logLevel": "none",
419+
"addToApiReportFile": false
403420
}
404421

405422
// "tsdoc-link-tag-unescaped-text": {

Diff for: src/compiler/builder.ts

+6-3
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,10 @@ export const enum BuilderFileEmit {
9292
Full
9393
}
9494

95-
/** @internal */
9695
/**
9796
* State to store the changed files, affected files and cache semantic diagnostics
97+
*
98+
* @internal
9899
*/
99100
// TODO: GH#18217 Properties of this interface are frequently asserted to be defined.
100101
export interface BuilderProgramState extends BuilderState, ReusableBuilderProgramState {
@@ -803,15 +804,17 @@ export type ProgramBuildInfoBuilderStateFileInfo = Omit<BuilderState.FileInfo, "
803804
*/
804805
signature: string | false | undefined;
805806
};
806-
/** @internal */
807807
/**
808808
* [fileId, signature] if different from file's signature
809809
* fileId if file wasnt emitted
810+
*
811+
* @internal
810812
*/
811813
export type ProgramBuildInfoEmitSignature = ProgramBuildInfoFileId | [fileId: ProgramBuildInfoFileId, signature: string];
812-
/** @internal */
813814
/**
814815
* ProgramBuildInfoFileInfo is string if FileInfo.version === FileInfo.signature && !FileInfo.affectsGlobalScope otherwise encoded FileInfo
816+
*
817+
* @internal
815818
*/
816819
export type ProgramBuildInfoFileInfo = string | ProgramBuildInfoBuilderStateFileInfo;
817820
/** @internal */

Diff for: src/compiler/commandLineParser.ts

+14-7
Original file line numberDiff line numberDiff line change
@@ -122,15 +122,17 @@ const libEntries: [string, string][] = [
122122
* An array of supported "lib" reference file names used to determine the order for inclusion
123123
* when referenced, as well as for spelling suggestions. This ensures the correct ordering for
124124
* overload resolution when a type declared in one lib is extended by another.
125+
*
126+
* @internal
125127
*/
126-
/** @internal */
127128
export const libs = libEntries.map(entry => entry[0]);
128129

129130
/**
130131
* A map of lib names to lib files. This map is used both for parsing the "lib" command line
131132
* option as well as for resolving lib reference directives.
133+
*
134+
* @internal
132135
*/
133-
/** @internal */
134136
export const libMap = new Map(libEntries);
135137

136138
// Watch related options
@@ -2142,8 +2144,9 @@ export function convertToObject(sourceFile: JsonSourceFile, errors: Push<Diagnos
21422144
* Convert the json syntax tree into the json value and report errors
21432145
* This returns the json value (apart from checking errors) only if returnValue provided is true.
21442146
* Otherwise it just checks the errors and returns undefined
2147+
*
2148+
* @internal
21452149
*/
2146-
/** @internal */
21472150
export function convertToObjectWorker(
21482151
sourceFile: JsonSourceFile,
21492152
rootExpression: Expression | undefined,
@@ -2389,8 +2392,9 @@ export interface ConvertToTSConfigHost {
23892392
* @param configParseResult options to be generated into tsconfig.json
23902393
* @param configFileName name of the parsed config file - output paths will be generated relative to this
23912394
* @param host provides current directory and case sensitivity services
2395+
*
2396+
* @internal
23922397
*/
2393-
/** @internal */
23942398
export function convertToTSConfig(configParseResult: ParsedCommandLine, configFileName: string, host: ConvertToTSConfigHost): TSConfig {
23952399
const getCanonicalFileName = createGetCanonicalFileName(host.useCaseSensitiveFileNames);
23962400
const files = map(
@@ -2586,8 +2590,9 @@ function getSerializedCompilerOption(options: CompilerOptions): ESMap<string, Co
25862590
* Generate tsconfig configuration when running command line "--init"
25872591
* @param options commandlineOptions to be generated into tsconfig.json
25882592
* @param fileNames array of filenames to be generated into tsconfig.json
2593+
*
2594+
* @internal
25892595
*/
2590-
/** @internal */
25912596
export function generateTSConfig(options: CompilerOptions, fileNames: readonly string[], newLine: string): string {
25922597
const compilerOptionsMap = getSerializedCompilerOption(options);
25932598
return writeConfigurations();
@@ -3407,8 +3412,9 @@ const wildcardDirectoryPattern = /^[^*?]*(?=\/[^/]*[*?])/;
34073412
* @param options Compiler options.
34083413
* @param host The host used to resolve files and directories.
34093414
* @param extraFileExtensions optionaly file extra file extension information from host
3415+
*
3416+
* @internal
34103417
*/
3411-
/** @internal */
34123418
export function getFileNamesFromConfigSpecs(
34133419
configFileSpecs: ConfigFileSpecs,
34143420
basePath: string,
@@ -3726,8 +3732,9 @@ function removeWildcardFilesWithLowerPriorityExtension(file: string, wildcardFil
37263732
/**
37273733
* Produces a cleaned version of compiler options with personally identifying info (aka, paths) removed.
37283734
* Also converts enum values back to strings.
3735+
*
3736+
* @internal
37293737
*/
3730-
/** @internal */
37313738
export function convertCompilerOptionsForTelemetry(opts: CompilerOptions): CompilerOptions {
37323739
const out: CompilerOptions = {};
37333740
for (const key in opts) {

0 commit comments

Comments
 (0)