[guice] Add missing @since tags for classes (#916)

[Ben McCann]

You can view, comment on, or merge this pull request online at:

https://github.com/google/guice/pull/916

-- Commit Summary --

* Add missing @since tags for classes

-- File Changes --

M core/src/com/google/inject/spi/DependencyAndSource.java (1)
M core/src/com/google/inject/spi/ElementSource.java (2)
M core/src/com/google/inject/spi/ModuleAnnotatedMethodScanner.java (2)
M core/src/com/google/inject/spi/ProvisionListener.java (6)
M extensions/grapher/src/com/google/inject/grapher/AbstractInjectorGrapher.java (6)
M extensions/grapher/src/com/google/inject/grapher/Alias.java (1)
M extensions/grapher/src/com/google/inject/grapher/AliasCreator.java (1)
M extensions/grapher/src/com/google/inject/grapher/BindingEdge.java (1)
M extensions/grapher/src/com/google/inject/grapher/DefaultRootKeySetCreator.java (1)
M extensions/grapher/src/com/google/inject/grapher/DependencyEdge.java (1)
M extensions/grapher/src/com/google/inject/grapher/Edge.java (1)
M extensions/grapher/src/com/google/inject/grapher/EdgeCreator.java (1)
M extensions/grapher/src/com/google/inject/grapher/ImplementationNode.java (1)
M extensions/grapher/src/com/google/inject/grapher/InstanceNode.java (1)
M extensions/grapher/src/com/google/inject/grapher/InterfaceNode.java (1)
M extensions/grapher/src/com/google/inject/grapher/Node.java (1)
M extensions/grapher/src/com/google/inject/grapher/NodeCreator.java (1)
M extensions/grapher/src/com/google/inject/grapher/NodeId.java (6)
M extensions/grapher/src/com/google/inject/grapher/RootKeySetCreator.java (1)
M extensions/grapher/src/com/google/inject/grapher/graphviz/GraphvizGrapher.java (1)
M extensions/multibindings/src/com/google/inject/multibindings/ClassMapKey.java (2)
M extensions/multibindings/src/com/google/inject/multibindings/MapKey.java (2)
M extensions/multibindings/src/com/google/inject/multibindings/MultibindingsScanner.java (2)
M extensions/multibindings/src/com/google/inject/multibindings/OptionalBinder.java (1)
M extensions/multibindings/src/com/google/inject/multibindings/ProvidesIntoOptional.java (3)
M extensions/multibindings/src/com/google/inject/multibindings/StringMapKey.java (1)
M extensions/servlet/src/com/google/inject/servlet/ScopingException.java (1)
M extensions/servlet/src/com/google/inject/servlet/ScopingOnly.java (1)
M extensions/throwingproviders/src/com/google/inject/throwingproviders/ThrowingInject.java (1)

-- Patch Links --

https://github.com/google/guice/pull/916.patch
https://github.com/google/guice/pull/916.diff

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916

[Sam Berlin]

@@ -50,6 +50,9 @@
@Target(METHOD)
@Retention(RUNTIME)
+ /**

This should be on the top-level type instead I think?

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28832321

[Sam Berlin]

@@ -50,6 +50,9 @@
@Target(METHOD)
@Retention(RUNTIME)
+ /**

Oh nevermind it's already there -- we can kill this one I think since it's an inner class on a brand new type.

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28832462

[Sam Berlin]

@@ -49,7 +49,11 @@
*/
<T> void onProvision(ProvisionInvocation<T> provision);
- /** Encapsulates a single act of provisioning.*/
+ /**
+ * Encapsulates a single act of provisioning.
+ *

can rm this too since it's in a newly introduced class.

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28832493

[Sam Berlin]

@@ -39,7 +40,10 @@
private final NodeCreator nodeCreator;
private final EdgeCreator edgeCreator;
- /** Parameters used to override default settings of the grapher. */
+ /**
+ * Parameters used to override default settings of the grapher.

and this.

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28832506

[Sam Berlin]

Thanks Ben! Will merge after rm'ing the inner class `@`sinces. Any chance you'll send a followup with missing `@`sinces in methods? :-)

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#issuecomment-94973179

[Ben McCann]

@@ -50,6 +50,9 @@
@Target(METHOD)
@Retention(RUNTIME)
+ /**

The reason I added them was because they're included in the report that `ant jdiff` spits out. I can remove them from the inner classes if you don't mind the report not having a clean output

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28832609

[Sam Berlin]

@@ -50,6 +50,9 @@
@Target(METHOD)
@Retention(RUNTIME)
+ /**

Ahh, hmm. If jdiff wants it, I guess it's no big deal to keep them.

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28832690

[Sam Berlin]

Will merge once travis gives the green light (don't see any reason it wouldn't... but stranger things have happened).

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#issuecomment-94973948

[James Roper]

Travis has been behaving very oddly on my projects today... don't get your hopes up :)

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#issuecomment-94983947

[Ben McCann]

@@ -22,6 +22,7 @@
* Edge that connects an interface to the type or instance that is bound to implement it.
*
*/
public class BindingEdge extends Edge {

@sameb looks like this class was in 3.0, but was previously parameterized. i'll remove the since tag on it if that makes sense to you

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28838996

[Sam Berlin]

@@ -22,6 +22,7 @@
* Edge that connects an interface to the type or instance that is bound to implement it.
*
*/
public class BindingEdge extends Edge {

removing SGTM

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916/files#r28839215

[Ben McCann]

I double checked all the places I added a since tag against the 3.0 javadoc. I ended up removing a few of them: BindingEdge, DependencyEdge, ImplementationNode, and InterfaceNode were in 3.0, but were previously paramaterized. I guess removing the type parameter made them show up in jdiff. I'm not sure what the deal was with the ElementVisitor ones. jdiff bug I guess. Everything else looked legit.

I think we should be good now as soon as Travis successfully completes

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#issuecomment-94997595

[Sam Berlin]

Thanks again Ben.

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#issuecomment-94999286

[Ben McCann]

Hmm. Travis has been running for a few hours and still hasn't returned...

@sameb no problem. happy to help!

btw, jroper and I are both maintainers for Play Framework and we have a big release coming up where one of the main highlights is better support for Guice and DI. hoping to get guice 4 in if we can. you think it might be released in the next week or two?

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#issuecomment-95030681

[Sam Berlin]

Merged #916.

---
Reply to this email directly or view it on GitHub:
https://github.com/google/guice/pull/916#event-287141341