Skip to content

The ClassLoader component doc documents only the deprecated class #2834

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

Closed
stof opened this issue Jul 19, 2013 · 5 comments
Closed

The ClassLoader component doc documents only the deprecated class #2834

stof opened this issue Jul 19, 2013 · 5 comments
Labels
actionable Clear and specific issues ready for anyone to take them.
Milestone

Comments

@stof
Copy link
Member

stof commented Jul 19, 2013

The only class documented in the component doc is UniversalClassLoader, which is deprecated as of 2.1 in favor of the ClassLoader one (or composer).

None of the 2.1+ classes (the ClassLoader being similar to the Composer autoloader and able to be configured from a composer-generated namespace map, and the different decorating cached loaders able to wrap both class loaders) are documented while they should be the one used.
Thus, documenting the cached loaders could be useful as this is where the component provides some additional value compared to the composer class loader.

@xabbuh
Copy link
Member

xabbuh commented Jul 23, 2013

Does it make sense to throw away the documentation on the UniversalClassLoader and only reuse some of it for the ClassLoader?

I would go for documenting the base class loaders in their dedicated articles which I guess are ClassLoader, ClassCollectionLoader and MapClassLoader.

We can then add articles for each of the class loader wrappers: ApcClassLoader, DebugClassLoader and XcacheClassLoader.

Any opinions on this?

@stof
Copy link
Member Author

stof commented Jul 23, 2013

As it is deprecated, I think it definitely make sense to avoid documenting it. The ClassLoader should be preferred

@wouterj
Copy link
Member

wouterj commented Jul 25, 2013

+1 do you start writing this, @xabbuh ? Otherwise I'll do it after my holiday.

@xabbuh
Copy link
Member

xabbuh commented Jul 25, 2013

I do. I think I can publish it to the end of the week for feedback.

@xabbuh
Copy link
Member

xabbuh commented Aug 19, 2013

At last, it took me longer than I expected. I'd appreciate any feedback on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actionable Clear and specific issues ready for anyone to take them.
Projects
None yet
Development

No branches or pull requests

4 participants