Replace JSDoc-Toolkit with doc.md

This commit is contained in:
Peter 'Pita' Martischka 2011-05-29 21:30:56 +01:00
parent b38b755c68
commit 7024f3e78a
130 changed files with 658 additions and 14913 deletions

View file

@ -0,0 +1,48 @@
#MessageHandler
`require("./MessageHandler");`
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
* Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
##Functions
###handleConnect (client)
Handles the connection of a new user
* **client** the new client
###handleDisconnect (client)
Handles the disconnection of a user
* **client** the client that leaves
###handleMessage (client, message)
Handles a message from a user
* **client** the client that send this message
* **message** the message from the client
###setSocketIO (socket_io)
Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka
* Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS-IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
* **socket_io** The Socket
##Variables