diff options
author | kathyw@google.com <kathyw@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-08-31 23:45:23 +0000 |
---|---|---|
committer | kathyw@google.com <kathyw@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2009-08-31 23:45:23 +0000 |
commit | d40f3747b418e94e0c416fbfc9adc9be510593ed (patch) | |
tree | 318c6fc72df3e08f83624ba181a5e09d5ad172d1 | |
parent | cf06ddb055df3172c48aa07579d7da252f2eaa58 (diff) | |
download | chromium_src-d40f3747b418e94e0c416fbfc9adc9be510593ed.zip chromium_src-d40f3747b418e94e0c416fbfc9adc9be510593ed.tar.gz chromium_src-d40f3747b418e94e0c416fbfc9adc9be510593ed.tar.bz2 |
Miscellaneous doc cleanup.
TBR=aa
Review URL: http://codereview.chromium.org/175039
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@24973 0039d316-1c4b-4281-b951-d872f2087c98
4 files changed, 29 insertions, 21 deletions
diff --git a/chrome/common/extensions/docs/static/bookmarks.html b/chrome/common/extensions/docs/static/bookmarks.html index bf613fd..f03c7c2 100755 --- a/chrome/common/extensions/docs/static/bookmarks.html +++ b/chrome/common/extensions/docs/static/bookmarks.html @@ -2,18 +2,21 @@ <!-- BEGIN AUTHORED CONTENT --> <p id="classSummary"> -Use the <code>chrome.bookmarks</code> API to create, organize, and otherwise manipulate bookmarks. +Use the <code>chrome.bookmarks</code> API to create, organize, +and otherwise manipulate bookmarks. </p> <h2 id="description">Description</h2> -<p> -[PENDING: intro goes here...] +<p class="comment"> +[PENDING: This section needs to be reviewed and updated.] </p> <p> -<em>Bookmark objects</em> are an important part of the <code>chrome.bookmarks</code> API. -Each bookmark object represents either a URL or a group of bookmarks, as you can see in the following figure. +<a href="#type-BookmarkTreeNode">BookmarkTreeNode</a> objects +are an important part of the <code>chrome.bookmarks</code> API. +Each bookmark tree node represents +either a URL or a group of bookmarks, as you can see in the following figure. </p> <img @@ -21,18 +24,27 @@ Each bookmark object represents either a URL or a group of bookmarks, as you can width="415" height="123" src="images/bookmarks.png"></a> +<br /> +<span class="comment"> +[PENDING: this figure needs to be updated] +</span> <h3 id="overview-properties">Properties</h3> -<p>Objects that represent bookmarks can have the following properties: +<p> +Objects that represent bookmarks can have the following properties: </p> <dl> <dt> <code>id</code> </dt> <dd> An integer ID that's unique for each bookmark. Don't save this ID in persistent storage; - the ID for a particular bookmark might change the next time the browser is started. + the ID for a particular bookmark might change + the next time the browser is started. + <span class="comment"> + [PENDING: these might be persistent now] + </span> </dd> <dt> <code>title</code> </dt> @@ -54,6 +66,8 @@ Each bookmark object represents either a URL or a group of bookmarks, as you can <em>(omitted for groups)</em> </dt> <dd> The URL of the page that the bookmark points to. </dd> + +<dt> ... </dt> </dl> <h3 id="overview-examples">Examples</h3> @@ -113,13 +127,15 @@ Here's how those bookmarks might be represented with bookmark objects:</p> <p> Here's some code you could use to create that hierarchy:</p> -<pre class="example"> -...code goes here... +<pre class="example comment"> +[PENDING: ...code goes here...] </pre> +<!-- PENDING: we could have links to source code and sample extensions. E.g.: <div class="exampleLink"> <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ">Full source code</a> | <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ">Install extension</a> -</div> <!-- END exampleLink --> +</div> +--> <!-- END AUTHORED CONTENT --> diff --git a/chrome/common/extensions/docs/static/getstarted.html b/chrome/common/extensions/docs/static/getstarted.html index 381eacf..e733c67 100755 --- a/chrome/common/extensions/docs/static/getstarted.html +++ b/chrome/common/extensions/docs/static/getstarted.html @@ -181,7 +181,7 @@ and where to find more information.]</p> </li> <li> Learn more about - <a href="toolstrips.html">toolstrips</a> + <a href="toolstrip.html">toolstrips</a> </li> <li> <a href="packaging.html">Package</a> diff --git a/chrome/common/extensions/docs/static/index.html b/chrome/common/extensions/docs/static/index.html index 70cdebb..db900d9 100755 --- a/chrome/common/extensions/docs/static/index.html +++ b/chrome/common/extensions/docs/static/index.html @@ -76,7 +76,7 @@ Start with one of these sections: Google Chrome's extension system. </li> <li> - <a href="#">Developer's Guide</a>: + <a href="devguide.html">Developer's Guide</a>: Get detailed information on using each feature and API. </li> </ul> diff --git a/chrome/common/extensions/docs/static/overview.html b/chrome/common/extensions/docs/static/overview.html index 277c5c6..70c368c 100755 --- a/chrome/common/extensions/docs/static/overview.html +++ b/chrome/common/extensions/docs/static/overview.html @@ -105,14 +105,6 @@ under the extension's top directory; it's the same as the relative URL. </p> -<p class="comment"> -[QUESTION TO REVIEWERS: Is this section too big/detailed? -It seems a little weird to mention absolute URLs with mentioning getURL -and when you'd need it. -What's the motivation for covering absolute URLs? -Is the debugger the place you're most likely to see them?] -</p> - <p> For example, assume your extension has the ID <b>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</b> @@ -315,7 +307,7 @@ Two kinds of communication happen within an extension: Communication <b>between content scripts and the extension</b>. <br /> For example, - <span class="comment">[PENDING: example goes here]</span>. + <span class="comment">[PENDING: typical use case goes here]</span>. See <a href="content_scripts.html">Content Scripts</a> for information about this type of communication. </li> |