diff options
Diffstat (limited to 'docs/doctool/Config')
| -rw-r--r-- | docs/doctool/Config/Languages.txt | 285 | ||||
| -rw-r--r-- | docs/doctool/Config/Topics.txt | 386 |
2 files changed, 671 insertions, 0 deletions
diff --git a/docs/doctool/Config/Languages.txt b/docs/doctool/Config/Languages.txt new file mode 100644 index 00000000..78a77a5a --- /dev/null +++ b/docs/doctool/Config/Languages.txt @@ -0,0 +1,285 @@ +Format: 1.35 + +# This is the main Natural Docs languages file. If you change anything here, +# it will apply to EVERY PROJECT you use Natural Docs on. If you'd like to +# change something for just one project, edit the Languages.txt in its project +# directory instead. + + +#------------------------------------------------------------------------------- +# 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] +# Defines a new language. Its name can use any characters. +# +# 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] ... +# Defines the file extensions of the language's source files. You can use * +# to mean any undefined extension. +# +# 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. +# +# Ignore Prefixes in Index: [prefix] [prefix] ... +# Ignore [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 MUST be defined in this file: +# +# Text File, Shebang Script + +# 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. + + +Language: Text File + + Extension: txt + + +Language: Shebang Script + + Extension: cgi + + +Language: C/C++ + + Extensions: c cpp h hpp cxx hxx + Ignore Function Prefix in Index: ~ + Line Comment: // + Block Comment: /* */ + Package Separator: :: + Enum Values: Global + Function Prototype Enders: ; { + Variable Prototype Enders: ; = + + +Language: C# + + Extension: cs + Ignore Prefix in Index: @ + Full Language Support: NaturalDocs::Languages::CSharp + + +Language: Java + + Extension: java + Line Comment: // + Block Comment: /* */ + Enum Values: Local + Function Prototype Ender: { + Variable Prototype Enders: ; = + + +Language: JavaScript + + Extension: js + Line Comment: // + Block Comment: /* */ + Enum Values: Local + Function Prototype Ender: { + Variable Prototype Enders: ; = + + +Language: Perl + + Extensions: pl pm + Shebang String: perl + Ignore Variable Prefixes in Index: $ @ % * + Full Language Support: NaturalDocs::Languages::Perl + + +Language: Python + + Extension: py + Shebang String: python + Line Comment: # + Function Prototype Ender: : + Variable Prototype Ender: = + Line Extender: \ + + +Language: PHP + + Extensions: inc php php3 php4 phtml + Shebang String: php + Ignore Variable Prefix in Index: $ + Line Comments: // # + Block Comment: /* */ + Function Prototype Enders: ; { + Variable Prototype Enders: ; = + + +Language: SQL + + Extension: sql + Line Comment: -- + Block Comment: /* */ + Enum Values: Global + Function Prototype Enders: , ; ) as As AS is Is IS + Variable Prototype Enders: , ; ) := default Default DEFAULT + Database Index Prototype Enders: , ; ) + Database Trigger Prototype Enders: begin Begin BEGIN as As AS + Perl Package: NaturalDocs::Languages::PLSQL + + +Language: Visual Basic + + Extensions: vb vbs bas cls frm + Line Comment: ' + Enum Values: Local + Function Prototype Ender: \n + Variable Prototype Enders: \n = + Line Extender: _ + + +Language: Pascal + + Extension: pas + Line Comment: // + Block Comments: { } (* *) + Function Prototype Ender: ; + Variable Prototype Enders: ; = + Perl Package: NaturalDocs::Languages::Pascal + + +Language: Assembly + + Extension: asm + Line Comment: ; + Variable Prototype Ender: \n + Line Extender: \ + + +Language: Ada + + Extensions: ada ads adb + Line Comment: -- + Function Prototype Enders: ; is Is IS + Variable Prototype Enders: ; := + Perl Package: NaturalDocs::Languages::Ada + + +Language: Tcl + + Extensions: tcl exp + Shebang Strings: tclsh wish expect + Line Comment: # + Package Separator: :: + Function Prototype Enders: ; { + Variable Prototype Enders: ; \n + Line Extender: \ + Perl Package: NaturalDocs::Languages::Tcl + + +Language: Ruby + + Extension: rb + Shebang String: ruby + Ignore Variable Prefixes in Index: $ @ @@ + Line Comment: # + Enum Values: Parent + Function Prototype Enders: ; \n + Variable Prototype Enders: ; \n = + Line Extender: \ + + +Language: Makefile + + Extensions: mk mak make + Line Comment: # + + +Language: ActionScript + + Extension: as + Full Language Support: NaturalDocs::Languages::ActionScript + + +Language: ColdFusion + + Extensions: cfm cfml cfc + Line Comment: // + Block Comments: <!--- ---> /* */ + Function Prototype Enders: { < + + +Language: R + + Extension: r + Line Comment: # + Function Prototype Enders: { ; + Variable Prototype Enders: <- = ; \n + + +Language: Fortran + + Extensions: f90 f95 f03 + Line Comment: ! + Function Prototype Ender: \n + Variable Prototype Enders: \n = => + Line Extender: & diff --git a/docs/doctool/Config/Topics.txt b/docs/doctool/Config/Topics.txt new file mode 100644 index 00000000..34a2933a --- /dev/null +++ b/docs/doctool/Config/Topics.txt @@ -0,0 +1,386 @@ +Format: 1.35 + +# This is the main Natural Docs topics file. If you change anything here, it +# will apply to EVERY PROJECT you use Natural Docs on. If you'd like to +# change something for just one project, edit the Topics.txt in its project +# directory instead. + + +#------------------------------------------------------------------------------- +# SYNTAX: +# +# Topic Type: [name] +# Creates a new topic type. Each type gets its own index and behavior +# settings. Its name can have letters, numbers, spaces, and these +# charaters: - / . ' +# +# The Enumeration type is special. It's indexed with Types but its members +# are indexed with Constants according to the rules in Languages.txt. +# +# Plural: [name] +# Sets the plural name of the topic type, if different. +# +# Keywords: +# [keyword] +# [keyword], [plural keyword] +# ... +# Defines a 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. +# +# 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 MUST be defined in this file: +# +# Generic, Class, Interface, Section, File, Group, Function, Variable, +# Property, Type, Constant, Enumeration, Event, Delegate + +# 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. + + +Topic Type: Generic + + Index: No + Keywords: + topic, topics + about, list + note + notes + + +Topic Type: Class + + Plural: Classes + Scope: Start + Class Hierarchy: Yes + Page Title If First: Yes + Can Group With: Interfaces + + Keywords: + class, classes + structure, structures + struct, structs + package, packages + namespace, namespaces + + +Topic Type: Interface + + Plural: Interfaces + Scope: Start + Class Hierarchy: Yes + Page Title If First: Yes + Can Group With: Classes + + Keywords: + interface, interfaces + + +Topic Type: Section + + Plural: Sections + Index: No + Scope: End + Page Title If First: Yes + + Keywords: + section + title + + +Topic Type: File + + Plural: Files + Scope: Always global + Page Title If First: Yes + + Keywords: + file, files + program, programs + script, scripts + document, documents + doc, docs + header, headers + + +Topic Type: Group + + Plural: Groups + Index: No + + Keywords: + group + + +Topic Type: Function + + Plural: Functions + Break Lists: Yes + Can Group With: Properties + + Keywords: + function, functions + func, funcs + procedure, procedures + proc, procs + routine, routines + subroutine, subroutines + sub, subs + method, methods + callback, callbacks + constructor, constructors + destructor, destructors + + +Topic Type: Variable + + Plural: Variables + Can Group With: Types, Constants, Macros, Enumerations + + Keywords: + variable, variables + var, vars + integer, integers + int, ints + uint, uints + long, longs + ulong, ulongs + short, shorts + ushort, ushorts + byte, bytes + ubyte, ubytes + sbyte, sbytes + float, floats + double, doubles + real, reals + decimal, decimals + scalar, scalars + array, arrays + arrayref, arrayrefs + hash, hashes + hashref, hashrefs + bool, bools + boolean, booleans + flag, flags + bit, bits + bitfield, bitfields + field, fields + pointer, pointers + ptr, ptrs + reference, references + ref, refs + object, objects + obj, objs + character, characters + wcharacter, wcharacters + char, chars + wchar, wchars + string, strings + wstring, wstrings + str, strs + wstr, wstrs + handle, handles + + +Topic Type: Property + + Plural: Properties + Can Group With: Functions + + Keywords: + property, properties + prop, props + + +Topic Type: Type + + Plural: Types + Can Group With: Variables, Constants, Macros, Enumerations + + Keywords: + type, types + typedef, typedefs + + +Topic Type: Constant + + Plural: Constants + Can Group With: Variables, Types, Macros, Enumerations + + Keywords: + constant, constants + const, consts + + +Topic Type: Enumeration + + Plural: Enumerations + Index: No + Can Group With: Variables, Types, Macros, Constants + + Keywords: + enum, enums + enumeration, enumerations + + +Topic Type: Event + + Plural: Events + Keywords: + event, events + + +Topic Type: Delegate + + Plural: Delegates + Keywords: + delegate, delegates + + +Topic Type: Macro + + Plural: Macros + Can Group With: Variables, Types, Constants + + Keywords: + define, defines + def, defs + macro, macros + + +Topic Type: Database + + Plural: Databases + Page Title If First: Yes + + Keywords: + database, databases + db, dbs + + +Topic Type: Database Table + + Plural: Database Tables + Scope: Start + Page Title If First: Yes + + Keywords: + table, tables + database table, database tables + databasetable, databasetables + db table, db tables + dbtable, dbtables + + +Topic Type: Database View + + Plural: Database Views + Scope: Start + Page Title If First: Yes + + Keywords: + view, views + database view, database views + databaseview, databaseviews + db view, db views + dbview, dbviews + + +Topic Type: Database Index + + Plural: Database Indexes + Keywords: + index, indexes + index, indices + database index, database indexes + database index, database indices + databaseindex, databaseindexes + databaseindex, databaseindices + db index, db indexes + db index, db indices + dbindex, dbindexes + dbindex, dbindices + key, keys + database key, database keys + databasekey, databasekeys + db key, db keys + dbkey, dbkeys + primary key, primary keys + primarykey, primarykeys + database primary key, database primary keys + databaseprimarykey, databaseprimarykeys + db primary key, db primary keys + dbprimarykey, dbprimarykeys + + +Topic Type: Database Cursor + + Plural: Database Cursors + Keywords: + cursor, cursors + database cursor, database cursors + databasecursor, databasecursors + db cursor, db cursors + dbcursor, dbcursors + + +Topic Type: Database Trigger + + Plural: Database Triggers + Keywords: + trigger, triggers + database trigger, database triggers + databasetrigger, databasetriggers + db trigger, db triggers + dbtrigger, dbtriggers + + +Topic Type: Cookie + + Plural: Cookies + Scope: Always global + + Keywords: + cookie, cookies + + +Topic Type: Build Target + + Plural: Build Targets + Keywords: + target, targets + build target, build targets + buildtarget, buildtargets |