Add the @internal annotation to all internal classes

tomphp commented 8 years ago

Changes to things marked as @internal will not be treated as BC breaks.

[x] Mark Configurator as @api as it's the main API
[x] Mark FileReader interface as @api as external file readers could be defined (see #73)
[x] Mark ContainerAdapter interface as @api as external adapters could be defined (see #74)
[x] Should exceptions be marked as @api or just not marked; they could be caught explicitly externally or be thrown by custom FileReaders or ContainerAdapters?
[x] Mark everything else as @internal

localheinz commented 8 years ago

About the unchecked box, I think as long as we throw these exceptions within this package, but do not handle them internally, they are part of the API, aren't they?

What do you think, @tomphp?

tomphp commented 8 years ago

@localheinz agreed

tomphp commented 8 years ago

@localheinz I tagged the exceptions - probably worth reviewing quickly before merging.

localheinz commented 7 years ago

Ha, got a conflict, @tomphp, feel free to merge once resolved!

tomphp / container-configurator

Add the @internal annotation to all internal classes #75