Add chrome-firephp sample extensions; add sample references to devtools pages

Add chrome-firephp sample extensions; add sample references to devtools pages

BUG=none
TEST=chrome.devtools.* pages have "Examples" section, theres chrome-firephp on samples page.

[caseq1, 2011-05-06 16:53:32]

This just adds an example under api/devtools/resources, and a one-line section
referring to the sampels page and a subversion examples directory to all
devtools pages.

Live version: http://www.corp.google.com/~caseq/devtoolsext/docs/samples.html

[caseq, 2011-05-20 08:38:26]

ping :-)

[apavlov, 2011-05-20 08:46:53]

The code looks good, barring the two nits.

http://codereview.chromium.org/6948003/diff/1/chrome/common/extensions/docs/e...
File
chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.js
(right):

http://codereview.chromium.org/6948003/diff/1/chrome/common/extensions/docs/e...
chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.js:109:
//  const dump_header_prefix = "X-Wf-1-2-1-";
Remove

http://codereview.chromium.org/6948003/diff/1/chrome/common/extensions/docs/e...
chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.js:174:
Console.warn( "ChromeFirePHP suggests that you reload the page to track" +
Odd space before the string

[Kathy Walrath, 2011-05-20 15:27:55]

Oops, sorry for the delay.

We've stopped referring to example directories directly, since the
Samples page has a nicer interface to the source code. So on the
static pages, you can change the text from this form:

> You can find samples of this API on the samples page and in the
devtools/audits samples directory.

To this form:

> You can find examples that use this API in Samples.

Where "Samples" is a link to all samples for this API (i.e., exactly
the same link you have for "samples page" right now).

Another possibility is to go into more detail about particular
examples. For instance:

> {... sample code and an explanation of its use goes here...}
>
> For a simple example of using this API, see the _basic_bookmarks_sample.
> You can find more bookmark API examples in _Samples_.

...where all the links should -- but don't currently -- point to an
anchor in the Samples page. I'll file a bug against myself to add/fix
Samples page links in the doc.

-k-

[caseq, 2011-05-24 08:08:08]

Thanks! All comments addressed.

[kathyw, 2011-05-24 20:23:23]

LGTM

There's one weird thing, though... When I go to your generated version of
samples.html#devtools, there's no "Calls" section for Chrome Query.
(devtools.html calls
chrome.experimental.devtools.panels.elements.createSidebarPane and
chrome.experimental.devtools.panels.elements.onSelectionChanged.addListener.)

Do you know why this is (not) happening? Maybe it's because the code is in an
HTML file, not a JS file?

-k-

[caseq, 2011-05-24 20:45:18]

On 2011/05/24 20:23:23, kathyw wrote:
> LGTM
> 
> There's one weird thing, though... When I go to your generated version of
> samples.html#devtools, there's no "Calls" section for Chrome Query.
> (devtools.html calls
> chrome.experimental.devtools.panels.elements.createSidebarPane and
> chrome.experimental.devtools.panels.elements.onSelectionChanged.addListener.)
> 
> Do you know why this is (not) happening? Maybe it's because the code is in an
> HTML file, not a JS file?
> 
> -k-

I know and, unfortunately, it's a fundamental problem: they way we gather call
lists for examples works reasonably well for procedural-style API, but doesn't
work for OO-style API of devtools. In fact, so far we only extract method names
for a handful of "static" methods in the DevTools API. The way it works is that
we just grep the example for all possible [fully qualified] method names. This
doesn't work for methods that are invoked on an arbitrary-named objects in the
client code. Referring to your example, there's no such method as
chrome.experimental.devtools.panels.elements.createSidebarPane, there's
PanelWithSidebars.createSidebarPane method and
chrome.experimental.devtools.panels getter named "elements" that happens to
return ElementsPanel which is a PanelWithSidebar.

As you can see, extracting call list from an OO example is an effort of a
different scale. I'm thinking of adding some special comments that would refer
to methods used by the example by it's canonical name.

[kathyw, 2011-05-24 21:00:14]

Could you file a bug about this, so we don't lose this info? (Or I can file one,
just referring people to the discussion here.)

-k-

[caseq, 2011-05-25 17:13:49]

On 2011/05/24 21:00:14, kathyw wrote:
> Could you file a bug about this, so we don't lose this info? (Or I can file
one,
> just referring people to the discussion here.)
> 

Landed as r86644, raised
http://code.google.com/p/chromium/issues/detail?id=83906 for missing calls.