|
| 1 | +Format: 1.52 |
| 2 | + |
| 3 | +# This is the main Natural Docs languages file. If you change anything here, |
| 4 | +# it will apply to EVERY PROJECT you use Natural Docs on. If you'd like to |
| 5 | +# change something for just one project, edit the Languages.txt in its project |
| 6 | +# directory instead. |
| 7 | + |
| 8 | + |
| 9 | +#------------------------------------------------------------------------------- |
| 10 | +# SYNTAX: |
| 11 | +# |
| 12 | +# Unlike other Natural Docs configuration files, in this file all comments |
| 13 | +# MUST be alone on a line. Some languages deal with the # character, so you |
| 14 | +# cannot put comments on the same line as content. |
| 15 | +# |
| 16 | +# Also, all lists are separated with spaces, not commas, again because some |
| 17 | +# languages may need to use them. |
| 18 | +# |
| 19 | +# Language: [name] |
| 20 | +# Defines a new language. Its name can use any characters. |
| 21 | +# |
| 22 | +# The language Shebang Script is special. It's entry is only used for |
| 23 | +# extensions, and files with those extensions have their shebang (#!) lines |
| 24 | +# read to determine the real language of the file. Extensionless files are |
| 25 | +# always treated this way. |
| 26 | +# |
| 27 | +# The language Text File is also special. It's treated as one big comment |
| 28 | +# so you can put Natural Docs content in them without special symbols. Also, |
| 29 | +# if you don't specify a package separator, ignored prefixes, or enum value |
| 30 | +# behavior, it will copy those settings from the language that is used most |
| 31 | +# in the source tree. |
| 32 | +# |
| 33 | +# Extensions: [extension] [extension] ... |
| 34 | +# Defines the file extensions of the language's source files. You can use * |
| 35 | +# to mean any undefined extension. |
| 36 | +# |
| 37 | +# Shebang Strings: [string] [string] ... |
| 38 | +# Defines a list of strings that can appear in the shebang (#!) line to |
| 39 | +# designate that it's part of the language. |
| 40 | +# |
| 41 | +# Ignore Prefixes in Index: [prefix] [prefix] ... |
| 42 | +# Ignore [Topic Type] Prefixes in Index: [prefix] [prefix] ... |
| 43 | +# Specifies prefixes that should be ignored when sorting symbols in an |
| 44 | +# index. Can be specified in general or for a specific topic type. |
| 45 | +# |
| 46 | +#------------------------------------------------------------------------------ |
| 47 | +# For basic language support only: |
| 48 | +# |
| 49 | +# Line Comments: [symbol] [symbol] ... |
| 50 | +# Defines a space-separated list of symbols that are used for line comments, |
| 51 | +# if any. |
| 52 | +# |
| 53 | +# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ... |
| 54 | +# Defines a space-separated list of symbol pairs that are used for block |
| 55 | +# comments, if any. |
| 56 | +# |
| 57 | +# Package Separator: [symbol] |
| 58 | +# Defines the default package separator symbol. The default is a dot. |
| 59 | +# |
| 60 | +# [Topic Type] Prototype Enders: [symbol] [symbol] ... |
| 61 | +# When defined, Natural Docs will attempt to get a prototype from the code |
| 62 | +# immediately following the topic type. It stops when it reaches one of |
| 63 | +# these symbols. Use \n for line breaks. |
| 64 | +# |
| 65 | +# Line Extender: [symbol] |
| 66 | +# Defines the symbol that allows a prototype to span multiple lines if |
| 67 | +# normally a line break would end it. |
| 68 | +# |
| 69 | +# Enum Values: [global|under type|under parent] |
| 70 | +# Defines how enum values are referenced. The default is global. |
| 71 | +# global - Values are always global, referenced as 'value'. |
| 72 | +# under type - Values are under the enum type, referenced as |
| 73 | +# 'package.enum.value'. |
| 74 | +# under parent - Values are under the enum's parent, referenced as |
| 75 | +# 'package.value'. |
| 76 | +# |
| 77 | +# Perl Package: [perl package] |
| 78 | +# Specifies the Perl package used to fine-tune the language behavior in ways |
| 79 | +# too complex to do in this file. |
| 80 | +# |
| 81 | +#------------------------------------------------------------------------------ |
| 82 | +# For full language support only: |
| 83 | +# |
| 84 | +# Full Language Support: [perl package] |
| 85 | +# Specifies the Perl package that has the parsing routines necessary for full |
| 86 | +# language support. |
| 87 | +# |
| 88 | +#------------------------------------------------------------------------------- |
| 89 | + |
| 90 | +# The following languages MUST be defined in this file: |
| 91 | +# |
| 92 | +# Text File, Shebang Script |
| 93 | + |
| 94 | +# If you add a language that you think would be useful to other developers |
| 95 | +# and should be included in Natural Docs by default, please e-mail it to |
| 96 | +# languages [at] naturaldocs [dot] org. |
| 97 | + |
| 98 | + |
| 99 | +Language: Text File |
| 100 | + |
| 101 | + Extension: txt |
| 102 | + |
| 103 | + |
| 104 | +Language: Shebang Script |
| 105 | + |
| 106 | + Extension: cgi |
| 107 | + |
| 108 | + |
| 109 | +Language: C/C++ |
| 110 | + |
| 111 | + Extensions: c cpp h hpp cxx hxx |
| 112 | + Ignore Function Prefix in Index: ~ |
| 113 | + Line Comment: // |
| 114 | + Block Comment: /* */ |
| 115 | + Package Separator: :: |
| 116 | + Enum Values: Under parent |
| 117 | + Class Prototype Enders: ; { |
| 118 | + Function Prototype Enders: ; { |
| 119 | + Variable Prototype Enders: ; = |
| 120 | + |
| 121 | + |
| 122 | +Language: C# |
| 123 | + |
| 124 | + Extension: cs |
| 125 | + Ignore Prefix in Index: @ |
| 126 | + Full Language Support: NaturalDocs::Languages::CSharp |
| 127 | + |
| 128 | + |
| 129 | +Language: Java |
| 130 | + |
| 131 | + Extension: java |
| 132 | + Line Comment: // |
| 133 | + Block Comment: /* */ |
| 134 | + Enum Values: Under type |
| 135 | + Function Prototype Ender: { |
| 136 | + Variable Prototype Enders: ; = |
| 137 | + |
| 138 | + |
| 139 | +Language: JavaScript |
| 140 | + |
| 141 | + Extension: js |
| 142 | + Line Comment: // |
| 143 | + Block Comment: /* */ |
| 144 | + Enum Values: Under type |
| 145 | + Function Prototype Ender: { |
| 146 | + Variable Prototype Enders: ; = , } |
| 147 | + |
| 148 | + |
| 149 | +Language: Perl |
| 150 | + |
| 151 | + Extensions: pl pm |
| 152 | + Shebang String: perl |
| 153 | + Ignore Variable Prefixes in Index: $ @ % * |
| 154 | + Full Language Support: NaturalDocs::Languages::Perl |
| 155 | + |
| 156 | + |
| 157 | +Language: Python |
| 158 | + |
| 159 | + Extension: py |
| 160 | + Shebang String: python |
| 161 | + Line Comment: # |
| 162 | + Function Prototype Ender: : |
| 163 | + Variable Prototype Ender: = |
| 164 | + Line Extender: \ |
| 165 | + |
| 166 | + |
| 167 | +Language: PHP |
| 168 | + |
| 169 | + Extensions: inc php php3 php4 phtml |
| 170 | + Shebang String: php |
| 171 | + Ignore Variable Prefix in Index: $ |
| 172 | + Line Comments: // # |
| 173 | + Block Comment: /* */ |
| 174 | + Function Prototype Enders: ; { |
| 175 | + Variable Prototype Enders: ; = |
| 176 | + |
| 177 | + |
| 178 | +Language: SQL |
| 179 | + |
| 180 | + Extension: sql |
| 181 | + Line Comment: -- |
| 182 | + Block Comment: /* */ |
| 183 | + Enum Values: Global |
| 184 | + Function Prototype Enders: , ; ) as As AS is Is IS |
| 185 | + Variable Prototype Enders: , ; ) := default Default DEFAULT |
| 186 | + Database Index Prototype Enders: , ; ) |
| 187 | + Database Trigger Prototype Enders: begin Begin BEGIN as As AS |
| 188 | + Perl Package: NaturalDocs::Languages::PLSQL |
| 189 | + |
| 190 | + |
| 191 | +Language: Visual Basic |
| 192 | + |
| 193 | + Extensions: vb vbs bas cls frm |
| 194 | + Line Comment: ' |
| 195 | + Enum Values: Under type |
| 196 | + Function Prototype Ender: \n |
| 197 | + Variable Prototype Enders: \n = |
| 198 | + Line Extender: _ |
| 199 | + |
| 200 | + |
| 201 | +Language: Pascal |
| 202 | + |
| 203 | + Extension: pas |
| 204 | + Line Comment: // |
| 205 | + Block Comments: { } (* *) |
| 206 | + Function Prototype Ender: ; |
| 207 | + Variable Prototype Enders: ; = |
| 208 | + Perl Package: NaturalDocs::Languages::Pascal |
| 209 | + |
| 210 | + |
| 211 | +Language: Assembly |
| 212 | + |
| 213 | + Extension: asm |
| 214 | + Line Comment: ; |
| 215 | + Variable Prototype Ender: \n |
| 216 | + Line Extender: \ |
| 217 | + |
| 218 | + |
| 219 | +Language: Ada |
| 220 | + |
| 221 | + Extensions: ada ads adb |
| 222 | + Line Comment: -- |
| 223 | + Function Prototype Enders: ; is Is IS |
| 224 | + Variable Prototype Enders: ; := |
| 225 | + Perl Package: NaturalDocs::Languages::Ada |
| 226 | + |
| 227 | + |
| 228 | +Language: Tcl |
| 229 | + |
| 230 | + Extensions: tcl exp |
| 231 | + Shebang Strings: tclsh wish expect |
| 232 | + Line Comment: # |
| 233 | + Package Separator: :: |
| 234 | + Function Prototype Enders: ; { |
| 235 | + Variable Prototype Enders: ; \n |
| 236 | + Line Extender: \ |
| 237 | + Perl Package: NaturalDocs::Languages::Tcl |
| 238 | + |
| 239 | + |
| 240 | +Language: Ruby |
| 241 | + |
| 242 | + Extension: rb |
| 243 | + Shebang String: ruby |
| 244 | + Ignore Variable Prefixes in Index: $ @ @@ |
| 245 | + Line Comment: # |
| 246 | + Enum Values: Under parent |
| 247 | + Function Prototype Enders: ; \n |
| 248 | + Variable Prototype Enders: ; \n = |
| 249 | + Line Extender: \ |
| 250 | + |
| 251 | + |
| 252 | +Language: Makefile |
| 253 | + |
| 254 | + Extensions: mk mak make |
| 255 | + Line Comment: # |
| 256 | + |
| 257 | + |
| 258 | +Language: ActionScript |
| 259 | + |
| 260 | + Extensions: as mxml |
| 261 | + Full Language Support: NaturalDocs::Languages::ActionScript |
| 262 | + |
| 263 | + |
| 264 | +Language: ColdFusion |
| 265 | + |
| 266 | + Extensions: cfm cfml cfc |
| 267 | + Line Comment: // |
| 268 | + Block Comments: <!--- ---> /* */ |
| 269 | + Function Prototype Enders: { < |
| 270 | + |
| 271 | + |
| 272 | +Language: R |
| 273 | + |
| 274 | + Extension: r |
| 275 | + Line Comment: # |
| 276 | + Function Prototype Enders: { ; |
| 277 | + Variable Prototype Enders: <- = ; \n |
| 278 | + |
| 279 | + |
| 280 | +Language: Fortran |
| 281 | + |
| 282 | + Extensions: f90 f95 f03 |
| 283 | + Line Comment: ! |
| 284 | + Function Prototype Ender: \n |
| 285 | + Variable Prototype Enders: \n = => |
| 286 | + Line Extender: & |
0 commit comments