large commit. documented a bit. editor updates. general cleanup of everything

10 files changed, 394 insertions, 0 deletions

diff --git a/docs/conf/Data/ClassHierarchy.nd b/docs/conf/Data/ClassHierarchy.nd
new file mode 100644
index 00000000..c541d655
--- /dev/null
+++ b/docs/conf/Data/ClassHierarchy.nd
Binary files differdiff --git a/docs/conf/Data/ConfigFileInfo.nd b/docs/conf/Data/ConfigFileInfo.nd
new file mode 100644
index 00000000..63dab0d0
--- /dev/null
+++ b/docs/conf/Data/ConfigFileInfo.nd
@@ -0,0 +1 @@
+
#G‘ÖùG‘ITG‘ITG‘ITG‘IT
\ No newline at end of file
diff --git a/docs/conf/Data/FileInfo.nd b/docs/conf/Data/FileInfo.nd
new file mode 100644
index 00000000..70e121f3
--- /dev/null
+++ b/docs/conf/Data/FileInfo.nd
@@ -0,0 +1,51 @@
+1.35
+C/C++
+/home/kma/code/teewars/trunk/src/engine/e_memheap.h	1197706562	0	/home/kma/code/teewars/trunk/src/engine/e_memheap.h
+/home/kma/code/teewars/trunk/src/engine/client/ec_font.h	1200146774	0	/home/kma/code/teewars/trunk/src/engine/client/ec_font.h
+/home/kma/code/teewars/trunk/src/engine/e_console.c	1200611479	0	/home/kma/code/teewars/trunk/src/engine/e_console.c
+/home/kma/code/teewars/trunk/src/engine/e_if_modc.h	1200736124	1	Client Hooks
+/home/kma/code/teewars/trunk/src/engine/e_protocol.h	1197711693	0	/home/kma/code/teewars/trunk/src/engine/e_protocol.h
+/home/kma/code/teewars/trunk/src/engine/client/ec_inp.c	1200709481	0	/home/kma/code/teewars/trunk/src/engine/client/ec_inp.c
+/home/kma/code/teewars/trunk/src/engine/e_memheap.c	1197707815	0	/home/kma/code/teewars/trunk/src/engine/e_memheap.c
+/home/kma/code/teewars/trunk/src/engine/e_if_snd.h	1200736177	1	Sound
+/home/kma/code/teewars/trunk/src/engine/e_keynames.c	1197706547	0	/home/kma/code/teewars/trunk/src/engine/e_keynames.c
+/home/kma/code/teewars/trunk/src/engine/e_system.h	1197707754	1	/home/kma/code/teewars/trunk/src/engine/e_system.h
+/home/kma/code/teewars/trunk/src/engine/e_if_client.h	1200739934	1	Constants
+/home/kma/code/teewars/trunk/src/engine/e_if_gfx.h	1200736418	1	Structures
+/home/kma/code/teewars/trunk/src/engine/e_server_interface.h	1200739892	0	/home/kma/code/teewars/trunk/src/engine/e_server_interface.h
+/home/kma/code/teewars/trunk/src/engine/e_if_msg.h	1200736131	1	Messaging
+/home/kma/code/teewars/trunk/src/engine/e_msg.c	1200708999	0	/home/kma/code/teewars/trunk/src/engine/e_msg.c
+/home/kma/code/teewars/trunk/src/engine/server/es_server.c	1200709433	0	/home/kma/code/teewars/trunk/src/engine/server/es_server.c
+/home/kma/code/teewars/trunk/src/engine/client/ec_font.c	1200146774	0	/home/kma/code/teewars/trunk/src/engine/client/ec_font.c
+/home/kma/code/teewars/trunk/src/engine/docs/client_time.txt	1200739319	1	Time on the client
+/home/kma/code/teewars/trunk/src/engine/e_engine.c	1200708926	0	/home/kma/code/teewars/trunk/src/engine/e_engine.c
+/home/kma/code/teewars/trunk/src/engine/e_system.c	1200521738	0	/home/kma/code/teewars/trunk/src/engine/e_system.c
+/home/kma/code/teewars/trunk/src/engine/e_snapshot.h	1197707840	0	/home/kma/code/teewars/trunk/src/engine/e_snapshot.h
+/home/kma/code/teewars/trunk/src/engine/e_client_interface.h	1200739926	0	/home/kma/code/teewars/trunk/src/engine/e_client_interface.h
+/home/kma/code/teewars/trunk/src/engine/e_if_mods.h	1200736122	1	Server Hooks
+/home/kma/code/teewars/trunk/src/engine/client/ec_client.c	1200709471	0	/home/kma/code/teewars/trunk/src/engine/client/ec_client.c
+/home/kma/code/teewars/trunk/src/engine/client/ec_srvbrowse.c	1200709484	0	/home/kma/code/teewars/trunk/src/engine/client/ec_srvbrowse.c
+/home/kma/code/teewars/trunk/src/engine/e_detect.h	1197706565	0	/home/kma/code/teewars/trunk/src/engine/e_detect.h
+/home/kma/code/teewars/trunk/src/engine/e_compression.c	1197707819	0	/home/kma/code/teewars/trunk/src/engine/e_compression.c
+/home/kma/code/teewars/trunk/src/engine/e_config.c	1200521738	0	/home/kma/code/teewars/trunk/src/engine/e_config.c
+/home/kma/code/teewars/trunk/src/engine/e_packer.h	1197706544	0	/home/kma/code/teewars/trunk/src/engine/e_packer.h
+/home/kma/code/teewars/trunk/src/engine/e_config_variables.h	1200222141	0	/home/kma/code/teewars/trunk/src/engine/e_config_variables.h
+/home/kma/code/teewars/trunk/src/engine/e_map.c	1200169662	0	/home/kma/code/teewars/trunk/src/engine/e_map.c
+/home/kma/code/teewars/trunk/src/engine/e_if_server.h	1200736134	1	Server Hooks
+/home/kma/code/teewars/trunk/src/engine/e_network.h	1198020654	0	/home/kma/code/teewars/trunk/src/engine/e_network.h
+/home/kma/code/teewars/trunk/src/engine/e_packer.c	1197707860	0	/home/kma/code/teewars/trunk/src/engine/e_packer.c
+/home/kma/code/teewars/trunk/src/engine/e_config.h	1200521738	0	/home/kma/code/teewars/trunk/src/engine/e_config.h
+/home/kma/code/teewars/trunk/src/engine/e_keys.h	1197706560	0	/home/kma/code/teewars/trunk/src/engine/e_keys.h
+/home/kma/code/teewars/trunk/src/engine/docs/prediction.txt	1200739838	1	Prediction
+/home/kma/code/teewars/trunk/src/engine/e_datafile.h	1200146774	0	/home/kma/code/teewars/trunk/src/engine/e_datafile.h
+/home/kma/code/teewars/trunk/src/engine/e_engine.h	1197706566	0	/home/kma/code/teewars/trunk/src/engine/e_engine.h
+/home/kma/code/teewars/trunk/src/engine/e_snapshot.c	1200708962	0	/home/kma/code/teewars/trunk/src/engine/e_snapshot.c
+/home/kma/code/teewars/trunk/src/engine/e_compression.h	1197706556	0	/home/kma/code/teewars/trunk/src/engine/e_compression.h
+/home/kma/code/teewars/trunk/src/engine/e_console.h	1200611479	0	/home/kma/code/teewars/trunk/src/engine/e_console.h
+/home/kma/code/teewars/trunk/src/engine/client/ec_snd.c	1200709488	0	/home/kma/code/teewars/trunk/src/engine/client/ec_snd.c
+/home/kma/code/teewars/trunk/src/engine/e_common_interface.h	1200739880	0	/home/kma/code/teewars/trunk/src/engine/e_common_interface.h
+/home/kma/code/teewars/trunk/src/engine/e_network.c	1198110343	0	/home/kma/code/teewars/trunk/src/engine/e_network.c
+/home/kma/code/teewars/trunk/src/engine/e_if_inp.h	1200736117	1	Input
+/home/kma/code/teewars/trunk/src/engine/e_if_other.h	1200739887	1	Engine Interface
+/home/kma/code/teewars/trunk/src/engine/e_datafile.c	1200146774	0	/home/kma/code/teewars/trunk/src/engine/e_datafile.c
+/home/kma/code/teewars/trunk/src/engine/client/ec_gfx.c	1200709490	0	/home/kma/code/teewars/trunk/src/engine/client/ec_gfx.c
diff --git a/docs/conf/Data/PreviousMenuState.nd b/docs/conf/Data/PreviousMenuState.nd
new file mode 100644
index 00000000..1380d18b
--- /dev/null
+++ b/docs/conf/Data/PreviousMenuState.nd
Binary files differdiff --git a/docs/conf/Data/PreviousSettings.nd b/docs/conf/Data/PreviousSettings.nd
new file mode 100644
index 00000000..b397c128
--- /dev/null
+++ b/docs/conf/Data/PreviousSettings.nd
Binary files differdiff --git a/docs/conf/Data/SymbolTable.nd b/docs/conf/Data/SymbolTable.nd
new file mode 100644
index 00000000..29841a27
--- /dev/null
+++ b/docs/conf/Data/SymbolTable.nd
Binary files differdiff --git a/docs/conf/Languages.txt b/docs/conf/Languages.txt
new file mode 100644
index 00000000..aa9ce802
--- /dev/null
+++ b/docs/conf/Languages.txt
@@ -0,0 +1,113 @@
+Format: 1.35
+
+# This is the Natural Docs languages file for this project.  If you change
+# anything here, it will apply to THIS PROJECT ONLY.  If you'd like to change
+# something for all your projects, edit the Languages.txt in Natural Docs'
+# Config directory instead.
+
+
+# You can prevent certain file extensions from being scanned like this:
+# Ignore Extensions: [extension] [extension] ...
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Unlike other Natural Docs configuration files, in this file all comments
+# MUST be alone on a line.  Some languages deal with the # character, so you
+# cannot put comments on the same line as content.
+#
+# Also, all lists are separated with spaces, not commas, again because some
+# languages may need to use them.
+#
+# Language: [name]
+# Alter Language: [name]
+#    Defines a new language or alters an existing one.  Its name can use any
+#    characters.  If any of the properties below have an add/replace form, you
+#    must use that when using Alter Language.
+#
+#    The language Shebang Script is special.  It's entry is only used for
+#    extensions, and files with those extensions have their shebang (#!) lines
+#    read to determine the real language of the file.  Extensionless files are
+#    always treated this way.
+#
+#    The language Text File is also special.  It's treated as one big comment
+#    so you can put Natural Docs content in them without special symbols.  Also,
+#    if you don't specify a package separator, ignored prefixes, or enum value
+#    behavior, it will copy those settings from the language that is used most
+#    in the source tree.
+#
+# Extensions: [extension] [extension] ...
+# [Add/Replace] Extensions: [extension] [extension] ...
+#    Defines the file extensions of the language's source files.  You can
+#    redefine extensions found in the main languages file.  You can use * to
+#    mean any undefined extension.
+#
+# Shebang Strings: [string] [string] ...
+# [Add/Replace] Shebang Strings: [string] [string] ...
+#    Defines a list of strings that can appear in the shebang (#!) line to
+#    designate that it's part of the language.  You can redefine strings found
+#    in the main languages file.
+#
+# Ignore Prefixes in Index: [prefix] [prefix] ...
+# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
+#
+# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ...
+# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ...
+#    Specifies prefixes that should be ignored when sorting symbols in an
+#    index.  Can be specified in general or for a specific topic type.
+#
+#------------------------------------------------------------------------------
+# For basic language support only:
+#
+# Line Comments: [symbol] [symbol] ...
+#    Defines a space-separated list of symbols that are used for line comments,
+#    if any.
+#
+# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
+#    Defines a space-separated list of symbol pairs that are used for block
+#    comments, if any.
+#
+# Package Separator: [symbol]
+#    Defines the default package separator symbol.  The default is a dot.
+#
+# [Topic Type] Prototype Enders: [symbol] [symbol] ...
+#    When defined, Natural Docs will attempt to get a prototype from the code
+#    immediately following the topic type.  It stops when it reaches one of
+#    these symbols.  Use \n for line breaks.
+#
+# Line Extender: [symbol]
+#    Defines the symbol that allows a prototype to span multiple lines if
+#    normally a line break would end it.
+#
+# Enum Values: [global|under type|under parent]
+#    Defines how enum values are referenced.  The default is global.
+#    global       - Values are always global, referenced as 'value'.
+#    under type   - Values are under the enum type, referenced as
+#               'package.enum.value'.
+#    under parent - Values are under the enum's parent, referenced as
+#               'package.value'.
+#
+# Perl Package: [perl package]
+#    Specifies the Perl package used to fine-tune the language behavior in ways
+#    too complex to do in this file.
+#
+#------------------------------------------------------------------------------
+# For full language support only:
+#
+# Full Language Support: [perl package]
+#    Specifies the Perl package that has the parsing routines necessary for full
+#    language support.
+#
+#-------------------------------------------------------------------------------
+
+# The following languages are defined in the main file, if you'd like to alter
+# them:
+#
+#    Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python,
+#    PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile,
+#    ActionScript, ColdFusion, R, Fortran
+
+# If you add a language that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# languages [at] naturaldocs [dot] org.
diff --git a/docs/conf/Menu.txt b/docs/conf/Menu.txt
new file mode 100644
index 00000000..e3d50ddb
--- /dev/null
+++ b/docs/conf/Menu.txt
@@ -0,0 +1,79 @@
+Format: 1.35
+
+
+# You can add a title and sub-title to your menu like this:
+# Title: [project name]
+# SubTitle: [subtitle]
+
+# You can add a footer to your documentation like this:
+# Footer: [text]
+# If you want to add a copyright notice, this would be the place to do it.
+
+
+# --------------------------------------------------------------------------
+# 
+# Cut and paste the lines below to change the order in which your files
+# appear on the menu.  Don't worry about adding or removing files, Natural
+# Docs will take care of that.
+# 
+# You can further organize the menu by grouping the entries.  Add a
+# "Group: [name] {" line to start a group, and add a "}" to end it.
+# 
+# You can add text and web links to the menu by adding "Text: [text]" and
+# "Link: [name] ([URL])" lines, respectively.
+# 
+# The formatting and comments are auto-generated, so don't worry about
+# neatness when editing the file.  Natural Docs will clean it up the next
+# time it is run.  When working with groups, just deal with the braces and
+# forget about the indentation and comments.
+# 
+# --------------------------------------------------------------------------
+
+
+Group: Articles  {
+
+   File: Prediction  (docs/prediction.txt)
+   File: Time on the client  (docs/client_time.txt)
+   }  # Group: Articles
+
+Group: Reference  {
+
+   File: Lowlevel Library  (no auto-title, e_system.h)
+
+   Group: Common Interface  {
+
+      File: Engine Interface  (e_if_other.h)
+      File: Message Packing  (no auto-title, e_if_msg.h)
+      }  # Group: Common Interface
+
+   Group: Client Interface  {
+
+      File: General  (no auto-title, e_if_client.h)
+      File: Sound  (no auto-title, e_if_snd.h)
+      File: Input  (no auto-title, e_if_inp.h)
+      File: Graphics  (no auto-title, e_if_gfx.h)
+      }  # Group: Client Interface
+
+   Group: Server Interface  {
+
+      File: General  (no auto-title, e_if_server.h)
+      }  # Group: Server Interface
+
+   Group: Mod Hooks  {
+
+      File: Client Side  (no auto-title, e_if_modc.h)
+      File: Server Side  (no auto-title, e_if_mods.h)
+      }  # Group: Mod Hooks
+
+   }  # Group: Reference
+
+Group: Index  {
+
+   Index: Everything
+   Constant Index: Constants
+   File Index: Files
+   Function Index: Functions
+   Class Index: Classes
+   Variable Index: Variables
+   }  # Group: Index
+
diff --git a/docs/conf/Menu_Backup.txt b/docs/conf/Menu_Backup.txt
new file mode 100644
index 00000000..bbd7f561
--- /dev/null
+++ b/docs/conf/Menu_Backup.txt
@@ -0,0 +1,66 @@
+Format: 1.35
+
+
+# You can add a title and sub-title to your menu like this:
+# Title: [project name]
+# SubTitle: [subtitle]
+
+# You can add a footer to your documentation like this:
+# Footer: [text]
+# If you want to add a copyright notice, this would be the place to do it.
+
+
+# --------------------------------------------------------------------------
+# 
+# Cut and paste the lines below to change the order in which your files
+# appear on the menu.  Don't worry about adding or removing files, Natural
+# Docs will take care of that.
+# 
+# You can further organize the menu by grouping the entries.  Add a
+# "Group: [name] {" line to start a group, and add a "}" to end it.
+# 
+# You can add text and web links to the menu by adding "Text: [text]" and
+# "Link: [name] ([URL])" lines, respectively.
+# 
+# The formatting and comments are auto-generated, so don't worry about
+# neatness when editing the file.  Natural Docs will clean it up the next
+# time it is run.  When working with groups, just deal with the braces and
+# forget about the indentation and comments.
+# 
+# --------------------------------------------------------------------------
+
+
+File: e_system.h  (e_system.h)
+File: Engine Interface  (e_interface.h)
+
+Group: External  {
+
+   Group: Glfw  {
+
+      File: Does this work?  (external/glfw/lib/x11/x11_window.c)
+      File: glfw.h  (external/glfw/include/GL/glfw.h)
+      File: lib/win32/win32_window.c  (external/glfw/lib/win32/win32_window.c)
+      File: Only Linux joystick input is supported at the moment. Other  (external/glfw/lib/x11/x11_joystick.c)
+      File: Some compilers complains about hinst and x never being used -  (external/glfw/lib/win32/win32_dllmain.c)
+      }  # Group: Glfw
+
+   File: pnglite/pnglite.h  (external/pnglite/pnglite.h)
+
+   Group: Portaudio  {
+
+      File: for the default AudioUnit, we could use the  (external/portaudio/pa_mac_core.c)
+      File: make sure this validation list is kept syncronised with the one in  (external/portaudio/pa_front.c)
+      File: this code depends on the sample format constants being in  (external/portaudio/pa_converters.c)
+      }  # Group: Portaudio
+
+   File: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4  (external/zlib/deflate.c)
+   }  # Group: External
+
+Group: Index  {
+
+   Index: Everything
+   File Index: Files
+   Function Index: Functions
+   Variable Index: Variables
+   }  # Group: Index
+
diff --git a/docs/conf/Topics.txt b/docs/conf/Topics.txt
new file mode 100644
index 00000000..ee15ec83
--- /dev/null
+++ b/docs/conf/Topics.txt
@@ -0,0 +1,84 @@
+Format: 1.35
+
+# This is the Natural Docs topics file for this project.  If you change anything
+# here, it will apply to THIS PROJECT ONLY.  If you'd like to change something
+# for all your projects, edit the Topics.txt in Natural Docs' Config directory
+# instead.
+
+
+# If you'd like to prevent keywords from being recognized by Natural Docs, you
+# can do it like this:
+# Ignore Keywords: [keyword], [keyword], ...
+#
+# Or you can use the list syntax like how they are defined:
+# Ignore Keywords:
+#    [keyword]
+#    [keyword], [plural keyword]
+#    ...
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Topic Type: [name]
+# Alter Topic Type: [name]
+#    Creates a new topic type or alters one from the main file.  Each type gets
+#    its own index and behavior settings.  Its name can have letters, numbers,
+#    spaces, and these charaters: - / . '
+#
+# Plural: [name]
+#    Sets the plural name of the topic type, if different.
+#
+# Keywords:
+#    [keyword]
+#    [keyword], [plural keyword]
+#    ...
+#    Defines or adds to the list of keywords for the topic type.  They may only
+#    contain letters, numbers, and spaces and are not case sensitive.  Plural
+#    keywords are used for list topics.  You can redefine keywords found in the
+#    main topics file.
+#
+# Index: [yes|no]
+#    Whether the topics get their own index.  Defaults to yes.  Everything is
+#    included in the general index regardless of this setting.
+#
+# Scope: [normal|start|end|always global]
+#    How the topics affects scope.  Defaults to normal.
+#    normal        - Topics stay within the current scope.
+#    start         - Topics start a new scope for all the topics beneath it,
+#                    like class topics.
+#    end           - Topics reset the scope back to global for all the topics
+#                    beneath it.
+#    always global - Topics are defined as global, but do not change the scope
+#                    for any other topics.
+#
+# Class Hierarchy: [yes|no]
+#    Whether the topics are part of the class hierarchy.  Defaults to no.
+#
+# Variable Type: [yes|no]
+#    Whether the topics can be a variable type.  Defaults to no.
+#
+# Page Title If First: [yes|no]
+#    Whether the topic's title becomes the page title if it's the first one in
+#    a file.  Defaults to no.
+#
+# Break Lists: [yes|no]
+#    Whether list topics should be broken into individual topics in the output.
+#    Defaults to no.
+#
+# Can Group With: [type], [type], ...
+#    Defines a list of topic types that this one can possibly be grouped with.
+#    Defaults to none.
+#-------------------------------------------------------------------------------
+
+# The following topics are defined in the main file, if you'd like to alter
+# their behavior or add keywords:
+#
+#    Generic, Class, Interface, Section, File, Group, Function, Variable,
+#    Property, Type, Constant, Enumeration, Event, Delegate, Macro,
+#    Database, Database Table, Database View, Database Index, Database
+#    Cursor, Database Trigger, Cookie, Build Target
+
+# If you add something that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# topics [at] naturaldocs [dot] org.