1
- Format: 1.51
1
+ Format: 2.2
2
2
3
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.
4
+ # anything here, it will apply to THIS PROJECT ONLY. You can edit the version
5
+ # in Natural Docs' Config folder to make the changes apply to all projects,
6
+ # but it's recommended that you edit this version instead.
7
7
8
8
9
- # You can prevent certain file extensions from being scanned like this:
9
+ # Ignored Extensions
10
+ # ------------------------------------------------------------------------
11
+
12
+ # If you'd like to prevent certain file extensions from being scanned by
13
+ # Natural Docs, you can do it like this:
14
+ #
10
15
# Ignore Extensions: [extension] [extension] ...
11
16
12
17
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.
18
+ # Languages
19
+ # ------------------------------------------------------------------------
20
+ # The syntax reference is after the definitions.
21
+
22
+ Alter Language: Lua
23
+
24
+ Add Extension: lua
25
+
26
+ Line Comment: --
27
+ Block Comment: --[[ ]]
28
+
29
+
30
+ # These settings define the languages Natural Docs knows how to parse. You
31
+ # can define your own here or override the settings of the existing ones.
32
+ # Note that all lists are space separated so that commas can be used as
33
+ # values.
22
34
#
23
35
# Language: [name]
24
36
# Alter Language: [name]
@@ -32,33 +44,32 @@ Format: 1.51
32
44
# always treated this way.
33
45
#
34
46
# 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.
47
+ # so you can put Natural Docs content in them without special symbols.
39
48
#
40
49
# Extensions: [extension] [extension] ...
41
50
# [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.
51
+ # Defines the file extensions of the language's source files.
45
52
#
46
53
# Shebang Strings: [string] [string] ...
47
54
# [Add/Replace] Shebang Strings: [string] [string] ...
48
55
# 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.
56
+ # designate that it's part of the language.
51
57
#
52
- # Ignore Prefixes in Index: [prefix] [prefix] ...
53
- # [Add/Replace] Ignored Prefixes in Index: [prefix] [prefix] ...
58
+ # Simple Identifier: [name]
59
+ # The name of the language using only the letters A to Z. No spaces,
60
+ # numbers, symbols, or Unicode allowed. Defaults to the language name
61
+ # minus any unacceptable characters. This is used to generate things like
62
+ # CSS class names.
54
63
#
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 .
64
+ # Aliases : [alias ] [alias ] ...
65
+ # [Add/Replace] Aliases : [alias ] [alias ] ...
66
+ # Defines alternative names for the language that can be used to start a
67
+ # code block .
59
68
#
60
- #------------------------------------------------------------------------------
61
- # For basic language support only:
69
+ #
70
+ # Properties for Basic Language Support Only
71
+ # ------------------------------------------------------------------------
72
+ # If you're adding your own language to Natural Docs you must define these.
62
73
#
63
74
# Line Comments: [symbol] [symbol] ...
64
75
# Defines a space-separated list of symbols that are used for line comments,
@@ -68,13 +79,8 @@ Format: 1.51
68
79
# Defines a space-separated list of symbol pairs that are used for block
69
80
# comments, if any.
70
81
#
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.
82
+ # Member Operator: [symbol]
83
+ # Defines the default member operator symbol. The default is a dot.
78
84
#
79
85
# Line Extender: [symbol]
80
86
# Defines the symbol that allows a prototype to span multiple lines if
@@ -84,37 +90,15 @@ Format: 1.51
84
90
# Defines how enum values are referenced. The default is global.
85
91
# global - Values are always global, referenced as 'value'.
86
92
# under type - Values are under the enum type, referenced as
87
- # 'package .enum.value'.
93
+ # 'class .enum.value'.
88
94
# 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.
95
+ # 'class.value'.
94
96
#
95
- #------------------------------------------------------------------------------
96
- # For full language support only:
97
+ # Case Sensitive: [yes|no]
98
+ # Defines whether the language's identifiers are case sensitive. The
99
+ # default is yes.
97
100
#
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
-
116
- Language: Lua
117
-
118
- Extension: lua
119
- Line Comment: --
120
- Block Comment: --[[ ]]
101
+ # [Comment Type] Prototype Enders: [symbol] [symbol] ...
102
+ # When defined, Natural Docs will attempt to get a prototype from the code
103
+ # immediately following the comment type. It stops when it reaches one of
104
+ # these symbols. Use \n for line breaks.
0 commit comments