Skip to content

Instantly share code, notes, and snippets.

@koichik
Created April 28, 2011 07:39
Show Gist options
  • Select an option

  • Save koichik/945972 to your computer and use it in GitHub Desktop.

Select an option

Save koichik/945972 to your computer and use it in GitHub Desktop.
Doc improvements
From e3af71c3d1312ca9bd9d8425ba43848d9990aea8 Mon Sep 17 00:00:00 2001
From: koichik <koichik@improvement.jp>
Date: Thu, 28 Apr 2011 16:36:04 +0900
Subject: [PATCH] Doc improvements.
---
doc/api/http.markdown | 2 +-
doc/api/https.markdown | 10 +++++++++-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/doc/api/http.markdown b/doc/api/http.markdown
index 09efede..6cecc82 100644
--- a/doc/api/http.markdown
+++ b/doc/api/http.markdown
@@ -88,7 +88,7 @@ sent to the server on that socket.
If a client connection emits an 'error' event - it will forwarded here.
-### http.createServer(requestListener)
+### http.createServer([requestListener])
Returns a new web server object.
diff --git a/doc/api/https.markdown b/doc/api/https.markdown
index 3c6a7c4..ff383f7 100644
--- a/doc/api/https.markdown
+++ b/doc/api/https.markdown
@@ -4,7 +4,15 @@ HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a
separate module.
## https.Server
-## https.createServer
+
+This class is a subclass of `tls.Server` and emits events same as
+`http.Server`. See `http.Server` for more information.
+
+## https.createServer(options, [requestListener])
+
+Returns a new HTTPS web server object. The `options` is similer to
+`tls.createServer()`. The `requestListener` is a function which is
+automatically added to the `'request'` event.
Example:
--
1.7.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment