00001 ////////////////////////////////////////////////////////////////////////////// 00002 // hwapi.h - Hex Workshop API 00003 // 00004 // doxygen.h - Bootstrap for doxygen/Hex Workshop Plug-in API documentation 00005 // 00006 // This source code and information is provided "as is" without any warranty 00007 // of any kind, either expressed or implied, including but not limited to 00008 // the implied waranties of merchantability and/or fitness for a particular 00009 // purpose. 00010 // 00011 // Copyright (c) 2010 BreakPoint Software, Inc. All Rights Reserved. 00012 // 00013 ////////////////////////////////////////////////////////////////////////////// 00014 // 00015 /// 00016 #ifndef _DOXYGEN_H 00017 #define _DOXYGEN_H /* [ */ 00018 00019 /** 00020 * @mainpage Hex Workshop Plug-in Framework 00021 * 00022 * @htmlinclude plugin-overview.html 00023 * 00024 * @see entrypoints 00025 * @see common 00026 * @see document 00027 * @see editor 00028 * @see checksums 00029 * @see bookmarks 00030 * @see structures 00031 * @see logging 00032 * @see errors 00033 * 00034 * <h3>Examples</h3> 00035 * - @subpage SelectionExample demonstrates basic API usage 00036 * 00037 * @defgroup entrypoints Entrypoint Documentation 00038 * @defgroup common Common Types and Structures 00039 * @defgroup document Document Functions 00040 * @defgroup editor Editor Manipulation Functions 00041 * @defgroup checksums Checksum Functions 00042 * @defgroup bookmarks Bookmark Functions 00043 * @defgroup structures Structure Functions 00044 * @defgroup logging Logging Functions 00045 * @defgroup errors API Error Return Codes 00046 * 00047 * @page SelectionExample 00048 * 00049 * @include SelectionExample.cpp 00050 */ 00051 00052 #endif /* ] */