Update of /cvsroot/wpdev/wolfpack/doc In directory sc8-pr-cvs1:/tmp/cvs-serv11294 Modified Files: doxygen.cfg indices.doc misc.doc modules.doc uorxpackets.doc Added Files: contribute.doc footer.html header.html trademarks.doc Log Message: Updated doxygen doc --- NEW FILE: contribute.doc --- //================================================================================== // // Wolfpack Emu (WP) // UO Server Emulation Program // // Copyright 1997, 98 by Marcus Rating (Cironian) // Copyright 2001 by holders identified in authors.txt // This program is free software; you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation; either version 2 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; if not, write to the Free Software // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. // // * In addition to that license, if you are running this program or modified // * versions of it on a public system you HAVE TO make the complete source of // * the version used by you available or provide people with a location to // * download it. // // // // Wolfpack Homepage: http://wpdev.sf.net/ //======================================================================================== /*! \page contribute.html How to contribute There is a multitude of things you can do depending on your skills: \li answering other people's posts. Every post we don't have to answer ourselves adds to the time we can spend on coding. \li create documentation. If you think it was hard to figure out how something works but now you know, write down your knowledge. \li scripting. Many of the settings in the scripts are not there because the scripters want them to be that way, but because nobody found the time to change them. \li use InsideUO. Looking up the hex-code for a missing sound, animation, item you request is easy but rather time-consuming. \li report bugs. If you experience something that you feel is a bug, take the time to report it, even if you found another solution. \li systematic testing. As opposed to reporting just the bugs you encounter while playing, testing means trying to get bugs. If you have at least a basic knowledge of C/C++ you can also \li make bugs reproducable \li use the debugger to find bugs \li provide bugfixes \li code small features \li do some revamping \li code big features \li help to redesign kernel subsystems \li do profiling and tuning (order of appearance marks difficulty in my humble opinion) Be careful to choose the task that is appropriate to your skill ! Example: If a newbie coder implements a feature in 5 days and an experienced dev spends a total of 5 hours to help him, the newbie will learn a lot and the dev will have fun helping him. But if the dev would have implemented the same feature himself, it might have taken only 2 hours. So this can not be considered a true contribution to Wolfpack. Rule of thumb: If you can do one of these tasks without any help from another dev, the next task in the list will probably be appropriate (needing just a few hints). */ --- NEW FILE: footer.html --- <p><address><hr><div align=center> <table width=100% cellspacing=0 border=0><tr> <td>Copyright © 2003 <a href="wolf.html">Wolfpack</a><td align=center><a href="trademarks.html">Trademarks</a> <td align=right><div align=right>Wolfpack 12.9.x</div> <tr> <td> <!-- Sourceforge Logo --> <a href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=38114&type=2" border="0" alt="SourceForge Logo"></a> </td> </tr> </table></div></address></body> </html> --- NEW FILE: header.html --- --- NEW FILE: trademarks.doc --- /*! \page trademarks.html Trademarks Linux® is a trademark of Linus Torvalds. All other products named in the documentation are trademarks of their respective owners. */ Index: doxygen.cfg =================================================================== RCS file: /cvsroot/wpdev/wolfpack/doc/doxygen.cfg,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** doxygen.cfg 26 Sep 2002 01:47:20 -0000 1.2 --- doxygen.cfg 7 Dec 2003 17:35:38 -0000 1.3 *************** *** 1,45 **** ! # Doxyfile 1.2.13-20020210 #--------------------------------------------------------------------------- ! # General configuration options #--------------------------------------------------------------------------- ! PROJECT_NAME = Wolfpack PROJECT_NUMBER = 12.9.0 OUTPUT_DIRECTORY = C:/wolfpack/wolfpack/doc/ OUTPUT_LANGUAGE = English ! EXTRACT_ALL = NO ! EXTRACT_PRIVATE = NO ! EXTRACT_STATIC = NO ! EXTRACT_LOCAL_CLASSES = YES ! HIDE_UNDOC_MEMBERS = NO ! HIDE_UNDOC_CLASSES = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = NO STRIP_FROM_PATH = - INTERNAL_DOCS = YES - STRIP_CODE_COMMENTS = YES - CASE_SENSE_NAMES = YES SHORT_NAMES = NO - HIDE_SCOPE_NAMES = NO - VERBATIM_HEADERS = YES - SHOW_INCLUDE_FILES = YES JAVADOC_AUTOBRIEF = NO DETAILS_AT_TOP = NO INHERIT_DOCS = YES - INLINE_INFO = YES - SORT_MEMBER_DOCS = YES DISTRIBUTE_GROUP_DOC = YES TAB_SIZE = 8 GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES ! ALIASES = ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 - OPTIMIZE_OUTPUT_FOR_C = NO - OPTIMIZE_OUTPUT_JAVA = NO SHOW_USED_FILES = YES #--------------------------------------------------------------------------- --- 1,53 ---- ! # Doxyfile 1.3.5 #--------------------------------------------------------------------------- ! # Project related configuration options #--------------------------------------------------------------------------- ! PROJECT_NAME = "Wolfpack Ultima Online Server Software" PROJECT_NUMBER = 12.9.0 OUTPUT_DIRECTORY = C:/wolfpack/wolfpack/doc/ OUTPUT_LANGUAGE = English ! USE_WINDOWS_ENCODING = YES BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES + ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO FULL_PATH_NAMES = NO STRIP_FROM_PATH = SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO + MULTILINE_CPP_IS_BRIEF = NO DETAILS_AT_TOP = NO INHERIT_DOCS = YES DISTRIBUTE_GROUP_DOC = YES TAB_SIZE = 8 + ALIASES = + OPTIMIZE_OUTPUT_FOR_C = NO + OPTIMIZE_OUTPUT_JAVA = NO + SUBGROUPING = YES + #--------------------------------------------------------------------------- + # Build related configuration options + #--------------------------------------------------------------------------- + EXTRACT_ALL = NO + EXTRACT_PRIVATE = NO + EXTRACT_STATIC = NO + EXTRACT_LOCAL_CLASSES = YES + HIDE_UNDOC_MEMBERS = NO + HIDE_UNDOC_CLASSES = NO + HIDE_FRIEND_COMPOUNDS = NO + HIDE_IN_BODY_DOCS = NO + INTERNAL_DOCS = YES + CASE_SENSE_NAMES = YES + HIDE_SCOPE_NAMES = NO + SHOW_INCLUDE_FILES = YES + INLINE_INFO = YES + SORT_MEMBER_DOCS = YES GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES ! GENERATE_DEPRECATEDLIST= YES ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES #--------------------------------------------------------------------------- *************** *** 49,52 **** --- 57,61 ---- WARNINGS = YES WARN_IF_UNDOCUMENTED = NO + WARN_IF_DOC_ERROR = YES WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = *************** *** 75,80 **** --- 84,91 ---- SOURCE_BROWSER = YES INLINE_SOURCES = YES + STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES + VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index *************** *** 94,97 **** --- 105,110 ---- HTML_ALIGN_MEMBERS = YES GENERATE_HTMLHELP = NO + CHM_FILE = + HHC_LOCATION = GENERATE_CHI = NO BINARY_TOC = NO *************** *** 115,118 **** --- 128,132 ---- USE_PDFLATEX = NO LATEX_BATCHMODE = NO + LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output *************** *** 135,138 **** --- 149,156 ---- #--------------------------------------------------------------------------- GENERATE_XML = NO + XML_OUTPUT = xml + XML_SCHEMA = + XML_DTD = + XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output *************** *** 140,143 **** --- 158,168 ---- GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- + # configuration options related to the Perl module output + #--------------------------------------------------------------------------- + GENERATE_PERLMOD = NO + PERLMOD_LATEX = NO + PERLMOD_PRETTY = YES + PERLMOD_MAKEVAR_PREFIX = + #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- *************** *** 167,173 **** --- 192,200 ---- CLASS_GRAPH = YES COLLABORATION_GRAPH = YES + UML_LOOK = YES TEMPLATE_RELATIONS = YES INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES + CALL_GRAPH = YES GRAPHICAL_HIERARCHY = YES DOT_IMAGE_FORMAT = png *************** *** 176,179 **** --- 203,207 ---- MAX_DOT_GRAPH_WIDTH = 1024 MAX_DOT_GRAPH_HEIGHT = 1024 + MAX_DOT_GRAPH_DEPTH = 0 GENERATE_LEGEND = YES DOT_CLEANUP = YES *************** *** 182,189 **** #--------------------------------------------------------------------------- SEARCHENGINE = NO - CGI_NAME = search.cgi - CGI_URL = - DOC_URL = - DOC_ABSPATH = - BIN_ABSPATH = /usr/local/bin/ - EXT_DOC_PATHS = --- 210,211 ---- Index: indices.doc =================================================================== RCS file: /cvsroot/wpdev/wolfpack/doc/indices.doc,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** indices.doc 17 Jun 2002 00:25:37 -0000 1.1 --- indices.doc 7 Dec 2003 17:35:38 -0000 1.2 *************** *** 31,43 **** /*! ! \page index.html Wolfpack Reference Documentation - \section general General - \li \link wolfpack.html About Wolfpack\endlink - \li \link bugreport.html How to report a bug\endlink - \section license License - \li \link gpl.html GNU General Public License\endlink */ --- 31,119 ---- /*! + \page index.html Wolfpack Source Reference Documentation ! <table cellpadding=2 cellspacing=1 border=0 width=100% bgcolor=#e5e5e5> ! <tr bgcolor=white> ! <td colspan=3 align=center> ! <b>Notice</b>: This document is intended for <b>developers</b> only</td></tr> ! <tr> ! <th bgcolor=#dae9a1 width=33%> ! Wolfpack Community ! </th> ! <th bgcolor=#dae9a1 width=33%> ! Getting Started ! </th> ! <th bgcolor=#dae9a1 width=33%> ! General ! </th> ! </tr> ! <tr> ! <td valign=top> ! \li \htmlonly <a class="el" href="http://sourceforge.net/mail/?group_id=38114">Mailing lists</a>\endhtmlonly ! \li \htmlonly <a class="el" href="http://wpdev.sourceforge.net/modules.php?op=modload&name=phpBB2&file=index">Forums</a>\endhtmlonly ! \li \link irc.html IRC Channel\endlink ! \li \link bugreport.html How to report a bug\endlink ! </td> ! <td valign=top> ! \li \link compile.html How to compile\endlink ! \li \link contribute.html How to contribute\endlink ! \li \link usingcvs.html Using CVS\endlink ! </td> ! <td valign=top> ! \li \link aboutwp.html About Wolfpack\endlink ! \li \link wolf.html About Developers\endlink ! \li \htmlonly <a class="el" href="http://sourceforge.net/cvs/?group_id=38114">Browse CVS</a>\endhtmlonly ! </td> ! </tr> ! <tr> ! <th bgcolor=#dae9a1> ! API Reference ! </th> ! <th bgcolor=#dae9a1> ! Modules ! <th bgcolor=#dae9a1> ! Overviews ! </tr> ! <tr> ! <td valign=top> ! \li \htmlonly <a class="el" href="classes.html">All Classes</a>\endhtmlonly ! \li \htmlonly <a class="el" href="annotated.html">Annotated Classes</a>\endhtmlonly ! \li \htmlonly <a class="el" href="hierarchy.html">Inheritance Hierarchy</a></li>\endhtmlonly ! \li \htmlonly <a class="el" href="functions.html"> All Functions (long)</a></li>\endhtmlonly ! \li \htmlonly <a class="el" href="files.html"> Source File Index</a></li>\endhtmlonly ! \li \link faq.html FAQs\endlink ! \li \htmlonly <a class="el" href="http://sourceforge.net/mailarchive/forum.php?forum_id=34457">Change History</a>\endhtmlonly ! </td> ! <td valign=top> ! \li \htmlonly <a class="el" href="modules.html">All Modules</a>\endhtmlonly ! \li \htmlonly <a class="el" href="group__network.html">Network Module</a>\endhtmlonly ! </td> ! <td valign=top> ! </tr> ! <tr> ! <th bgcolor=#dae9a1> ! Porting & Platforms ! </th> ! <th bgcolor=#dae9a1> ! Tools ! </th> ! <th bgcolor=#dae9a1> ! Licenses & Credits ! </th> ! </tr> ! <tr> ! <td valign=top> ! \li \link winsystem.html Windows specific notes\endlink ! </td> ! <td valign=top> ! </td> ! <td valign=top> ! \li \link gpl.html GNU General Public License\endlink ! \li \link credits.html Credits\endlink ! </td> ! </tr> ! </table> */ Index: misc.doc =================================================================== RCS file: /cvsroot/wpdev/wolfpack/doc/misc.doc,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** misc.doc 17 Jun 2002 00:25:37 -0000 1.1 --- misc.doc 7 Dec 2003 17:35:38 -0000 1.2 *************** *** 33,37 **** If you think you have found a bug in Wolfpack, we would like to hear about it so we can fix it. ! Before reporting a bug, please check the FAQs and Forums on our \link http://www.wpdev.org/ web site\endlink to see if the issue is already known. Always include the following information in your bug report: --- 33,37 ---- If you think you have found a bug in Wolfpack, we would like to hear about it so we can fix it. ! Before reporting a bug, please check the FAQs and Forums on our <a href="http://www.wpdev.org/">web site</a> to see if the issue is already known. Always include the following information in your bug report: *************** *** 43,54 **** ! Please send the bug report to BugTrack system at \link http://www.wpdev.org Wolfpack website\endlink. */ /*! \page gpl.html GNU General Public License ! The Wolfpack is Copyright (C) 1998-2002 Wolfpack Development Team. --- 43,58 ---- ! Please send the bug report to BugTrack system at \link http://www.wpdev.org/ Wolfpack website\endlink. */ + /*! \page irc.html IRC Channel + + Wolfpack users and developers can be found online on the #wolfpack channel at irc.stratics.com + */ /*! \page gpl.html GNU General Public License ! The Wolfpack is Copyright (C) 1998-2004 Wolfpack Development Team. Index: modules.doc =================================================================== RCS file: /cvsroot/wpdev/wolfpack/doc/modules.doc,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** modules.doc 30 Jun 2002 03:51:31 -0000 1.1 --- modules.doc 7 Dec 2003 17:35:38 -0000 1.2 *************** *** 1,4 **** /*! - \defgroup network Network Module --- 1,3 ---- *************** *** 9,13 **** /*! ! \defgroup mainclass This group contains the most important classes found in Wolfpack. --- 8,12 ---- /*! ! \defgroup mainclass Main Classes This group contains the most important classes found in Wolfpack. Index: uorxpackets.doc =================================================================== RCS file: /cvsroot/wpdev/wolfpack/doc/uorxpackets.doc,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** uorxpackets.doc 3 Jul 2002 03:34:16 -0000 1.3 --- uorxpackets.doc 7 Dec 2003 17:35:38 -0000 1.4 *************** *** 459,462 **** }; - #endif - --- 459,460 ---- |
