daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
node/doc/api/documentation.markdown

83 lines
2.6 KiB
Markdown
Raw Normal View History

Add 'about these docs' section
2012-02-28 03:06:14 +08:00
# About this Documentation
<!-- type=misc -->
The goal of this documentation is to comprehensively explain the Node.js
API, both from a reference as well as a conceptual point of view. Each
section describes a built-in module or high-level concept.
Where appropriate, property types, method arguments, and the arguments
provided to event handlers are detailed in a list underneath the topic
heading.
Every `.html` document has a corresponding `.json` document presenting
the same information in a structured manner. This feature is
experimental, and added for the benefit of IDEs and other utilities that
wish to do programmatic things with the documentation.
Every `.html` and `.json` file is generated based on the corresponding
`.markdown` file in the `doc/api/` folder in node's source tree. The
documentation is generated using the `tools/doc/generate.js` program.
The HTML template is located at `doc/template.html`.
## Stability Index
<!--type=misc-->
Throughout the documentation, you will see indications of a section's
stability. The Node.js API is still somewhat changing, and as it
matures, certain parts are more reliable than others. Some are so
proven, and so relied upon, that they are unlikely to ever change at
all. Others are brand new and experimental, or known to be hazardous
and in the process of being redesigned.
The stability indices are as follows:
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Stability: 0 - Deprecated
This feature is known to be problematic, and changes are
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
planned. Do not rely on it. Use of the feature may cause warnings. Backwards
compatibility should not be expected.
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Stability: 1 - Experimental
This feature was introduced recently, and may change
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
or be removed in future versions. Please try it out and provide feedback.
If it addresses a use-case that is important to you, tell the node core team.
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Stability: 2 - Unstable
The API is in the process of settling, but has not yet had
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
sufficient real-world testing to be considered stable. Backwards-compatibility
will be maintained if reasonable.
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Stability: 3 - Stable
The API has proven satisfactory, but cleanup in the underlying
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
code may cause minor changes. Backwards-compatibility is guaranteed.
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Stability: 4 - API Frozen
This API has been tested extensively in production and is
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
unlikely to ever have to change.
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
doc: modify documentation style about 'Stability: 5' 'Stability: 5' is described as 'Locked' not as 'API Locked' in other documents. For example: - `/doc/api/assert.markdown` - `/doc/api/util.markdown` This word was injected in 192192a.
2013-01-17 17:12:03 +08:00
Stability: 5 - Locked
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
Unless serious bugs are found, this code will not ever
Add 'about these docs' section
2012-02-28 03:06:14 +08:00
change. Please do not suggest changes in this area; they will be refused.
Colorize API stabilitity index headers in docs Noted in @shtylman's #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they're generated. The API headers with corresponding colors are also listed in the 'About this Documentation' page for easy reference.
2012-12-28 09:32:53 +08:00
```
doc: Document JSON docs
2012-03-04 07:51:14 +08:00
## JSON Output
Stability: 1 - Experimental
Every HTML file in the markdown has a corresponding JSON file with the
same data.
This feature is new as of node v0.6.12. It is experimental.