maindocs.h
changeset 7 5936db2c1987
parent 4 2bd9d60a2c46
child 8 6f539dd9921c
     1.1 --- a/maindocs.h	Sun May 25 10:28:26 2008 -0700
     1.2 +++ b/maindocs.h	Sun May 25 13:43:03 2008 -0700
     1.3 @@ -8,7 +8,9 @@
     1.4  // This file just contains the Doxygen comments that generate the main (index.html) page content.
     1.5  
     1.6  
     1.7 -/*! \mainpage MYNetwork: Mooseyard Networking library, including BLIP protocol implementation. 
     1.8 +/*! \mainpage MYNetwork: Mooseyard Networking Library, With BLIP Protocol Implementation
     1.9 + 
    1.10 +    <center><b>By <a href="/Jens/">Jens Alfke</a></b></center>
    1.11   
    1.12  \section intro_sec Introduction
    1.13   
    1.14 @@ -18,12 +20,22 @@
    1.15      <li>Networking utility classes (presently only IPAddress);
    1.16      <li>A generic TCP client/server implementation,
    1.17          useful for implementing your own network protocols; (see TCPListener and TCPConnection)
    1.18 -    <li>An implementation of BLIP, a lightweight network protocol I've invented as an easy way
    1.19 +    <li>An implementation of <a href="#blipdesc">BLIP</a>, a lightweight network protocol I've invented as an easy way
    1.20          to send request and response messages between peers. (see BLIPListener, BLIPConnection, BLIPRequest, etc.)
    1.21      </ul>
    1.22   
    1.23 -    MYNetwork is released under a BSD license, which means you can freely use it in open-source
    1.24 -    or commercial projects, provided you give credit in your documentation or About box.
    1.25 +\section license License and Disclaimer
    1.26 + 
    1.27 + MYNetwork is released under a BSD license, which means you can freely use it in open-source
    1.28 + or commercial projects, provided you give credit in your documentation or About box.
    1.29 + 
    1.30 + As I write this (May 2008), MYNetwork is still very much under development. I am using it as the foundation of my own commercial products, at least one of which is currently at about the alpha stage. I'm making changes to this code as I see fit, fairly often.
    1.31 + 
    1.32 +That's good, in that the code is getting real-world use. But it also means that APIs and functionality are subject to change. (Of course, the entire revision tree is always available, so you're free to stick with any revision you like, and even "cherry-pick" desired changes from future ones.)
    1.33 + 
    1.34 +Not all of this code gets thoroughly exercised by my test cases or my applications, so some things may not work. Obviously, this code comes with no warranty nor any guarantee of tech support, though I will try to do my best to help out. Hopefully the source code is clear enough to let you figure out what's going on.
    1.35 + 
    1.36 +If you come across bugs, please tell me about them. If you fix them, I would love to get your fixes and incorporate them. If you add features I would love to know about them, and I will incorporate them if I think they make sense for the project. Thanks!
    1.37  
    1.38  \section blipdesc What's BLIP?
    1.39   
    1.40 @@ -31,7 +43,7 @@
    1.41   
    1.42  BLIP was inspired by <a
    1.43  href="http://beepcore.org">BEEP</a> (in fact BLIP stands for "BEEP-LIke Protocol") but is
    1.44 -deliberately simpler and somewhat more limited. That translates to a smaller and cleaner implemenation, especially since it takes advantage of Cocoa's and CFNetwork's existing support for network streams, SSL and Bonjour.
    1.45 +deliberately simpler and somewhat more limited. That results in a smaller and cleaner implementation, especially since it takes advantage of Cocoa's and CFNetwork's existing support for network streams, SSL and Bonjour. (BLIP is currently a bit under 2,000 lines of code, and the rest of the MYNetwork classes it builds on add up to another 1,500. That's at least an order of magnitude smaller than existing native-code BEEP libraries.)
    1.46   
    1.47  \subsection blipfeatures BLIP Features:
    1.48