docs/conf/Menu.txt

   1 Format: 1.4
   2
   3
   4 # You can add a title and sub-title to your menu like this:
   5 # Title: [project name]
   6 # SubTitle: [subtitle]
   7
   8 # You can add a footer to your documentation like this:
   9 # Footer: [text]
  10 # If you want to add a copyright notice, this would be the place to do it.
  11
  12 # You can add a timestamp to your documentation like one of these:
  13 # Timestamp: Generated on month day, year
  14 # Timestamp: Updated mm/dd/yyyy
  15 # Timestamp: Last updated mon day
  16 #
  17 #   m     - One or two digit month.  January is "1"
  18 #   mm    - Always two digit month.  January is "01"
  19 #   mon   - Short month word.  January is "Jan"
  20 #   month - Long month word.  January is "January"
  21 #   d     - One or two digit day.  1 is "1"
  22 #   dd    - Always two digit day.  1 is "01"
  23 #   day   - Day with letter extension.  1 is "1st"
  24 #   yy    - Two digit year.  2006 is "06"
  25 #   yyyy  - Four digit year.  2006 is "2006"
  26 #   year  - Four digit year.  2006 is "2006"
  27
  28
  29 # --------------------------------------------------------------------------
  30 #
  31 # Cut and paste the lines below to change the order in which your files
  32 # appear on the menu.  Don't worry about adding or removing files, Natural
  33 # Docs will take care of that.
  34 #
  35 # You can further organize the menu by grouping the entries.  Add a
  36 # "Group: [name] {" line to start a group, and add a "}" to end it.
  37 #
  38 # You can add text and web links to the menu by adding "Text: [text]" and
  39 # "Link: [name] ([URL])" lines, respectively.
  40 #
  41 # The formatting and comments are auto-generated, so don't worry about
  42 # neatness when editing the file.  Natural Docs will clean it up the next
  43 # time it is run.  When working with groups, just deal with the braces and
  44 # forget about the indentation and comments.
  45 #
  46 # You can use this file on other computers even if they use different
  47 # directories.  As long as the command line points to the same source files,
  48 # Natural Docs will be able to correct the locations automatically.
  49 #
  50 # --------------------------------------------------------------------------
  51
  52
  53 Group: Engine  {
  54
  55    File: Messaging  (/home/kma/code/teeworlds/trunk/src/engine/e_if_msg.h)
  56
  57    Group: Client  {
  58
  59       Group: Overview  {
  60
  61          File: Time on the client  (/home/kma/code/teeworlds/trunk/src/engine/docs/client_time.txt)
  62          File: Prediction  (/home/kma/code/teeworlds/trunk/src/engine/docs/prediction.txt)
  63          File: Snapshots  (/home/kma/code/teeworlds/trunk/src/engine/docs/snapshots.txt)
  64          File: Server Operation  (/home/kma/code/teeworlds/trunk/src/engine/docs/server_op.txt)
  65          }  # Group: Overview
  66
  67       Group: Reference  {
  68
  69          File: Client Hooks  (/home/kma/code/teeworlds/trunk/src/engine/e_if_modc.h)
  70          File: Client Interface  (/home/kma/code/teeworlds/trunk/src/engine/e_if_client.h)
  71          File: e_huffman.h  (/home/kma/code/teeworlds/trunk/src/engine/e_huffman.h)
  72          File: Engine Interface  (/home/kma/code/teeworlds/trunk/src/engine/e_if_other.h)
  73          File: Graphics  (/home/kma/code/teeworlds/trunk/src/engine/e_if_gfx.h)
  74          File: Input  (/home/kma/code/teeworlds/trunk/src/engine/e_if_inp.h)
  75          File: Sound  (/home/kma/code/teeworlds/trunk/src/engine/e_if_snd.h)
  76          }  # Group: Reference
  77
  78       }  # Group: Client
  79
  80    Group: Server  {
  81
  82       Group: Reference  {
  83
  84          File: Server Hooks  (/home/kma/code/teeworlds/trunk/src/engine/e_if_mods.h)
  85          File: Server Interface  (/home/kma/code/teeworlds/trunk/src/engine/e_if_server.h)
  86          }  # Group: Reference
  87
  88       }  # Group: Server
  89
  90    }  # Group: Engine
  91
  92 Group: Game  {
  93
  94    File: Entity  (/home/kma/code/teeworlds/trunk/src/game/server/entity.hpp)
  95    File: Game Controller  (/home/kma/code/teeworlds/trunk/src/game/server/gamecontroller.hpp)
  96    File: Game World  (/home/kma/code/teeworlds/trunk/src/game/server/gameworld.hpp)
  97    }  # Group: Game
  98
  99 Group: Index  {
 100
 101    Index: Everything
 102    Class Index: Classes
 103    Constant Index: Constants
 104    Function Index: Functions
 105    Variable Index: Variables
 106    File Index: Files
 107    }  # Group: Index
 108
 109
 110
 111 ##### Do not change or remove these lines. #####
 112 Data: 1(D3333RuEG3AEp39ufG3tGG7uHof63tHN\A36H93`pEG)
 113 Data: 1(h3333RuEG3AEp39ufG3tGG7uHof63tHN\A36H93G\`8\G)