summaryrefslogtreecommitdiff
path: root/doc/gen/Languages.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/gen/Languages.txt')
-rw-r--r--doc/gen/Languages.txt118
1 files changed, 118 insertions, 0 deletions
diff --git a/doc/gen/Languages.txt b/doc/gen/Languages.txt
new file mode 100644
index 0000000..9d0df2d
--- /dev/null
+++ b/doc/gen/Languages.txt
@@ -0,0 +1,118 @@
1Format: 1.51
2
3# This is the Natural Docs languages file for this project. If you change
4# anything here, it will apply to THIS PROJECT ONLY. If you'd like to change
5# something for all your projects, edit the Languages.txt in Natural Docs'
6# Config directory instead.
7
8
9# You can prevent certain file extensions from being scanned like this:
10# Ignore Extensions: [extension] [extension] ...
11
12
13#-------------------------------------------------------------------------------
14# SYNTAX:
15#
16# Unlike other Natural Docs configuration files, in this file all comments
17# MUST be alone on a line. Some languages deal with the # character, so you
18# cannot put comments on the same line as content.
19#
20# Also, all lists are separated with spaces, not commas, again because some
21# languages may need to use them.
22#
23# Language: [name]
24# Alter Language: [name]
25# Defines a new language or alters an existing one. Its name can use any
26# characters. If any of the properties below have an add/replace form, you
27# must use that when using Alter Language.
28#
29# The language Shebang Script is special. It's entry is only used for
30# extensions, and files with those extensions have their shebang (#!) lines
31# read to determine the real language of the file. Extensionless files are
32# always treated this way.
33#
34# The language Text File is also special. It's treated as one big comment
35# so you can put Natural Docs content in them without special symbols. Also,
36# if you don't specify a package separator, ignored prefixes, or enum value
37# behavior, it will copy those settings from the language that is used most
38# in the source tree.
39#
40# Extensions: [extension] [extension] ...
41# [Add/Replace] Extensions: [extension] [extension] ...
42# Defines the file extensions of the language's source files. You can
43# redefine extensions found in the main languages file. You can use * to
44# mean any undefined extension.
45#
46# Shebang Strings: [string] [string] ...
47# [Add/Replace] Shebang Strings: [string] [string] ...
48# Defines a list of strings that can appear in the shebang (#!) line to
49# designate that it's part of the language. You can redefine strings found
50# in the main languages file.
51#
52# Ignore Prefixes in Index: [prefix] [prefix] ...
53# [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
54#
55# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ...
56# [Add/Replace] Ignored [Topic Type] Prefixes in Index: [prefix] [prefix] ...
57# Specifies prefixes that should be ignored when sorting symbols in an
58# index. Can be specified in general or for a specific topic type.
59#
60#------------------------------------------------------------------------------
61# For basic language support only:
62#
63# Line Comments: [symbol] [symbol] ...
64# Defines a space-separated list of symbols that are used for line comments,
65# if any.
66#
67# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
68# Defines a space-separated list of symbol pairs that are used for block
69# comments, if any.
70#
71# Package Separator: [symbol]
72# Defines the default package separator symbol. The default is a dot.
73#
74# [Topic Type] Prototype Enders: [symbol] [symbol] ...
75# When defined, Natural Docs will attempt to get a prototype from the code
76# immediately following the topic type. It stops when it reaches one of
77# these symbols. Use \n for line breaks.
78#
79# Line Extender: [symbol]
80# Defines the symbol that allows a prototype to span multiple lines if
81# normally a line break would end it.
82#
83# Enum Values: [global|under type|under parent]
84# Defines how enum values are referenced. The default is global.
85# global - Values are always global, referenced as 'value'.
86# under type - Values are under the enum type, referenced as
87# 'package.enum.value'.
88# under parent - Values are under the enum's parent, referenced as
89# 'package.value'.
90#
91# Perl Package: [perl package]
92# Specifies the Perl package used to fine-tune the language behavior in ways
93# too complex to do in this file.
94#
95#------------------------------------------------------------------------------
96# For full language support only:
97#
98# Full Language Support: [perl package]
99# Specifies the Perl package that has the parsing routines necessary for full
100# language support.
101#
102#-------------------------------------------------------------------------------
103
104# The following languages are defined in the main file, if you'd like to alter
105# them:
106#
107# Text File, Shebang Script, C/C++, C#, Java, JavaScript, Perl, Python,
108# PHP, SQL, Visual Basic, Pascal, Assembly, Ada, Tcl, Ruby, Makefile,
109# ActionScript, ColdFusion, R, Fortran
110
111# If you add a language that you think would be useful to other developers
112# and should be included in Natural Docs by default, please e-mail it to
113# languages [at] naturaldocs [dot] org.
114
115
116Alter Language: C/C++
117
118 Struct Prototype Ender: ;