From 6b81070f67210fbaa09100097834b21e354de7c9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 9 Sep 2013 15:35:57 +0800 Subject: [PATCH] doc: Add titles for all pages. --- docs/app.md | 2 +- docs/atom-delegate.md | 2 +- docs/auto-updater.md | 2 +- docs/build-instructions-mac.md | 2 ++ docs/build-instructions-windows.md | 2 ++ docs/build-native-modules.md | 2 ++ docs/clipboard.md | 2 +- docs/coding-style.md | 2 ++ docs/crash-reporter.md | 2 +- docs/dialog.md | 2 +- docs/ipc-browser.md | 2 +- docs/ipc-renderer.md | 2 +- docs/menu-item.md | 2 ++ docs/menu.md | 2 +- docs/power-monitor.md | 2 +- docs/protocol.md | 2 +- docs/quick-start.md | 2 ++ docs/remote.md | 2 +- docs/shell.md | 2 +- docs/source-code-directory-structure.md | 3 +++ 20 files changed, 28 insertions(+), 13 deletions(-) diff --git a/docs/app.md b/docs/app.md index f9f075b7543c..092eb3882521 100644 --- a/docs/app.md +++ b/docs/app.md @@ -1,4 +1,4 @@ -## Synopsis +# app The `app` module is responsible for controlling the application's life time. diff --git a/docs/atom-delegate.md b/docs/atom-delegate.md index f4cb30742fa1..b172a77d5d12 100644 --- a/docs/atom-delegate.md +++ b/docs/atom-delegate.md @@ -1,4 +1,4 @@ -## Synopsis +# atom-delegate The `atom-delegate` returns the delegate object for Chrome Content API. The atom-shell would call methods of the delegate object when the corresponding diff --git a/docs/auto-updater.md b/docs/auto-updater.md index 77d912700999..d78a8720abe1 100644 --- a/docs/auto-updater.md +++ b/docs/auto-updater.md @@ -1,4 +1,4 @@ -## Synopsis +# auto-updater `auto-updater` module is a simple wrap around the Sparkle framework, it provides auto update service for the application. diff --git a/docs/build-instructions-mac.md b/docs/build-instructions-mac.md index f1d6d5dbcba6..d56876e5ef5d 100644 --- a/docs/build-instructions-mac.md +++ b/docs/build-instructions-mac.md @@ -1,3 +1,5 @@ +# Build instructions (Mac) + ## Prerequisites * Mac OS X >= 10.7 diff --git a/docs/build-instructions-windows.md b/docs/build-instructions-windows.md index d95bf2d200bb..3939a9fd2845 100644 --- a/docs/build-instructions-windows.md +++ b/docs/build-instructions-windows.md @@ -1,3 +1,5 @@ +# Build instructions (Windows) + ## Prerequisites * Windows 7 or later diff --git a/docs/build-native-modules.md b/docs/build-native-modules.md index 19a8c9288704..feb5514c8255 100644 --- a/docs/build-native-modules.md +++ b/docs/build-native-modules.md @@ -1,3 +1,5 @@ +# Build native modules + Since atom-shell is using a different V8 version from the official node, you need to build native module against atom-shell's headers to use them. diff --git a/docs/clipboard.md b/docs/clipboard.md index 3775fbafc456..f95364f059b6 100644 --- a/docs/clipboard.md +++ b/docs/clipboard.md @@ -1,4 +1,4 @@ -## Synopsis +# clipboard An example of writing a string to clipboard: diff --git a/docs/coding-style.md b/docs/coding-style.md index 99e4c69e3a53..28f3c5bbe488 100644 --- a/docs/coding-style.md +++ b/docs/coding-style.md @@ -1,3 +1,5 @@ +# Coding style + ## C++ and Python For C++ and Python, we just follow Chromium's [Coding diff --git a/docs/crash-reporter.md b/docs/crash-reporter.md index e5fde5c33c9d..b6785fa33490 100644 --- a/docs/crash-reporter.md +++ b/docs/crash-reporter.md @@ -1,4 +1,4 @@ -## Synopsis +# crash-reporter An example of automatically submitting crash reporters to remote server: diff --git a/docs/dialog.md b/docs/dialog.md index 2b7f58cc2c99..0ded6b49735c 100644 --- a/docs/dialog.md +++ b/docs/dialog.md @@ -1,4 +1,4 @@ -## Synopsis +# dialog The `dialog` module provides functions to show system dialogs, so web applications can get the same user experience with native applications. diff --git a/docs/ipc-browser.md b/docs/ipc-browser.md index 30061515cfc2..34ebda8a4dca 100644 --- a/docs/ipc-browser.md +++ b/docs/ipc-browser.md @@ -1,4 +1,4 @@ -## Synopsis +# ipc (browser) The `ipc` module allows developers to send asynchronous messages to renderers. To avoid possible dead-locks, it's not allowed to send synchronous messages in diff --git a/docs/ipc-renderer.md b/docs/ipc-renderer.md index 78533db33a49..cdeadf39f680 100644 --- a/docs/ipc-renderer.md +++ b/docs/ipc-renderer.md @@ -1,4 +1,4 @@ -## Synopsis +# ipc (renderer) The `ipc` module provides a few methods so you can send synchronous and asynchronous messages to the browser, and also receive messages sent from diff --git a/docs/menu-item.md b/docs/menu-item.md index 693343a65367..ec54743d9713 100644 --- a/docs/menu-item.md +++ b/docs/menu-item.md @@ -1,3 +1,5 @@ +# menu-item + ## Class: MenuItem ### new MenuItem(options) diff --git a/docs/menu.md b/docs/menu.md index 586d5442f883..2e813d5b6e1d 100644 --- a/docs/menu.md +++ b/docs/menu.md @@ -1,4 +1,4 @@ -## Synopsis +# menu The `Menu` class is used to create native menus that can be used as application menu and context menu. Each menu is consisted of multiple menu diff --git a/docs/power-monitor.md b/docs/power-monitor.md index 873d2a931969..1f7169fc3552 100644 --- a/docs/power-monitor.md +++ b/docs/power-monitor.md @@ -1,4 +1,4 @@ -## Synopsis +# power-monitor The `power-monitor` module is used to monitor the power state change, you can only use it on the browser side. diff --git a/docs/protocol.md b/docs/protocol.md index d13025df987d..ec6c1f2f0556 100644 --- a/docs/protocol.md +++ b/docs/protocol.md @@ -1,4 +1,4 @@ -## Synopsis +# protocol The `protocol` module can register a new protocol or intercept an existing protocol, so you can custom the response to the requests for vairous protocols. diff --git a/docs/quick-start.md b/docs/quick-start.md index 37a4bf302f18..5ba8e85b1e51 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -1,3 +1,5 @@ +# Quick start + ## Introduction Generally, atom-shell lets you create a web-based desktop application in pure diff --git a/docs/remote.md b/docs/remote.md index 3514826fee4c..74117687cafe 100644 --- a/docs/remote.md +++ b/docs/remote.md @@ -1,4 +1,4 @@ -## Synopsis +# remote It's common that the developers want to use modules in browsers from the renderer, like closing current window, opening file dialogs, etc. Instead of diff --git a/docs/shell.md b/docs/shell.md index 3cb8350ea7f8..e909ac60321f 100644 --- a/docs/shell.md +++ b/docs/shell.md @@ -1,4 +1,4 @@ -## Synopsis +# shell The `shell` module provides functions related to desktop integration. diff --git a/docs/source-code-directory-structure.md b/docs/source-code-directory-structure.md index 00a0d4f3add8..3f46bf63029c 100644 --- a/docs/source-code-directory-structure.md +++ b/docs/source-code-directory-structure.md @@ -1,3 +1,5 @@ +# Source code directory structure + ## Overview The source code of atom-shell is separated into a few parts, and we are mostly @@ -13,6 +15,7 @@ to understand the source code better. program. * **browser** - The frontend including the main window, UI, and all browser side things. This talks to the renderer to manage web pages. + * **ui** - Implementation of UI stuff for different platforms. * **atom** - Initializes the javascript environment of browser. * **default_app** - The default page to show when atom-shell is started without providing an app.