Adding static documentation to the speech input extension API.

Adding static documentation to the speech input extension API.


BUG=97388
TEST=none

Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=110709

[Satish, 2011-11-11 22:17:54]

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:6: one-shot
speech recognition to Chrome extensions. It provides exclusive
The 'It provides exclusive' statement is duplicated below as well. Perhaps
remove it here?

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:28: This will
asynchronously request to start a new session for speech recognition.
This line seems unnecessary since you talk about the callback below

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:29: If
provided, <code>callback</code> will be called once the actual recording has
remove 'the actual'

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:30:
successfully started. A microphone tray icon will appear on the task bar during
We probably shouldn't talk about the UI here, just how to use the API?

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:31: all the
recognition session. In case of error during the start the call will
remove 'during the start the call will fail and '

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:35: extension
requesting it. Consequently, any calls to start when the device is
start -> "<code>start</code>"

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:36: being
used by anything else than the current extension will fail and set
'anything else than the current extension' -> 'another extension or web page'

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:42: <p>To
check if recording is currently in use call the <code>isRecording</code>
'in use' -> 'active'

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:43: method.
Please note that its result is limited to audio recording within Chrome.</p>
'its result is limited to' -> 'it only checks for'

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:45:
<p>Repeated calls for the same session from the extension currently accessing
the
this paragraph seems unnecessary as these are obvious from the above
descriptions

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:51: <p>To
listen for speech recognition results the API provides the function
Simplify as 'Listen to the <code>onResult<code> event to receive speech
recognition results.'. If you prefer to use 'chrome.experimental.speechInput.'
prefix suggest doing the same throughout this doc.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:67: <p>If
there is an error during the recognition process or nothing could be
could simplify as 'To handle errors during speech recognition listen for the
<code>onError</code> event.' - and give a short code sample similar to above.
The callback's parameter would be different I presume

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:77: <p>If an
extension is currently recording for speech input it can request to stop
could simplify as 'To stop speech recognition call the <code>stop</code> method.
If provided, <code>callback</code>' ...

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:84:
<code>chrome.extension.lastError</code>. Repeated calls for the same session
could simplify similar to suggested above for start

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:91: <p>This
API also generates events when sound is detected to start and stop
Perhaps simplify this as just a listing of these two events.
"
<ul><li>
<code>onSoundStart</code> - Event generated when start of sound is detected
(from previously being silent)
</li><li>
<code>onSoundEnd</code> - Event generated when end of sound is detected (a
continued period of silence)
</li></ul>
"

[Leandro Graciá Gil, 2011-11-12 14:15:00]

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:6: one-shot
speech recognition to Chrome extensions. It provides exclusive
On 2011/11/11 22:17:54, Satish wrote:
> The 'It provides exclusive' statement is duplicated below as well. Perhaps
> remove it here?

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:28: This will
asynchronously request to start a new session for speech recognition.
On 2011/11/11 22:17:54, Satish wrote:
> This line seems unnecessary since you talk about the callback below

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:29: If
provided, <code>callback</code> will be called once the actual recording has
On 2011/11/11 22:17:54, Satish wrote:
> remove 'the actual'

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:30:
successfully started. A microphone tray icon will appear on the task bar during
On 2011/11/11 22:17:54, Satish wrote:
> We probably shouldn't talk about the UI here, just how to use the API?

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:31: all the
recognition session. In case of error during the start the call will
On 2011/11/11 22:17:54, Satish wrote:
> remove 'during the start the call will fail and '

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:35: extension
requesting it. Consequently, any calls to start when the device is
On 2011/11/11 22:17:54, Satish wrote:
> start -> "<code>start</code>"

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:36: being
used by anything else than the current extension will fail and set
On 2011/11/11 22:17:54, Satish wrote:
> 'anything else than the current extension' -> 'another extension or web page'

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:42: <p>To
check if recording is currently in use call the <code>isRecording</code>
On 2011/11/11 22:17:54, Satish wrote:
> 'in use' -> 'active'

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:43: method.
Please note that its result is limited to audio recording within Chrome.</p>
On 2011/11/11 22:17:54, Satish wrote:
> 'its result is limited to' -> 'it only checks for'

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:45:
<p>Repeated calls for the same session from the extension currently accessing
the
On 2011/11/11 22:17:54, Satish wrote:
> this paragraph seems unnecessary as these are obvious from the above
> descriptions

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:51: <p>To
listen for speech recognition results the API provides the function
On 2011/11/11 22:17:54, Satish wrote:
> Simplify as 'Listen to the <code>onResult<code> event to receive speech
> recognition results.'. If you prefer to use 'chrome.experimental.speechInput.'
> prefix suggest doing the same throughout this doc.

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:67: <p>If
there is an error during the recognition process or nothing could be
On 2011/11/11 22:17:54, Satish wrote:
> could simplify as 'To handle errors during speech recognition listen for the
> <code>onError</code> event.' - and give a short code sample similar to above.
> The callback's parameter would be different I presume

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:77: <p>If an
extension is currently recording for speech input it can request to stop
On 2011/11/11 22:17:54, Satish wrote:
> could simplify as 'To stop speech recognition call the <code>stop</code>
method.
> If provided, <code>callback</code>' ...

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:84:
<code>chrome.extension.lastError</code>. Repeated calls for the same session
On 2011/11/11 22:17:54, Satish wrote:
> could simplify similar to suggested above for start

Done.

http://codereview.chromium.org/8536022/diff/3001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:91: <p>This
API also generates events when sound is detected to start and stop
On 2011/11/11 22:17:54, Satish wrote:
> Perhaps simplify this as just a listing of these two events.
> "
> <ul><li>
> <code>onSoundStart</code> - Event generated when start of sound is detected
> (from previously being silent)
> </li><li>
> <code>onSoundEnd</code> - Event generated when end of sound is detected (a
> continued period of silence)
> </li></ul>
> "

Done.

[Satish, 2011-11-14 10:22:44]

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:33: when the
device is being used by other extension or web page will fail and set
other -> another

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:39: <p>To
check if recording is currently active use call the <code>isRecording</code>
use call -> call

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:53: <p>The
<code>result</code> object contains an array of recognition hypotheses
can you also document in detail this array item (i.e. a single result) ? Right
now the only info available about it is in the final example showing
.utterance.. we should ideally document all fields

[Leandro Graciá Gil, 2011-11-14 11:25:02]

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:33: when the
device is being used by other extension or web page will fail and set
On 2011/11/14 10:22:44, Satish wrote:
> other -> another

Done.

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:39: <p>To
check if recording is currently active use call the <code>isRecording</code>
On 2011/11/14 10:22:44, Satish wrote:
> use call -> call

Done.

http://codereview.chromium.org/8536022/diff/7001/chrome/common/extensions/doc...
chrome/common/extensions/docs/static/experimental.speechInput.html:53: <p>The
<code>result</code> object contains an array of recognition hypotheses
On 2011/11/14 10:22:44, Satish wrote:
> can you also document in detail this array item (i.e. a single result) ? Right
> now the only info available about it is in the final example showing
> .utterance.. we should ideally document all fields

Done.

[Satish, 2011-11-14 11:33:37]

http://codereview.chromium.org/8536022/diff/12001/chrome/common/extensions/do...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/12001/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:54: sorted by
decreasing likelihood. Each of these hypotheses is composed of a
It would be clearer if these two properties were listed as shown in the TTS api
(http://code.google.com/chrome/extensions/tts.html, see the last 'TtsVoice'
event for an example)

[Leandro Graciá Gil, 2011-11-14 12:04:54]

http://codereview.chromium.org/8536022/diff/12001/chrome/common/extensions/do...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/12001/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:54: sorted by
decreasing likelihood. Each of these hypotheses is composed of a
I've added a link to the autogenerated documentation, where the properties are
listed.

On 2011/11/14 11:33:37, Satish wrote:
> It would be clearer if these two properties were listed as shown in the TTS
api
> (http://code.google.com/chrome/extensions/tts.html, see the last 'TtsVoice'
> event for an example)

[Satish, 2011-11-14 12:36:11]

LGTM

[Leandro Graciá Gil, 2011-11-14 12:38:39]

Aaron, could you please take check if the extension doc update is ok?
Thanks.

[Aaron Boodman, 2011-11-14 19:10:03]

Kathy should review.

[kathyw, 2011-11-14 19:14:15]

Sure, I'll take a look.

-k-

On Mon, Nov 14, 2011 at 11:10 AM,  <aa@chromium.org> wrote:
> Kathy should review.
>
> http://codereview.chromium.org/8536022/
>

[kathyw, 2011-11-15 00:04:10]

A few nitpicky comments, but basically this looks good.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:13:
href="manifest.html">extension manifest</a> to use the speechInput

speechInput -> speech input

(since we're not listing the complete name of the API, just use the English
equivalent to talk about it)

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:26: <p>To
start recognizing speech an extension must call the <code>start</code>

Add () after method names:

<code>start()</code>

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:27: method.
If provided, <code>callback</code> will be called once recording has
<code>callback</code>
->
your callback

(or something similar; callback isn't a required name, so we don't <code> font
it)

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:35: will be
set if another extension in the same profile is making use of the API,

API, otherwise -> API. Otherwise

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:39: <p>To
check if recording is currently active call the <code>isRecording</code>
Slight tweaks (if -> whether, add comma, add ()):

To check whether recording is currently active, call the
<code>isRecording()</code> method.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:69:
</p>Recording will automatically stop in case on error.

on error -> of error
(or "of an error")

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:70: It is
safe to call <code>start</code> again from the error callback.</p>

start -> start()

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:74: <p>To
stop speech recognition call the <code>stop</code> method. If provided,

stop -> stop()

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:75:
<code>callback</code> will be called once recording has successfully

<code>callback</code>
->
the callback function

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:91: <p>The
following example illustrates how to show a javascript alert with the

javascript -> JavaScript

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:111: </pre>

We should add examples under docs/examples/<something> and link to them here.
But that can wait, unless you have an example handy.

[Leandro Graciá Gil, 2011-11-15 12:10:12]

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:13:
href="manifest.html">extension manifest</a> to use the speechInput
On 2011/11/15 00:04:10, kathyw wrote:
> 
> speechInput -> speech input
> 
> (since we're not listing the complete name of the API, just use the English
> equivalent to talk about it)

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:26: <p>To
start recognizing speech an extension must call the <code>start</code>
On 2011/11/15 00:04:10, kathyw wrote:
> 
> Add () after method names:
> 
> <code>start()</code>

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:27: method.
If provided, <code>callback</code> will be called once recording has
On 2011/11/15 00:04:10, kathyw wrote:
> <code>callback</code>
> ->
> your callback
> 
> (or something similar; callback isn't a required name, so we don't <code> font
> it)

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:35: will be
set if another extension in the same profile is making use of the API,
On 2011/11/15 00:04:10, kathyw wrote:
> 
> API, otherwise -> API. Otherwise

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:39: <p>To
check if recording is currently active call the <code>isRecording</code>
On 2011/11/15 00:04:10, kathyw wrote:
> Slight tweaks (if -> whether, add comma, add ()):
> 
> To check whether recording is currently active, call the
> <code>isRecording()</code> method.

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:69:
</p>Recording will automatically stop in case on error.
On 2011/11/15 00:04:10, kathyw wrote:
> 
> on error -> of error
> (or "of an error")

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:70: It is
safe to call <code>start</code> again from the error callback.</p>
On 2011/11/15 00:04:10, kathyw wrote:
> 
> start -> start()

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:74: <p>To
stop speech recognition call the <code>stop</code> method. If provided,
On 2011/11/15 00:04:10, kathyw wrote:
> 
> stop -> stop()

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:75:
<code>callback</code> will be called once recording has successfully
On 2011/11/15 00:04:10, kathyw wrote:
> 
> <code>callback</code>
> ->
> the callback function

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:91: <p>The
following example illustrates how to show a javascript alert with the
On 2011/11/15 00:04:10, kathyw wrote:
> 
> javascript -> JavaScript

Done.

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:111: </pre>
The example I have is basically the same simple case I'm already showing here. I
guess something more elaborate should go to the examples folder.

On 2011/11/15 00:04:10, kathyw wrote:
> 
> We should add examples under docs/examples/<something> and link to them here.
> But that can wait, unless you have an example handy.

[kathyw, 2011-11-15 17:57:14]

http://codereview.chromium.org/8536022/diff/12002/chrome/common/extensions/do...
> chrome/common/extensions/docs/static/experimental.speechInput.html:111: </pre>
> The example I have is basically the same simple case I'm already showing here.
I
> guess something more elaborate should go to the examples folder.
> 
> On 2011/11/15 00:04:10, kathyw wrote:
> > 
> > We should add examples under docs/examples/<something> and link to them
here.
> > But that can wait, unless you have an example handy.

It's OK to use the same example in the examples directory. The important thing
is to have something that'll show up when people search the Samples page.

You could put a simple example under examples/api, and a more complicated one
under that directory or (if it's actually useful/complex) the
examples/extensions directory.

[kathyw, 2011-11-15 17:59:06]

lgtm

(once you fix a single typo)

http://codereview.chromium.org/8536022/diff/16001/chrome/common/extensions/do...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/16001/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:76: the
callback funciton will be called once recording has successfully stopped.
funciton -> function

[Leandro Graciá Gil, 2011-11-16 00:07:12]

Added also an example. Could you please check if it's ok?

Thanks.

http://codereview.chromium.org/8536022/diff/16001/chrome/common/extensions/do...
File chrome/common/extensions/docs/static/experimental.speechInput.html (right):

http://codereview.chromium.org/8536022/diff/16001/chrome/common/extensions/do...
chrome/common/extensions/docs/static/experimental.speechInput.html:76: the
callback funciton will be called once recording has successfully stopped.
On 2011/11/15 17:59:06, kathyw wrote:
> funciton -> function

Done.

[kathyw, 2011-11-16 00:26:40]

lgtm

Someone else should probably review the code, though.

[Satish, 2011-11-17 16:29:22]

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
File
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html
(right):

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:3:
function checkStart() {
since this is a small enough function and used only once, may be define it as a
closure in the .start() call for simplicity?

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:11:
if (!recording)
use braces here?

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:12:
chrome.experimental.speechInput.start({}, checkStart);
it may be useful if we change the browser action icon to a 'recording' state
after this call and switch back to normal state after calling .stop below

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:12:
chrome.experimental.speechInput.start({}, checkStart);
is that empty dictionary {} required or can a null be passed?

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
File chrome/common/extensions/docs/examples/api/speechInput/basic/manifest.json
(right):

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/manifest.json:6:
"default_title": "Speech input demo",
may  be use the same string for 'name' and 'default_title' ?

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
File chrome/common/extensions/docs/samples.json (right):

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/samples.json:2111: "icon": null,
should point this to a valid icon file name? the other entries above and below
seem to do it.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/samples.json:2113: "name": "Speech recognizer",
capitalise the first letter of all words in the name.. same in the manifest.json
file

[Leandro Graciá Gil, 2011-11-17 22:02:45]

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
File
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html
(right):

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:3:
function checkStart() {
On 2011/11/17 16:29:23, Satish wrote:
> since this is a small enough function and used only once, may be define it as
a
> closure in the .start() call for simplicity?

Done.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:11:
if (!recording)
On 2011/11/17 16:29:23, Satish wrote:
> use braces here?

Done.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:12:
chrome.experimental.speechInput.start({}, checkStart);
On 2011/11/17 16:29:23, Satish wrote:
> it may be useful if we change the browser action icon to a 'recording' state
> after this call and switch back to normal state after calling .stop below

Done.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/background.html:12:
chrome.experimental.speechInput.start({}, checkStart);
On 2011/11/17 16:29:23, Satish wrote:
> is that empty dictionary {} required or can a null be passed?

It is required.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
File chrome/common/extensions/docs/examples/api/speechInput/basic/manifest.json
(right):

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/examples/api/speechInput/basic/manifest.json:6:
"default_title": "Speech input demo",
On 2011/11/17 16:29:23, Satish wrote:
> may  be use the same string for 'name' and 'default_title' ?

Sorry, I changed one and forgot about the other. Fixed.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
File chrome/common/extensions/docs/samples.json (right):

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/samples.json:2111: "icon": null,
On 2011/11/17 16:29:23, Satish wrote:
> should point this to a valid icon file name? the other entries above and below
> seem to do it.

I don't recall changing this file. This is probably autogenerated.
In any case it looks like only the examples providing custom icons have
something non-null here. Since we don't have any custom icon in mind and there
are many other cases like this in the file I think it would be simpler to leave
it as it is.

http://codereview.chromium.org/8536022/diff/20001/chrome/common/extensions/do...
chrome/common/extensions/docs/samples.json:2113: "name": "Speech recognizer",
On 2011/11/17 16:29:23, Satish wrote:
> capitalise the first letter of all words in the name.. same in the
manifest.json
> file

Done.

[Satish, 2011-11-17 22:29:34]

lgtm