doc: Add titles for all pages.

This commit is contained in:
Cheng Zhao 2013-09-09 15:35:57 +08:00
parent 3715dd2a20
commit 6b81070f67
20 changed files with 28 additions and 13 deletions

View file

@ -1,4 +1,4 @@
## Synopsis # app
The `app` module is responsible for controlling the application's life time. The `app` module is responsible for controlling the application's life time.

View file

@ -1,4 +1,4 @@
## Synopsis # atom-delegate
The `atom-delegate` returns the delegate object for Chrome Content API. The The `atom-delegate` returns the delegate object for Chrome Content API. The
atom-shell would call methods of the delegate object when the corresponding atom-shell would call methods of the delegate object when the corresponding

View file

@ -1,4 +1,4 @@
## Synopsis # auto-updater
`auto-updater` module is a simple wrap around the Sparkle framework, it `auto-updater` module is a simple wrap around the Sparkle framework, it
provides auto update service for the application. provides auto update service for the application.

View file

@ -1,3 +1,5 @@
# Build instructions (Mac)
## Prerequisites ## Prerequisites
* Mac OS X >= 10.7 * Mac OS X >= 10.7

View file

@ -1,3 +1,5 @@
# Build instructions (Windows)
## Prerequisites ## Prerequisites
* Windows 7 or later * Windows 7 or later

View file

@ -1,3 +1,5 @@
# Build native modules
Since atom-shell is using a different V8 version from the official node, you 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. need to build native module against atom-shell's headers to use them.

View file

@ -1,4 +1,4 @@
## Synopsis # clipboard
An example of writing a string to clipboard: An example of writing a string to clipboard:

View file

@ -1,3 +1,5 @@
# Coding style
## C++ and Python ## C++ and Python
For C++ and Python, we just follow Chromium's [Coding For C++ and Python, we just follow Chromium's [Coding

View file

@ -1,4 +1,4 @@
## Synopsis # crash-reporter
An example of automatically submitting crash reporters to remote server: An example of automatically submitting crash reporters to remote server:

View file

@ -1,4 +1,4 @@
## Synopsis # dialog
The `dialog` module provides functions to show system dialogs, so web The `dialog` module provides functions to show system dialogs, so web
applications can get the same user experience with native applications. applications can get the same user experience with native applications.

View file

@ -1,4 +1,4 @@
## Synopsis # ipc (browser)
The `ipc` module allows developers to send asynchronous messages to renderers. 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 To avoid possible dead-locks, it's not allowed to send synchronous messages in

View file

@ -1,4 +1,4 @@
## Synopsis # ipc (renderer)
The `ipc` module provides a few methods so you can send synchronous and The `ipc` module provides a few methods so you can send synchronous and
asynchronous messages to the browser, and also receive messages sent from asynchronous messages to the browser, and also receive messages sent from

View file

@ -1,3 +1,5 @@
# menu-item
## Class: MenuItem ## Class: MenuItem
### new MenuItem(options) ### new MenuItem(options)

View file

@ -1,4 +1,4 @@
## Synopsis # menu
The `Menu` class is used to create native menus that can be used as 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 application menu and context menu. Each menu is consisted of multiple menu

View file

@ -1,4 +1,4 @@
## Synopsis # power-monitor
The `power-monitor` module is used to monitor the power state change, you can The `power-monitor` module is used to monitor the power state change, you can
only use it on the browser side. only use it on the browser side.

View file

@ -1,4 +1,4 @@
## Synopsis # protocol
The `protocol` module can register a new protocol or intercept an existing 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. protocol, so you can custom the response to the requests for vairous protocols.

View file

@ -1,3 +1,5 @@
# Quick start
## Introduction ## Introduction
Generally, atom-shell lets you create a web-based desktop application in pure Generally, atom-shell lets you create a web-based desktop application in pure

View file

@ -1,4 +1,4 @@
## Synopsis # remote
It's common that the developers want to use modules in browsers from the 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 renderer, like closing current window, opening file dialogs, etc. Instead of

View file

@ -1,4 +1,4 @@
## Synopsis # shell
The `shell` module provides functions related to desktop integration. The `shell` module provides functions related to desktop integration.

View file

@ -1,3 +1,5 @@
# Source code directory structure
## Overview ## Overview
The source code of atom-shell is separated into a few parts, and we are mostly 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. program.
* **browser** - The frontend including the main window, UI, and all browser * **browser** - The frontend including the main window, UI, and all browser
side things. This talks to the renderer to manage web pages. 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. * **atom** - Initializes the javascript environment of browser.
* **default_app** - The default page to show when atom-shell is started * **default_app** - The default page to show when atom-shell is started
without providing an app. without providing an app.