refactor: correct @publicApi and @codeGenApi markers in various files (#38224)

The markers were previously incorrectly assigned. I noticed the issues when reviewing
the golden files and this change corrects them.

PR Close #38224
This commit is contained in:
Igor Minar 2020-07-24 09:39:54 -07:00 committed by Misko Hevery
parent 96aa14df01
commit 8f7d89436f
3 changed files with 13 additions and 11 deletions

View File

@ -109,6 +109,7 @@ export function injectInjectorOnly<T>(
*
* @see inject
* @codeGenApi
* @publicApi This instruction has been emitted by ViewEngine for some time and is deployed to npm.
*/
export function ɵɵinject<T>(token: Type<T>|InjectionToken<T>): T;
export function ɵɵinject<T>(token: Type<T>|InjectionToken<T>, flags?: InjectFlags): T|null;

View File

@ -22,9 +22,9 @@ import {ClassProvider, ConstructorProvider, ExistingProvider, FactoryProvider, S
* `InjectorDef`, `NgModule`, or a special scope (e.g. `'root'`). A value of `null` indicates
* that the injectable does not belong to any scope.
*
* NOTE: This is a private type and should not be exported
*
* @publicApi
* @codeGenApi
* @publicApi This instruction has been emitted by ViewEngine for some time and is deployed to npm.
*/
export interface ɵɵInjectableDef<T> {
/**
@ -65,7 +65,7 @@ export interface ɵɵInjectableDef<T> {
*
* NOTE: This is a private type and should not be exported
*
* @publicApi
* @codeGenApi
*/
export interface ɵɵInjectorDef<T> {
factory: () => T;
@ -137,6 +137,7 @@ export interface InjectorTypeWithProviders<T> {
* The factory can call `inject` to access the `Injector` and request injection of dependencies.
*
* @codeGenApi
* @publicApi This instruction has been emitted by ViewEngine for some time and is deployed to npm.
*/
export function ɵɵdefineInjectable<T>(opts: {
token: unknown,
@ -175,7 +176,7 @@ export const defineInjectable = ɵɵdefineInjectable;
* whose providers will also be added to the injector. Locally provided types will override
* providers from imports.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵdefineInjector(options: {factory: () => any, providers?: any[], imports?: any[]}):
never {

View File

@ -32,7 +32,7 @@ import {_sanitizeUrl as _sanitizeUrl} from './url_sanitizer';
* @returns `html` string which is safe to display to user, because all of the dangerous javascript
* and urls have been removed.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵsanitizeHtml(unsafeHtml: any): string {
const sanitizer = getSanitizer();
@ -54,7 +54,7 @@ export function ɵɵsanitizeHtml(unsafeHtml: any): string {
* @param unsafeStyle untrusted `style`, typically from the user.
* @returns `style` string which is safe to bind to the `style` properties.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵsanitizeStyle(unsafeStyle: any): string {
const sanitizer = getSanitizer();
@ -81,7 +81,7 @@ export function ɵɵsanitizeStyle(unsafeStyle: any): string {
* @returns `url` string which is safe to bind to the `src` properties such as `<img src>`, because
* all of the dangerous javascript has been removed.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵsanitizeUrl(unsafeUrl: any): string {
const sanitizer = getSanitizer();
@ -103,7 +103,7 @@ export function ɵɵsanitizeUrl(unsafeUrl: any): string {
* @returns `url` string which is safe to bind to the `src` properties such as `<img src>`, because
* only trusted `url`s have been allowed to pass.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵsanitizeResourceUrl(unsafeResourceUrl: any): string {
const sanitizer = getSanitizer();
@ -126,7 +126,7 @@ export function ɵɵsanitizeResourceUrl(unsafeResourceUrl: any): string {
* @returns `url` string which is safe to bind to the `<script>` element such as `<img src>`,
* because only trusted `scripts` have been allowed to pass.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵsanitizeScript(unsafeScript: any): string {
const sanitizer = getSanitizer();
@ -169,7 +169,7 @@ export function getUrlSanitizer(tag: string, prop: string) {
* @param prop name of the property that contains the value.
* @returns `url` string which is safe to bind.
*
* @publicApi
* @codeGenApi
*/
export function ɵɵsanitizeUrlOrResourceUrl(unsafeUrl: any, tag: string, prop: string): any {
return getUrlSanitizer(tag, prop)(unsafeUrl);