From: Cheng Zhao Date: Mon, 5 May 2014 06:24:57 +0000 (+0800) Subject: :memo: Simpilify the structure of API references. X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=59339470001dbdeac97088eba047531d2632209d;p=platform%2Fframework%2Fweb%2Fcrosswalk-tizen.git :memo: Simpilify the structure of API references. --- diff --git a/docs/README.md b/docs/README.md index a4dbccd..816febb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Atom Shell Documentations +# Atom Shell documents ## Tutorials @@ -14,28 +14,28 @@ * [Build instructions (Windows)](development/build-instructions-windows.md) * [Build instructions (Linux)](development/build-instructions-linux.md) -## API References +## API references -Renderer side modules: +Browser side modules: -* [ipc (renderer)](api/renderer/ipc-renderer.md) -* [remote](api/renderer/remote.md) +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [dialog](api/dialog.md) +* [ipc (browser)](api/ipc-browser.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [protocol](api/protocol.md) -Browser side modules: +Renderer side modules: -* [app](api/browser/app.md) -* [auto-updater](api/browser/auto-updater.md) -* [browser-window](api/browser/browser-window.md) -* [dialog](api/browser/dialog.md) -* [ipc (browser)](api/browser/ipc-browser.md) -* [menu](api/browser/menu.md) -* [menu-item](api/browser/menu-item.md) -* [power-monitor](api/browser/power-monitor.md) -* [protocol](api/browser/protocol.md) +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) Common modules: -* [clipboard](api/common/clipboard.md) -* [crash-reporter](api/common/crash-reporter.md) -* [screen](api/common/screen.md) -* [shell](api/common/shell.md) +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [screen](api/screen.md) +* [shell](api/shell.md) diff --git a/docs/api/browser/app.md b/docs/api/app.md similarity index 100% rename from docs/api/browser/app.md rename to docs/api/app.md diff --git a/docs/api/browser/auto-updater.md b/docs/api/auto-updater.md similarity index 100% rename from docs/api/browser/auto-updater.md rename to docs/api/auto-updater.md diff --git a/docs/api/browser/browser-window.md b/docs/api/browser-window.md similarity index 99% rename from docs/api/browser/browser-window.md rename to docs/api/browser-window.md index 7768e0b..e31348e 100644 --- a/docs/api/browser/browser-window.md +++ b/docs/api/browser-window.md @@ -346,7 +346,7 @@ You can write received `image` directly to a `.png` file, or you can base64 encode it and use data URL to embed the image in HTML. **Note:** Be sure to read documents on remote buffer in -[remote](../renderer/remote.md) if you are going to use this API in renderer +[remote](remote.md) if you are going to use this API in renderer process. ### BrowserWindow.loadUrl(url) diff --git a/docs/api/common/clipboard.md b/docs/api/clipboard.md similarity index 100% rename from docs/api/common/clipboard.md rename to docs/api/clipboard.md diff --git a/docs/api/common/crash-reporter.md b/docs/api/crash-reporter.md similarity index 100% rename from docs/api/common/crash-reporter.md rename to docs/api/crash-reporter.md diff --git a/docs/api/browser/dialog.md b/docs/api/dialog.md similarity index 100% rename from docs/api/browser/dialog.md rename to docs/api/dialog.md diff --git a/docs/api/browser/frameless-window.md b/docs/api/frameless-window.md similarity index 100% rename from docs/api/browser/frameless-window.md rename to docs/api/frameless-window.md diff --git a/docs/api/browser/ipc-browser.md b/docs/api/ipc-browser.md similarity index 100% rename from docs/api/browser/ipc-browser.md rename to docs/api/ipc-browser.md diff --git a/docs/api/renderer/ipc-renderer.md b/docs/api/ipc-renderer.md similarity index 93% rename from docs/api/renderer/ipc-renderer.md rename to docs/api/ipc-renderer.md index 5c10126..b5f1157 100644 --- a/docs/api/renderer/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -5,7 +5,7 @@ asynchronous messages to the browser, and also receive messages sent from browser. If you want to make use of modules of browser from renderer, you might consider using the [remote](remote.md) module. -See [ipc (browser)](../browser/ipc-browser.md) for examples. +See [ipc (browser)](ipc-browser.md) for examples. ## ipc.send(channel[, args...]) diff --git a/docs/api/browser/menu-item.md b/docs/api/menu-item.md similarity index 100% rename from docs/api/browser/menu-item.md rename to docs/api/menu-item.md diff --git a/docs/api/browser/menu.md b/docs/api/menu.md similarity index 100% rename from docs/api/browser/menu.md rename to docs/api/menu.md diff --git a/docs/api/browser/power-monitor.md b/docs/api/power-monitor.md similarity index 100% rename from docs/api/browser/power-monitor.md rename to docs/api/power-monitor.md diff --git a/docs/api/browser/protocol.md b/docs/api/protocol.md similarity index 100% rename from docs/api/browser/protocol.md rename to docs/api/protocol.md diff --git a/docs/api/renderer/remote.md b/docs/api/remote.md similarity index 98% rename from docs/api/renderer/remote.md rename to docs/api/remote.md index b3bfda2..4440dc8 100644 --- a/docs/api/renderer/remote.md +++ b/docs/api/remote.md @@ -136,7 +136,7 @@ Returns the object returned by `require(module)` in the browser process. ## remote.getCurrentWindow() -Returns the [BrowserWindow](../browser/browser-window.md) object which +Returns the [BrowserWindow](browser-window.md) object which represents current window. ## remote.getGlobal(name) diff --git a/docs/api/common/screen.md b/docs/api/screen.md similarity index 100% rename from docs/api/common/screen.md rename to docs/api/screen.md diff --git a/docs/api/common/shell.md b/docs/api/shell.md similarity index 100% rename from docs/api/common/shell.md rename to docs/api/shell.md diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 3e7ce4f..fb4f61f 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -26,8 +26,8 @@ scripts. In traditional node.js applications, communication between server side and client side are usually done by web sockets. In atom-shell, we have provided -the [ipc](../api/renderer/ipc-renderer.md) module for browser side to client -communication, and the [remote](../api/renderer/remote.md) module for easy RPC +the [ipc](../api/ipc-renderer.md) module for browser side to client +communication, and the [remote](../api/remote.md) module for easy RPC support. ### Web page and node.js @@ -39,7 +39,7 @@ in web pages so you could access native resources in web pages, just like But unlike node-webkit, you could not do native GUI related operations in web pages, instead you need to do them on the browser side by sending messages or -use the easy [remote](../api/renderer/remote.md) module. +use the easy [remote](../api/remote.md) module. ## Write your first atom-shell app diff --git a/docs/tutorial/use-native-node-module.md b/docs/tutorial/use-native-node-modules.md similarity index 100% rename from docs/tutorial/use-native-node-module.md rename to docs/tutorial/use-native-node-modules.md