Revision - 76c955f - docs(forms): exclude internal-only methods and properties from [...] - origin: https://github.com/angular/angular

visit type:

https://github.com/angular/angular

01 September 2024, 02:13:37 UTC

Revision 76c955fe50d4a5184e8d2cc532980b3bb306ee90 authored by Andrew Kushnir on 25 August 2020, 23:17:57 UTC, committed by Joey Perrott on 27 August 2020, 23:39:40 UTC

docs(forms): exclude internal-only methods and properties from docs (#38583)

Prior to this commit, a lot of internal-only class properties and methods (such as `ngOnChanges`)
of the Forms package directives were exposed on angular.io website. These fields are not expected
to be called externally (they are used/invoked by framework only), since they are part of internal
implementations of the following interfaces:

* Angular lifecycle hook interfaces
* ControlValueAccessor interface
* Validator interface

Having these internal-only fields in docs creates unnecessary noise on directive detail pages.
This commit adds the `@nodoc` annotation to these properties and methods to keep fields in the
golden files, but hide them in docs.

PR Close #38583

1 parent e3a71ae

Files
Changes

Permalinks

Tip revision: 76c955fe50d4a5184e8d2cc532980b3bb306ee90 authored by Andrew Kushnir on 25 August 2020, 23:17:57 UTC
docs(forms): exclude internal-only methods and properties from docs (#38583)

Tip revision: 76c955f

File	Mode	Size
.circleci
.devcontainer
.github
.ng-dev
.vscode
.yarn
aio
dev-infra
docs
goldens
integration
modules
packages
scripts
third_party
tools
.bazelignore	-rw-r--r--	4.3 KB
.bazelrc	-rw-r--r--	6.2 KB
.bazelversion	-rw-r--r--	213 bytes
.clang-format	-rw-r--r--	73 bytes
.editorconfig	-rw-r--r--	245 bytes
.gitattributes	-rw-r--r--	314 bytes
.gitignore	-rw-r--r--	726 bytes
.gitmessage	-rw-r--r--	7.2 KB
.mailmap	-rw-r--r--	51 bytes
.nvmrc	-rw-r--r--	8 bytes
.pullapprove.yml	-rw-r--r--	44.1 KB
.yarnrc	-rw-r--r--	128 bytes
BUILD.bazel	-rw-r--r--	1.7 KB
CHANGELOG.md	-rw-r--r--	726.2 KB
CODE_OF_CONDUCT.md	-rw-r--r--	1.1 KB
CONTRIBUTING.md	-rw-r--r--	14.2 KB
LICENSE	-rw-r--r--	1.1 KB
README.md	-rw-r--r--	1.2 KB
WORKSPACE	-rw-r--r--	4.3 KB
browser-providers.conf.js	-rw-r--r--	9.1 KB
gulpfile.js	-rw-r--r--	1.2 KB
karma-js.conf.js	-rw-r--r--	7.6 KB
package.json	-rw-r--r--	8.5 KB
test-events.js	-rw-r--r--	259 bytes
test-main.js	-rw-r--r--	11.3 KB
tslint.json	-rw-r--r--	2.3 KB
yarn.lock	-rw-r--r--	678.8 KB
yarn.lock.readme.md	-rw-r--r--	1.3 KB

Showing with 0 additions and 0 deletions (0 / 0 diffs computed)

Computing file changes ...

https://github.com/angular/angular

docs(forms): exclude internal-only methods and properties from docs (#38583)

README.md