You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mesos.apache.org by Tobi Knaup <to...@knaup.me> on 2014/04/01 01:54:37 UTC

Review Request 19859: Improve javadoc (use @param, @return, etc)

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/
-----------------------------------------------------------

Review request for mesos.


Bugs: MESOS-135
    https://issues.apache.org/jira/browse/MESOS-135


Repository: mesos-git


Description
-------

See summary.
There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.


Diffs
-----

  src/java/src/org/apache/mesos/Executor.java 8f4eaee 
  src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
  src/java/src/org/apache/mesos/Scheduler.java 55c4706 
  src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
  src/java/src/org/apache/mesos/state/State.java dccb0ff 
  src/java/src/org/apache/mesos/state/Variable.java bedb74b 
  src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 

Diff: https://reviews.apache.org/r/19859/diff/


Testing
-------


Thanks,

Tobi Knaup

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by Tobi Knaup <to...@knaup.me>.

> On April 1, 2014, 2:25 a.m., John Sirois wrote:
> > src/java/src/org/apache/mesos/ExecutorDriver.java, line 36
> > <https://reviews.apache.org/r/19859/diff/1/?file=543109#file543109line36>
> >
> >     Drive by review - you already get return type linking so @see Status either seems redundant or its placing extra emphasis on the return type - kill throughout?

I successfully copied an anti-pattern. Killed!


- Tobi


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/#review39124
-----------------------------------------------------------


On April 1, 2014, 2:33 a.m., Tobi Knaup wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/19859/
> -----------------------------------------------------------
> 
> (Updated April 1, 2014, 2:33 a.m.)
> 
> 
> Review request for mesos.
> 
> 
> Bugs: MESOS-135
>     https://issues.apache.org/jira/browse/MESOS-135
> 
> 
> Repository: mesos-git
> 
> 
> Description
> -------
> 
> See summary.
> There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.
> 
> 
> Diffs
> -----
> 
>   src/java/src/org/apache/mesos/Executor.java 8f4eaee 
>   src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
>   src/java/src/org/apache/mesos/Scheduler.java 55c4706 
>   src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
>   src/java/src/org/apache/mesos/state/State.java dccb0ff 
>   src/java/src/org/apache/mesos/state/Variable.java bedb74b 
>   src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 
> 
> Diff: https://reviews.apache.org/r/19859/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tobi Knaup
> 
>

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by John Sirois <jo...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/#review39124
-----------------------------------------------------------


Yay docs! Thanks for polishing this up.


src/java/src/org/apache/mesos/ExecutorDriver.java
<https://reviews.apache.org/r/19859/#comment71511>

    Drive by review - you already get return type linking so @see Status either seems redundant or its placing extra emphasis on the return type - kill throughout?


- John Sirois


On March 31, 2014, 5:54 p.m., Tobi Knaup wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/19859/
> -----------------------------------------------------------
> 
> (Updated March 31, 2014, 5:54 p.m.)
> 
> 
> Review request for mesos.
> 
> 
> Bugs: MESOS-135
>     https://issues.apache.org/jira/browse/MESOS-135
> 
> 
> Repository: mesos-git
> 
> 
> Description
> -------
> 
> See summary.
> There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.
> 
> 
> Diffs
> -----
> 
>   src/java/src/org/apache/mesos/Executor.java 8f4eaee 
>   src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
>   src/java/src/org/apache/mesos/Scheduler.java 55c4706 
>   src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
>   src/java/src/org/apache/mesos/state/State.java dccb0ff 
>   src/java/src/org/apache/mesos/state/Variable.java bedb74b 
>   src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 
> 
> Diff: https://reviews.apache.org/r/19859/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tobi Knaup
> 
>

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by Tobi Knaup <to...@knaup.me>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/
-----------------------------------------------------------

(Updated April 2, 2014, 4:53 a.m.)


Review request for mesos.


Changes
-------

Implement John and Vinod's feedback. Thanks!


Bugs: MESOS-135
    https://issues.apache.org/jira/browse/MESOS-135


Repository: mesos-git


Description
-------

See summary.
There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.


Diffs (updated)
-----

  src/java/src/org/apache/mesos/Executor.java 8f4eaee 
  src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
  src/java/src/org/apache/mesos/Scheduler.java 55c4706 
  src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
  src/java/src/org/apache/mesos/state/State.java dccb0ff 
  src/java/src/org/apache/mesos/state/Variable.java bedb74b 
  src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 

Diff: https://reviews.apache.org/r/19859/diff/


Testing
-------


Thanks,

Tobi Knaup

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by Mesos ReviewBot <de...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/#review39126
-----------------------------------------------------------


Patch looks great!

Reviews applied: [19859]

All tests passed.

- Mesos ReviewBot


On April 1, 2014, 2:33 a.m., Tobi Knaup wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/19859/
> -----------------------------------------------------------
> 
> (Updated April 1, 2014, 2:33 a.m.)
> 
> 
> Review request for mesos.
> 
> 
> Bugs: MESOS-135
>     https://issues.apache.org/jira/browse/MESOS-135
> 
> 
> Repository: mesos-git
> 
> 
> Description
> -------
> 
> See summary.
> There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.
> 
> 
> Diffs
> -----
> 
>   src/java/src/org/apache/mesos/Executor.java 8f4eaee 
>   src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
>   src/java/src/org/apache/mesos/Scheduler.java 55c4706 
>   src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
>   src/java/src/org/apache/mesos/state/State.java dccb0ff 
>   src/java/src/org/apache/mesos/state/Variable.java bedb74b 
>   src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 
> 
> Diff: https://reviews.apache.org/r/19859/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tobi Knaup
> 
>

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by John Sirois <jo...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/#review39128
-----------------------------------------------------------

Ship it!


I have no power here, but this lgtm.

The final consideration would be precedent.  From the last file in the diff, thats as so:
* @param credentials Authentication credentials (e.g., "user:pass").

ie: no ascii art alignment, just * @param [name] [Sentence style description (init cap, period end)].

I had a hard time with the . idea on @param when 1st presenter it but the explanation I was given is it proves you finished your thought.  I'm ambivalent to a degree since @param are rarely real sentences.
Consistency here might top the balance.


- John Sirois


On March 31, 2014, 8:33 p.m., Tobi Knaup wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/19859/
> -----------------------------------------------------------
> 
> (Updated March 31, 2014, 8:33 p.m.)
> 
> 
> Review request for mesos.
> 
> 
> Bugs: MESOS-135
>     https://issues.apache.org/jira/browse/MESOS-135
> 
> 
> Repository: mesos-git
> 
> 
> Description
> -------
> 
> See summary.
> There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.
> 
> 
> Diffs
> -----
> 
>   src/java/src/org/apache/mesos/Executor.java 8f4eaee 
>   src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
>   src/java/src/org/apache/mesos/Scheduler.java 55c4706 
>   src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
>   src/java/src/org/apache/mesos/state/State.java dccb0ff 
>   src/java/src/org/apache/mesos/state/Variable.java bedb74b 
>   src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 
> 
> Diff: https://reviews.apache.org/r/19859/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tobi Knaup
> 
>

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by Vinod Kone <vi...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/#review39127
-----------------------------------------------------------

Ship it!


i'll commit this once the comment is addressed. 


src/java/src/org/apache/mesos/Scheduler.java
<https://reviews.apache.org/r/19859/#comment71513>

    s/the scheduler driver/the driver/
    
    
    here and everywhere else.



src/java/src/org/apache/mesos/state/ZooKeeperState.java
<https://reviews.apache.org/r/19859/#comment71514>

    thank you.


- Vinod Kone


On April 1, 2014, 2:33 a.m., Tobi Knaup wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/19859/
> -----------------------------------------------------------
> 
> (Updated April 1, 2014, 2:33 a.m.)
> 
> 
> Review request for mesos.
> 
> 
> Bugs: MESOS-135
>     https://issues.apache.org/jira/browse/MESOS-135
> 
> 
> Repository: mesos-git
> 
> 
> Description
> -------
> 
> See summary.
> There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.
> 
> 
> Diffs
> -----
> 
>   src/java/src/org/apache/mesos/Executor.java 8f4eaee 
>   src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
>   src/java/src/org/apache/mesos/Scheduler.java 55c4706 
>   src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
>   src/java/src/org/apache/mesos/state/State.java dccb0ff 
>   src/java/src/org/apache/mesos/state/Variable.java bedb74b 
>   src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 
> 
> Diff: https://reviews.apache.org/r/19859/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Tobi Knaup
> 
>

Re: Review Request 19859: Improve javadoc (use @param, @return, etc)

Posted by Tobi Knaup <to...@knaup.me>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/19859/
-----------------------------------------------------------

(Updated April 1, 2014, 2:33 a.m.)


Review request for mesos.


Changes
-------

Remove redundant @see


Bugs: MESOS-135
    https://issues.apache.org/jira/browse/MESOS-135


Repository: mesos-git


Description
-------

See summary.
There is a separate change in MESOS-570 to publish the docs on mesos.apache.org.


Diffs (updated)
-----

  src/java/src/org/apache/mesos/Executor.java 8f4eaee 
  src/java/src/org/apache/mesos/ExecutorDriver.java cb14f38 
  src/java/src/org/apache/mesos/Scheduler.java 55c4706 
  src/java/src/org/apache/mesos/SchedulerDriver.java 6bca879 
  src/java/src/org/apache/mesos/state/State.java dccb0ff 
  src/java/src/org/apache/mesos/state/Variable.java bedb74b 
  src/java/src/org/apache/mesos/state/ZooKeeperState.java f3d939f 

Diff: https://reviews.apache.org/r/19859/diff/


Testing
-------


Thanks,

Tobi Knaup