jens@2: //
jens@2: // maindocs.h
jens@2: // MYNetwork
jens@2: //
jens@2: // Created by Jens Alfke on 5/24/08.
jens@2: // Copyright 2008 Jens Alfke. All rights reserved.
jens@2: //
jens@2: // This file just contains the Doxygen comments that generate the main (index.html) page content.
jens@2:
jens@2:
jens@2: /*! \mainpage MYNetwork: Mooseyard Networking library, including BLIP protocol implementation.
jens@2:
jens@2: \section intro_sec Introduction
jens@2:
jens@2: MYNetwork is a set of Objective-C networking classes for Cocoa applications on Mac OS X.
jens@2: It consists of:
jens@2:
jens@2: - Networking utility classes (presently only IPAddress);
jens@2:
- A generic TCP client/server implementation,
jens@2: useful for implementing your own network protocols; (see TCPListener and TCPConnection)
jens@2:
- An implementation of BLIP, a lightweight network protocol I've invented as an easy way
jens@2: to send request and response messages between peers. (see BLIPListener, BLIPConnection, BLIPRequest, etc.)
jens@2:
jens@2:
jens@2: MYNetwork is released under a BSD license, which means you can freely use it in open-source
jens@2: or commercial projects, provided you give credit in your documentation or About box.
jens@2:
jens@2: \section config Configuration
jens@2:
jens@2: MYNetwork requires Mac OS X 10.5 or later, since it uses Objective-C 2 features like
jens@2: properties and for...in loops.
jens@2:
jens@2: MYNetwork uses my MYUtilities library. You'll need to have downloaded that library, and added
jens@2: the necessary source files and headers to your project. See the MYNetwork Xcode project,
jens@2: which contains the minimal set of MYUtilities files needed to build MYUtilities. (That project
jens@2: has its search paths set up to assume that MYUtilities is in a directory next to MYNetwork.)
jens@2:
jens@2: \section download How To Get It
jens@2:
jens@2:
jens@2:
jens@2: Or if you're just looking:
jens@2:
jens@2:
jens@2:
jens@2: */