Permalink
Browse files

remove generated docs

  • Loading branch information...
tj committed Aug 1, 2012
1 parent 75debbe commit 5ed1544cabebdc742591293f47dc81a6a8494ebb
Showing with 1 addition and 1,025 deletions.
  1. +1 −13 Makefile
  2. +0 −181 docs/application.md
  3. +0 −506 docs/express.md
  4. +0 −107 docs/request.md
  5. +0 −218 docs/response.md
View
@@ -2,15 +2,6 @@
MOCHA_OPTS=
REPORTER = dot
-docs: docs/express.md
-
-docs/express.md: docs/application.md docs/request.md docs/response.md
- cat $^ > $@
-
-docs/%.md: lib/%.js
- @mkdir -p docs
- dox --raw < $< | ./support/docs > $@
-
check: test
test: test-unit test-acceptance
@@ -32,10 +23,7 @@ test-cov: lib-cov
lib-cov:
@jscoverage lib lib-cov
-docclean:
- rm -fr docs
-
benchmark:
@./support/bench
-.PHONY: docs docclean test test-unit test-acceptance benchmark
+.PHONY: test test-unit test-acceptance benchmark
View
@@ -1,181 +0,0 @@
-
-# app
-
- Application prototype.
-
-# app.use()
-
- Proxy `connect#use()` to apply settings to
- mounted applications.
-
-# app.engine()
-
- Register the given template engine callback `fn`
- as `ext`.
-
- By default will `require()` the engine based on the
- file extension. For example if you try to render
- a "foo.jade" file Express will invoke the following internally:
-
- app.engine('jade', require('jade').__express);
-
- For engines that do not provide `.__express` out of the box,
- or if you wish to "map" a different extension to the template engine
- you may use this method. For example mapping the EJS template engine to
- ".html" files
-
- app.engine('html', require('ejs').renderFile);
-
- In this case EJS provides a `.renderFile()` method with
- the same signature that Express expects: `(path, options, callback)`,
- though note that it aliases this method as `ejs.__express` internally
- so if you're using ".ejs" extensions you dont need to do anything.
-
- Some template engines do not follow this convention, the
- [Consolidate.js](https://github.com/visionmedia/consolidate.js)
- library was created to map all of node's popular template
- engines to follow this convention, thus allowing them to
- work seemlessly within Express.
-
-# app.param()
-
- Map the given param placeholder `name`(s) to the given callback(s).
-
- Parameter mapping is used to provide pre-conditions to routes
- which use normalized placeholders. For example a _:user_id_ parameter
- could automatically load a user's information from the database without
- any additional code,
-
- The callback uses the samesignature as middleware, the only differencing
- being that the value of the placeholder is passed, in this case the _id_
- of the user. Once the `next()` function is invoked, just like middleware
- it will continue on to execute the route, or subsequent parameter functions.
-
- app.param('user_id', function(req, res, next, id){
- User.find(id, function(err, user){
- if (err) {
- next(err);
- } else if (user) {
- req.user = user;
- next();
- } else {
- next(new Error('failed to load user'));
- }
- });
- });
-
-# app.set()
-
- Assign `setting` to `val`, or return `setting`'s value.
-
- app.set('foo', 'bar');
- app.get('foo');
- // => "bar"
-
- Mounted servers inherit their parent server's settings.
-
-# app.enabled()
-
- Check if `setting` is enabled (truthy).
-
- app.enabled('foo')
- // => false
-
- app.enable('foo')
- app.enabled('foo')
- // => true
-
-# app.disabled()
-
- Check if `setting` is disabled.
-
- app.disabled('foo')
- // => true
-
- app.enable('foo')
- app.disabled('foo')
- // => false
-
-# app.enable()
-
- Enable `setting`.
-
-# app.disable()
-
- Disable `setting`.
-
-# app.configure()
-
- Configure callback for zero or more envs,
- when no `env` is specified that callback will
- be invoked for all environments. Any combination
- can be used multiple times, in any order desired.
-
- ## Examples
-
- app.configure(function(){
- // executed for all envs
- });
-
- app.configure('stage', function(){
- // executed staging env
- });
-
- app.configure('stage', 'production', function(){
- // executed for stage and production
- });
-
- ## Note
-
- These callbacks are invoked immediately, and
- are effectively sugar for the following.
-
- var env = process.env.NODE_ENV || 'development';
-
- switch (env) {
- case 'development':
- ...
- break;
- case 'stage':
- ...
- break;
- case 'production':
- ...
- break;
- }
-
-# app.all()
-
- Special-cased "all" method, applying the given route `path`,
- middleware, and callback to _every_ HTTP method.
-
-# app.render()
-
- Render the given view `name` name with `options`
- and a callback accepting an error and the
- rendered template string.
-
- ## Example
-
- app.render('email', { name: 'Tobi' }, function(err, html){
- // ...
- })
-
-# app.listen()
-
- Listen for connections.
-
- A node `http.Server` is returned, with this
- application (which is a `Function`) as its
- callback. If you wish to create both an HTTP
- and HTTPS server you may do so with the "http"
- and "https" modules as shown here.
-
- var http = require('http')
- , https = require('https')
- , express = require('express')
- , app = express();
-
- http.createServer(app).listen(80);
- http.createServer({ ... }, app).listen(443);
-
Oops, something went wrong.

0 comments on commit 5ed1544

Please sign in to comment.