diff -r 000000000000 -r 39fec79de6e8 maindocs.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/maindocs.h Sun Jun 07 21:53:56 2009 -0700 @@ -0,0 +1,53 @@ +// +// maindocs.h +// MYCrypto +// +// Created by Jens Alfke on 4/06/09. +// Copyright 2009 Jens Alfke. All rights reserved. +// +// This file just contains the Doxygen comments that generate the main (index.html) page content. + + +/*! \mainpage MYCrypto: Mooseyard Cryptography Library + +
By Jens Alfke
+ +\section intro_sec Introduction + + MYCrypto is a set of Objective-C cryptography classes for Cocoa applications on Mac OS X and iPhone. + + Browse the class documentation. + +\section license License + + MYCrypto is released under a BSD license, which means you can freely use it in open-source + or commercial projects, provided you give credit in your documentation or About box. + +\section config Configuration + + MYCrypto requires Mac OS X 10.5 or later, since it uses Objective-C 2 features like + properties and for...in loops. + + MYCrypto uses my MYUtilities library. You'll need to have downloaded that library, and added + the necessary source files and headers to your project. See the MYCrypto Xcode project, + which contains the minimal set of MYUtilities files needed to build MYUtilities. (That project + has its search paths set up to assume that MYUtilities is in a directory next to MYCrypto.) + +\section download How To Get It + + + + Or if you're just looking: + + + + */