diff options
Diffstat (limited to 'docs/config')
| -rw-r--r-- | docs/config/Data/ClassHierarchy.nd | bin | 0 -> 4 bytes | |||
| -rw-r--r-- | docs/config/Data/ConfigFileInfo.nd | 1 | ||||
| -rw-r--r-- | docs/config/Data/FileInfo.nd | 45 | ||||
| -rw-r--r-- | docs/config/Data/PreviousMenuState.nd | bin | 0 -> 579 bytes | |||
| -rw-r--r-- | docs/config/Data/PreviousSettings.nd | bin | 0 -> 124 bytes | |||
| -rw-r--r-- | docs/config/Data/SymbolTable.nd | bin | 0 -> 10962 bytes | |||
| -rw-r--r-- | docs/config/Languages.txt | 113 | ||||
| -rw-r--r-- | docs/config/Menu.txt | 67 | ||||
| -rw-r--r-- | docs/config/Topics.txt | 84 |
9 files changed, 310 insertions, 0 deletions
diff --git a/docs/config/Data/ClassHierarchy.nd b/docs/config/Data/ClassHierarchy.nd new file mode 100644 index 00000000..c5479a52 --- /dev/null +++ b/docs/config/Data/ClassHierarchy.nd Binary files differdiff --git a/docs/config/Data/ConfigFileInfo.nd b/docs/config/Data/ConfigFileInfo.nd new file mode 100644 index 00000000..225e3ab3 --- /dev/null +++ b/docs/config/Data/ConfigFileInfo.nd @@ -0,0 +1 @@ +#FR«þF{@F{@F{@F{@ \ No newline at end of file diff --git a/docs/config/Data/FileInfo.nd b/docs/config/Data/FileInfo.nd new file mode 100644 index 00000000..90105f88 --- /dev/null +++ b/docs/config/Data/FileInfo.nd @@ -0,0 +1,45 @@ +1.35 +C/C++ +/home/kma/code/teewars/docs/articles/tasks.txt 1179823068 1 Tasks +/home/kma/code/teewars/src/game/game_server.cpp 1179768929 0 /home/kma/code/teewars/src/game/game_server.cpp +/home/kma/code/teewars/src/wavpack/bits.c 1174419375 0 /home/kma/code/teewars/src/wavpack/bits.c +/home/kma/code/teewars/src/game/mapres_col.cpp 1179432693 0 /home/kma/code/teewars/src/game/mapres_col.cpp +/home/kma/code/teewars/src/game/mapres_tilemap.cpp 1179618843 0 /home/kma/code/teewars/src/game/mapres_tilemap.cpp +/home/kma/code/teewars/docs/articles/map_format.txt 1176276415 1 Map File Format +/home/kma/code/teewars/src/wavpack/unpack.c 1174419375 0 /home/kma/code/teewars/src/wavpack/unpack.c +/home/kma/code/teewars/src/game/mapres_image.h 1179424345 0 /home/kma/code/teewars/src/game/mapres_image.h +/home/kma/code/teewars/src/menu.cpp 1179619488 0 /home/kma/code/teewars/src/menu.cpp +/home/kma/code/teewars/src/snapshot.h 1174119734 0 /home/kma/code/teewars/src/snapshot.h +/home/kma/code/teewars/src/game/mapres_image.cpp 1179605594 0 /home/kma/code/teewars/src/game/mapres_image.cpp +/home/kma/code/teewars/src/wavpack/float.c 1174419375 0 /home/kma/code/teewars/src/wavpack/float.c +/home/kma/code/teewars/src/wavpack/words.c 1174419375 0 /home/kma/code/teewars/src/wavpack/words.c +/home/kma/code/teewars/src/game/mapres_col.h 1179430826 0 /home/kma/code/teewars/src/game/mapres_col.h +/home/kma/code/teewars/src/wavpack/metadata.c 1174419375 0 /home/kma/code/teewars/src/wavpack/metadata.c +/home/kma/code/teewars/docs/articles/playing.txt 1176366016 1 Playing +/home/kma/code/teewars/src/client.cpp 1179768399 0 /home/kma/code/teewars/src/client.cpp +/home/kma/code/teewars/src/packet.h 1179571910 0 /home/kma/code/teewars/src/packet.h +/home/kma/code/teewars/src/datafile.cpp 1179506867 0 /home/kma/code/teewars/src/datafile.cpp +/home/kma/code/teewars/src/wavpack/readme.txt 1174419375 0 /home/kma/code/teewars/src/wavpack/readme.txt +/home/kma/code/teewars/src/main.cpp 1178039502 0 /home/kma/code/teewars/src/main.cpp +/home/kma/code/teewars/src/server.cpp 1179768288 0 /home/kma/code/teewars/src/server.cpp +/home/kma/code/teewars/docs/articles/gameplay.txt 1179485640 1 Gameplay +/home/kma/code/teewars/src/editor.cpp 1179619211 0 /home/kma/code/teewars/src/editor.cpp +/home/kma/code/teewars/src/lzw.h 1179593947 0 /home/kma/code/teewars/src/lzw.h +/home/kma/code/teewars/src/game/game_client.cpp 1179769035 0 /home/kma/code/teewars/src/game/game_client.cpp +/home/kma/code/teewars/src/datafile.h 1179434139 0 /home/kma/code/teewars/src/datafile.h +/home/kma/code/teewars/src/ui.cpp 1179611933 0 /home/kma/code/teewars/src/ui.cpp +/home/kma/code/teewars/src/lzw.cpp 1179593670 0 /home/kma/code/teewars/src/lzw.cpp +/home/kma/code/teewars/src/wavpack/wputils.c 1174419375 0 /home/kma/code/teewars/src/wavpack/wputils.c +/home/kma/code/teewars/docs/articles/editor.txt 1177240261 1 Editor +/home/kma/code/teewars/src/game/mapres.h 1176644781 0 /home/kma/code/teewars/src/game/mapres.h +/home/kma/code/teewars/src/gfx.cpp 1179619211 0 /home/kma/code/teewars/src/gfx.cpp +/home/kma/code/teewars/src/game/mapres_tilemap.h 1179526258 0 /home/kma/code/teewars/src/game/mapres_tilemap.h +/home/kma/code/teewars/docs/articles/people.txt 1176365618 1 People +/home/kma/code/teewars/src/interface.h 1179767917 1 Engine Interface +/home/kma/code/teewars/src/map.cpp 1179410987 0 /home/kma/code/teewars/src/map.cpp +/home/kma/code/teewars/src/game/game.h 1179618414 0 /home/kma/code/teewars/src/game/game.h +/home/kma/code/teewars/src/wavpack/license.txt 1174419375 0 /home/kma/code/teewars/src/wavpack/license.txt +/home/kma/code/teewars/docs/articles/hacking.txt 1176365797 1 Hacking +/home/kma/code/teewars/src/wavpack/wavpack.h 1174419375 0 /home/kma/code/teewars/src/wavpack/wavpack.h +/home/kma/code/teewars/src/ui.h 1179611933 0 /home/kma/code/teewars/src/ui.h +/home/kma/code/teewars/src/snd.cpp 1179611933 0 /home/kma/code/teewars/src/snd.cpp diff --git a/docs/config/Data/PreviousMenuState.nd b/docs/config/Data/PreviousMenuState.nd new file mode 100644 index 00000000..13d63ea0 --- /dev/null +++ b/docs/config/Data/PreviousMenuState.nd Binary files differdiff --git a/docs/config/Data/PreviousSettings.nd b/docs/config/Data/PreviousSettings.nd new file mode 100644 index 00000000..272146b2 --- /dev/null +++ b/docs/config/Data/PreviousSettings.nd Binary files differdiff --git a/docs/config/Data/SymbolTable.nd b/docs/config/Data/SymbolTable.nd new file mode 100644 index 00000000..5ffd8b87 --- /dev/null +++ b/docs/config/Data/SymbolTable.nd Binary files differdiff --git a/docs/config/Languages.txt b/docs/config/Languages.txt new file mode 100644 index 00000000..aa9ce802 --- /dev/null +++ b/docs/config/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/config/Menu.txt b/docs/config/Menu.txt new file mode 100644 index 00000000..4c3153ed --- /dev/null +++ b/docs/config/Menu.txt @@ -0,0 +1,67 @@ +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. +# +# 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: User { + + File: Playing (/home/kma/code/teewars/docs/articles/playing.txt) + } # Group: User + +Group: Development { + + Group: Docs { + + File: Hacking (/home/kma/code/teewars/docs/articles/hacking.txt) + File: Tasks (/home/kma/code/teewars/docs/articles/tasks.txt) + File: Map File Format (/home/kma/code/teewars/docs/articles/map_format.txt) + File: People (/home/kma/code/teewars/docs/articles/people.txt) + File: Editor (/home/kma/code/teewars/docs/articles/editor.txt) + File: Gameplay (/home/kma/code/teewars/docs/articles/gameplay.txt) + } # Group: Docs + + File: Engine Interface (/home/kma/code/teewars/src/interface.h) + } # Group: Development + +Group: Index { + + Index: Everything + Function Index: Functions + } # Group: Index + + + +##### Do not change or remove these lines. ##### +Data: 1(D3333RuEG3AEp39ufG3tGG7pH636H9) +Data: 1(h3333RuEG3AEp39ufG3tGG7pH63fu963pHt89oG6) diff --git a/docs/config/Topics.txt b/docs/config/Topics.txt new file mode 100644 index 00000000..ee15ec83 --- /dev/null +++ b/docs/config/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. |