Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for container (getOwner, etc.) #13819

Merged
merged 2 commits into from
Jul 23, 2016

Conversation

sukima
Copy link
Contributor

@sukima sukima commented Jul 14, 2016

Per the discussion on #13734 I added the since parameter and reordered to match other files. I searched the history to find the version number when this was introduced:

$ git log --stat -- packages/container/lib/owner.js
$ git tag --contains 7d7450c99bbcec8e51b4adb184a147633603683e

Fixes #13734

Per the discussion on emberjs#13734 I added the since parameter and reordered
to match other files. I searched the history to find the version number
when this was introduced:

    git log --stat -- packages/container/lib/owner.js
    git tag --contains 7d7450c

Fixes emberjs#13734
@sukima sukima changed the title Add since param to getOwner docs Add documentation for container (getOwner, etc.) Jul 14, 2016
@rwjblue
Copy link
Member

rwjblue commented Jul 14, 2016

We need to audit the documentation now to ensure nothing else in packages/container is listed as @public. Before adding it to the yuidoc.json it didn't matter (since nothing was used in the API docs), but now we need to ensure/double check. Thankfully, there are very few files so it should be easy to review.

@sukima
Copy link
Contributor Author

sukima commented Jul 14, 2016

Audit

Identify all methods and classes in the container package and determine their public/private status.

container.js

Identifier Type Scope Audit Notes
Container class private Exposed by index.js
owner property private
registry property private
cache property private
factoryCache property private
validationCache property private
lookup method private
lookupFactory method private
destroy method private
reset method private
ownerInjection method private

index.js

Identifier Type Scope Audit Notes
container module private Documentation claims public API while YUIDocs claims private

owner.js

Identifier Type Scope Audit Notes
getOwner method public
setOwner method public

registry.js

Identifier Type Scope Audit Notes
Registry class private Exposed by index.js
fallback property private
resolver property private
registrations property private
_typeInjections property private
_injections property private
_factoryTypeInjections property private
_factoryInjections property private
_normalizeCache property private
_resolveCache property private
_options property private
_typeOptions property private
container method private
register method private
unregister method private
resolve method private
describe method private
normalizeFullName method private
normalize method private
makeToString method private
has method private
optionsForType method private
options method private
typeInjection method private
injection method private
factoryTypeInjection method private
factoryInjection method private
knownForType method private
expandLocalLookup method private

@rwjblue
Copy link
Member

rwjblue commented Jul 23, 2016

OK, awesome, thank you @sukima for double checking all of these files!

@rwjblue rwjblue merged commit 9746425 into emberjs:master Jul 23, 2016
@sukima sukima deleted the issue-13734 branch July 23, 2016 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants