Skip to content

Commit ca2885b

Browse files
octogonzoctogonz
committed
Update TSDoc tag capitalization to use camelCase, and fix a few TSDoc syntax issues
1 parent e08be6e commit ca2885b

36 files changed

Lines changed: 92 additions & 92 deletions

File tree

‎apps/api-extractor/src/analyzer/AstImport.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export enum AstImportKind {
2727
/**
2828
* Constructor parameters for AstImport
2929
*
30-
* @privateremarks
30+
* @privateRemarks
3131
* Our naming convention is to use I____Parameters for constructor options and
3232
* I____Options for general function options. However the word "parameters" is
3333
* confusingly similar to the terminology for function parameters modeled by API Extractor,

‎apps/api-extractor/src/analyzer/AstModule.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface IAstModuleOptions {
2323
/**
2424
* An internal data structure that represents a source file that is analyzed by AstSymbolTable.
2525
*
26-
* @privateremarks
26+
* @privateRemarks
2727
* Our naming convention is to use I____Parameters for constructor options and
2828
* I____Options for general function options. However the word "parameters" is
2929
* confusingly similar to the terminology for function parameters modeled by API Extractor,

‎apps/api-extractor/src/api/IExtractorConfig.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -377,44 +377,44 @@ export interface IExtractorConfig {
377377
compiler: IExtractorTsconfigCompilerConfig | IExtractorRuntimeCompilerConfig;
378378

379379
/**
380-
* {@inheritdoc IExtractorPoliciesConfig}
380+
* {@inheritDoc IExtractorPoliciesConfig}
381381
*/
382382
policies?: IExtractorPoliciesConfig;
383383

384384
/**
385-
* {@inheritdoc IExtractorValidationRulesConfig}
385+
* {@inheritDoc IExtractorValidationRulesConfig}
386386
*/
387387
validationRules?: IExtractorValidationRulesConfig;
388388

389389
/**
390-
* {@inheritdoc IExtractorProjectConfig}
390+
* {@inheritDoc IExtractorProjectConfig}
391391
*/
392392
project: IExtractorProjectConfig;
393393

394394
/**
395-
* {@inheritdoc IExtractorApiReviewFileConfig}
395+
* {@inheritDoc IExtractorApiReviewFileConfig}
396396
*/
397397
apiReviewFile?: IExtractorApiReviewFileConfig;
398398

399399
/**
400-
* {@inheritdoc IExtractorApiJsonFileConfig}
400+
* {@inheritDoc IExtractorApiJsonFileConfig}
401401
*/
402402
apiJsonFile?: IExtractorApiJsonFileConfig;
403403

404404
/**
405-
* {@inheritdoc IExtractorDtsRollupConfig}
405+
* {@inheritDoc IExtractorDtsRollupConfig}
406406
* @beta
407407
*/
408408
dtsRollup?: IExtractorDtsRollupConfig;
409409

410410
/**
411-
* {@inheritdoc IExtractorTsdocMetadataConfig}
411+
* {@inheritDoc IExtractorTsdocMetadataConfig}
412412
* @beta
413413
*/
414414
tsdocMetadata?: IExtractorTsdocMetadataConfig;
415415

416416
/**
417-
* {@inheritdoc IExtractorMessagesConfig}
417+
* {@inheritDoc IExtractorMessagesConfig}
418418
*/
419419
messages?: IExtractorMessagesConfig;
420420

‎apps/api-extractor/src/collector/WorkingPackage.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export class WorkingPackage {
5757
public readonly entryPointSourceFile: ts.SourceFile;
5858

5959
/**
60-
* The `@packagedocumentation` comment, if any, for the working package.
60+
* The `@packageDocumentation` comment, if any, for the working package.
6161
*/
6262
public tsdocComment: tsdoc.DocComment | undefined;
6363

‎apps/api-extractor/src/generators/DtsRollupGenerator.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ export class DtsRollupGenerator {
174174
let recurseChildren: boolean = true;
175175
switch (span.kind) {
176176
case ts.SyntaxKind.JSDocComment:
177-
// If the @packagedocumentation comment seems to be attached to one of the regular API items,
177+
// If the @packageDocumentation comment seems to be attached to one of the regular API items,
178178
// omit it. It gets explictly emitted at the top of the file.
179-
if (span.node.getText().match(/(?:\s|\*)@packagedocumentation(?:\s|\*)/g)) {
179+
if (span.node.getText().match(/(?:\s|\*)@packageDocumentation(?:\s|\*)/gi)) {
180180
span.modification.skipAll();
181181
}
182182

‎apps/api-extractor/src/generators/ReviewFileGenerator.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ export class ReviewFileGenerator {
261261
}
262262

263263
if (declarationMetadata.isEventProperty) {
264-
footerParts.push('@eventproperty');
264+
footerParts.push('@eventProperty');
265265
}
266266

267267
if (declarationMetadata.tsdocComment) {

‎apps/api-extractor/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* It helps with validation, documentation, and reviewing of the exported API
77
* for a TypeScript library.
88
*
9-
* @packagedocumentation
9+
* @packageDocumentation
1010
*/
1111

1212
export { ReleaseTag } from './aedoc/ReleaseTag';

‎apps/rush-lib/src/api/RushConfiguration.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -751,14 +751,14 @@ export class RushConfiguration {
751751
}
752752

753753
/**
754-
* {@inheritdoc PnpmOptionsConfiguration}
754+
* {@inheritDoc PnpmOptionsConfiguration}
755755
*/
756756
public get pnpmOptions(): PnpmOptionsConfiguration {
757757
return this._pnpmOptions;
758758
}
759759

760760
/**
761-
* {@inheritdoc YarnOptionsConfiguration}
761+
* {@inheritDoc YarnOptionsConfiguration}
762762
*/
763763
public get yarnOptions(): YarnOptionsConfiguration {
764764
return this._yarnOptions;

‎apps/rush-lib/src/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
/**
55
* A library for writing scripts that interact with the Rush tool.
6-
* @packagedocumentation
6+
* @packageDocumentation
77
*/
88

99
export {

‎apps/rush-lib/src/logic/taskRunner/TaskRunner.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,6 @@ export class TaskRunner {
108108
* Defines the list of dependencies for an individual task.
109109
* @param taskName - the string name of the task for which we are defining dependencies. A task with this
110110
* name must already have been registered.
111-
* @taskDependencies
112111
*/
113112
public addDependencies(taskName: string, taskDependencies: string[]): void {
114113
const task: ITask | undefined = this._tasks.get(taskName);

0 commit comments

Comments
 (0)