-
Notifications
You must be signed in to change notification settings - Fork 246
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(jsii-diff): standardize doc comments, add API compatibility tool (…
…#415) Add parsing semantics for various common capabilities to doc comments (summary, remarks, stability and others). Add a tool uses stability annotations in the doc comments to check whether two JSII assemblies are API-compatible.
- Loading branch information
Showing
178 changed files
with
14,801 additions
and
8,145 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| /** | ||
| * Here's the first line of the TSDoc comment. | ||
| * | ||
| * This is the meat of the TSDoc comment. It may contain | ||
| * multiple lines and multiple paragraphs. | ||
| * | ||
| * Multiple paragraphs are separated by an empty line. | ||
| * | ||
| * @stable | ||
| */ | ||
| export class DocumentedClass { | ||
|
|
||
| /** | ||
| * Greet the indicated person. | ||
| * | ||
| * This will print out a friendly greeting intended for | ||
| * the indicated person. | ||
| * | ||
| * @param greetee The person to be greeted. | ||
| * @returns A number that everyone knows very well | ||
| */ | ||
| public greet(greetee: Greetee = {}) { | ||
| process.stdout.write(`Hello, ${greetee.name || 'world'}\n`); | ||
| return 42; | ||
| } | ||
|
|
||
| /** | ||
| * Say ¡Hola! | ||
| * | ||
| * @experimental | ||
| */ | ||
| public hola() { | ||
| process.stdout.write('bonjour'); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * These are some arguments you can pass to a method. | ||
| */ | ||
| export interface Greetee { | ||
| /** | ||
| * The name of the greetee | ||
| * | ||
| * @default world | ||
| */ | ||
| readonly name?: string; | ||
| } | ||
|
|
||
| /** | ||
| * Old class | ||
| * | ||
| * @deprecated Use the new class | ||
| */ | ||
| export class Old { | ||
| /** | ||
| * Doo wop that thing | ||
| */ | ||
| public doAThing() { | ||
| // Nothing to do | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| export * from './calculator'; | ||
| export * from './compliance'; | ||
| export * from './documented'; |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.