Skip to content

Commit

Permalink
Hand convert non-JSDoc at-internal comments
Browse files Browse the repository at this point in the history
If these are regular comments, then they won't appear in our d.ts files.
But, now we are relying on api-extractor to produce out final merged
d.ts files, so they need to be present in the "input" d.ts files,
meaning they have to be JSDoc comments.

These comments only work today because all of our builds load their TS
files from scratch, so they see the actual source files and their
non-JSDoc comments.
  • Loading branch information
jakebailey committed Sep 7, 2022
1 parent 5360203 commit 4776832
Show file tree
Hide file tree
Showing 57 changed files with 1,627 additions and 1,627 deletions.
22 changes: 11 additions & 11 deletions src/compiler/builderPublic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,31 +24,31 @@ export interface BuilderProgramHost {
/**
* disable using source file version as signature for testing
*/
/*@internal*/
/** @internal */
disableUseFileVersionAsSignature?: boolean;
/**
* Store the list of files that update signature during the emit
*/
/*@internal*/
/** @internal */
storeFilesChangingSignatureDuringEmit?: boolean;
/**
* Gets the current time
*/
/*@internal*/
/** @internal */
now?(): Date;
}

/**
* Builder to manage the program state changes
*/
export interface BuilderProgram {
/*@internal*/
/** @internal */
getState(): ReusableBuilderProgramState;
/*@internal*/
/** @internal */
saveEmitState(): SavedBuildProgramEmitState;
/*@internal*/
/** @internal */
restoreEmitState(saved: SavedBuildProgramEmitState): void;
/*@internal*/
/** @internal */
hasChangedEmitSignature?(): boolean;
/**
* Returns current program
Expand All @@ -57,12 +57,12 @@ export interface BuilderProgram {
/**
* Returns current program that could be undefined if the program was released
*/
/*@internal*/
/** @internal */
getProgramOrUndefined(): Program | undefined;
/**
* Releases reference to the program, making all the other operations that need program to fail.
*/
/*@internal*/
/** @internal */
releaseProgram(): void;
/**
* Get compiler options of the program
Expand Down Expand Up @@ -122,13 +122,13 @@ export interface BuilderProgram {
* in that order would be used to write the files
*/
emit(targetSourceFile?: SourceFile, writeFile?: WriteFileCallback, cancellationToken?: CancellationToken, emitOnlyDtsFiles?: boolean, customTransformers?: CustomTransformers): EmitResult;
/*@internal*/
/** @internal */
emitBuildInfo(writeFile?: WriteFileCallback, cancellationToken?: CancellationToken): EmitResult;
/**
* Get the current directory of the program
*/
getCurrentDirectory(): string;
/*@internal*/
/** @internal */
close(): void;
}

Expand Down
4 changes: 2 additions & 2 deletions src/compiler/builderStatePublic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ import { BuildInfo, Diagnostic } from "./_namespaces/ts";
export interface EmitOutput {
outputFiles: OutputFile[];
emitSkipped: boolean;
/* @internal */ diagnostics: readonly Diagnostic[];
/** @internal */ diagnostics: readonly Diagnostic[];
}

export interface OutputFile {
name: string;
writeByteOrderMark: boolean;
text: string;
/* @internal */ buildInfo?: BuildInfo
/** @internal */ buildInfo?: BuildInfo
}
Loading

0 comments on commit 4776832

Please sign in to comment.