Adding API documentation to the C++ Array and Binding classes.

Adding API documentation to the C++ Array and Binding classes.

R=yzshen@chromium.org

Committed: https://chromium.googlesource.com/external/mojo/+/a200ffc830f61a73a09d3bce34c53165d72885c3

[ggowan, 2015-01-20 21:28:03]

ggowan@google.com changed reviewers:
+ darin@chromium.org

[ggowan, 2015-01-20 21:29:45]

ggowan@google.com changed reviewers:
+ yzshen@chromium.org

[yzshen1, 2015-01-20 22:45:49]

Great comments!

Only a few nits. Thanks!

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
File mojo/public/cpp/bindings/array.h (right):

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
mojo/public/cpp/bindings/array.h:39: // Constructs a new non-null array of the
specified size.
nit: it might be nice to also mention the initialization of elements.

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
mojo/public/cpp/bindings/array.h:94: // Pushes a copy of |value| onto the back
of the array. If this array was
Strictly speaking, "a copy of" is inaccurate when |value| is move-only.

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
mojo/public/cpp/bindings/array.h:101: // Resizes the array to |size| and makes
it non-null.
It is nice to mention initialization of those newly-added elements.

[ggowan, 2015-01-20 23:54:51]

Thanks, Yuzhu! PTAL

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
File mojo/public/cpp/bindings/array.h (right):

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
mojo/public/cpp/bindings/array.h:39: // Constructs a new non-null array of the
specified size.
On 2015/01/20 22:45:49, yzshen1 wrote:
> nit: it might be nice to also mention the initialization of elements.

Done.

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
mojo/public/cpp/bindings/array.h:94: // Pushes a copy of |value| onto the back
of the array. If this array was
On 2015/01/20 22:45:49, yzshen1 wrote:
> Strictly speaking, "a copy of" is inaccurate when |value| is move-only.

True. I deleted "a copy of" since it was unnecessary anyway.

https://codereview.chromium.org/792543005/diff/1/mojo/public/cpp/bindings/arr...
mojo/public/cpp/bindings/array.h:101: // Resizes the array to |size| and makes
it non-null.
On 2015/01/20 22:45:49, yzshen1 wrote:
> It is nice to mention initialization of those newly-added elements.

I specified it by reference to std::vector, since that's well known and
otherwise it would result in a somewhat lengthy comment to say the same thing.

[yzshen1, 2015-01-21 17:30:40]

https://codereview.chromium.org/792543005/diff/20001/mojo/public/cpp/bindings...
File mojo/public/cpp/bindings/array.h (right):

https://codereview.chromium.org/792543005/diff/20001/mojo/public/cpp/bindings...
mojo/public/cpp/bindings/array.h:41: // to initialize each new element.
Otherwise, the value of the new elements is
I thought they will be value initialized?
For example, int will be zero-initialized?

https://codereview.chromium.org/792543005/diff/20001/mojo/public/cpp/bindings...
mojo/public/cpp/bindings/array.h:58: // undefined and they should be initialized
by the caller.
ditto.

[ggowan, 2015-01-21 18:56:20]

Thanks for the catch, Yuzhu! Sorry about that. Please take another look.

https://codereview.chromium.org/792543005/diff/20001/mojo/public/cpp/bindings...
File mojo/public/cpp/bindings/array.h (right):

https://codereview.chromium.org/792543005/diff/20001/mojo/public/cpp/bindings...
mojo/public/cpp/bindings/array.h:41: // to initialize each new element.
Otherwise, the value of the new elements is
On 2015/01/21 17:30:40, yzshen1 wrote:
> I thought they will be value initialized?
> For example, int will be zero-initialized?

Thanks, my mistake.

https://codereview.chromium.org/792543005/diff/20001/mojo/public/cpp/bindings...
mojo/public/cpp/bindings/array.h:58: // undefined and they should be initialized
by the caller.
On 2015/01/21 17:30:40, yzshen1 wrote:
> ditto.

Done.

[yzshen1, 2015-01-21 19:14:05]

Thanks!

LGTM

[ggowan, 2015-01-21 22:03:40]

ggowan@google.com changed reviewers:
- darin@chromium.org

[yzshen1, 2015-01-21 22:42:43]

Committed patchset #3 (id:40001) manually as
0ccff94b79e38095b617db8ebdb18ae1db8708ce (presubmit successful).

[ggowan, 2015-01-22 18:55:30]

Committed patchset #3 (id:40001) manually as
a200ffc830f61a73a09d3bce34c53165d72885c3 (presubmit successful).