diff options
| author | Magnus Auvinen <magnus.auvinen@gmail.com> | 2008-07-08 09:07:21 +0000 |
|---|---|---|
| committer | Magnus Auvinen <magnus.auvinen@gmail.com> | 2008-07-08 09:07:21 +0000 |
| commit | a13b94f9e0bca8ea892311d9d9e0c0bc48616ea7 (patch) | |
| tree | c74b01682d62d8a5e13948a828307f263de36ac6 /docs | |
| parent | 9d632dd826c8a312095de0f56df66b2580d336cb (diff) | |
| download | zcatch-a13b94f9e0bca8ea892311d9d9e0c0bc48616ea7.tar.gz zcatch-a13b94f9e0bca8ea892311d9d9e0c0bc48616ea7.zip | |
minor update
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf/Languages.txt | 2 | ||||
| -rw-r--r-- | docs/conf/Menu.txt | 83 | ||||
| -rw-r--r-- | docs/conf/Topics.txt | 5 |
3 files changed, 58 insertions, 32 deletions
diff --git a/docs/conf/Languages.txt b/docs/conf/Languages.txt index aa9ce802..be96913f 100644 --- a/docs/conf/Languages.txt +++ b/docs/conf/Languages.txt @@ -1,4 +1,4 @@ -Format: 1.35 +Format: 1.4 # 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 diff --git a/docs/conf/Menu.txt b/docs/conf/Menu.txt index e3d50ddb..cce70808 100644 --- a/docs/conf/Menu.txt +++ b/docs/conf/Menu.txt @@ -1,4 +1,4 @@ -Format: 1.35 +Format: 1.4 # You can add a title and sub-title to your menu like this: @@ -9,6 +9,22 @@ Format: 1.35 # Footer: [text] # If you want to add a copyright notice, this would be the place to do it. +# You can add a timestamp to your documentation like one of these: +# Timestamp: Generated on month day, year +# Timestamp: Updated mm/dd/yyyy +# Timestamp: Last updated mon day +# +# m - One or two digit month. January is "1" +# mm - Always two digit month. January is "01" +# mon - Short month word. January is "Jan" +# month - Long month word. January is "January" +# d - One or two digit day. 1 is "1" +# dd - Always two digit day. 1 is "01" +# day - Day with letter extension. 1 is "1st" +# yy - Two digit year. 2006 is "06" +# yyyy - Four digit year. 2006 is "2006" +# year - Four digit year. 2006 is "2006" + # -------------------------------------------------------------------------- # @@ -27,53 +43,66 @@ Format: 1.35 # time it is run. When working with groups, just deal with the braces and # forget about the indentation and comments. # +# You can use this file on other computers even if they use different +# directories. As long as the command line points to the same source files, +# Natural Docs will be able to correct the locations automatically. +# # -------------------------------------------------------------------------- -Group: Articles { +File: OS Abstraction (/home/kma/code/teeworlds/trunk/src/engine/e_system.h) + +Group: Engine { + + Group: Overview { - File: Prediction (docs/prediction.txt) - File: Time on the client (docs/client_time.txt) - } # Group: Articles + File: Time on the client (/home/kma/code/teeworlds/trunk/src/engine/docs/client_time.txt) + File: Prediction (/home/kma/code/teeworlds/trunk/src/engine/docs/prediction.txt) + } # Group: Overview -Group: Reference { + Group: Reference { - File: Lowlevel Library (no auto-title, e_system.h) + Group: Common { - Group: Common Interface { + File: Engine Interface (/home/kma/code/teeworlds/trunk/src/engine/e_if_other.h) + File: Messaging (/home/kma/code/teeworlds/trunk/src/engine/e_if_msg.h) + } # Group: Common - File: Engine Interface (e_if_other.h) - File: Message Packing (no auto-title, e_if_msg.h) - } # Group: Common Interface + Group: Client { - Group: Client Interface { + File: Client Hooks (/home/kma/code/teeworlds/trunk/src/engine/e_if_modc.h) + File: Client Interface (/home/kma/code/teeworlds/trunk/src/engine/e_if_client.h) + File: Graphics (/home/kma/code/teeworlds/trunk/src/engine/e_if_gfx.h) + File: Input (/home/kma/code/teeworlds/trunk/src/engine/e_if_inp.h) + File: Sound (/home/kma/code/teeworlds/trunk/src/engine/e_if_snd.h) + } # Group: Client - 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 { - Group: Server Interface { + File: Server Hooks (/home/kma/code/teeworlds/trunk/src/engine/e_if_mods.h) + File: Server Interface (/home/kma/code/teeworlds/trunk/src/engine/e_if_server.h) + } # Group: Server - File: General (no auto-title, e_if_server.h) - } # Group: Server Interface + } # Group: Reference - Group: Mod Hooks { + } # Group: Engine - File: Client Side (no auto-title, e_if_modc.h) - File: Server Side (no auto-title, e_if_mods.h) - } # Group: Mod Hooks +Group: Game Implementation { - } # Group: Reference + File: Entity (/home/kma/code/teeworlds/trunk/src/game/server/gs_common.hpp) + } # Group: Game Implementation Group: Index { Index: Everything + Class Index: Classes Constant Index: Constants - File Index: Files Function Index: Functions - Class Index: Classes Variable Index: Variables } # Group: Index + + +##### Do not change or remove these lines. ##### +Data: 1(D3333RuEG3AEp39ufG3tGG7uHof63tHN\A36H93`pEG) +Data: 1(h3333RuEG3AEp39ufG3tGG7uHof63tHN\A36H93G\`8\G) diff --git a/docs/conf/Topics.txt b/docs/conf/Topics.txt index ee15ec83..b1a9b939 100644 --- a/docs/conf/Topics.txt +++ b/docs/conf/Topics.txt @@ -1,4 +1,4 @@ -Format: 1.35 +Format: 1.4 # 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 @@ -55,9 +55,6 @@ Format: 1.35 # 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. |