Skip to content

Commit a983b13

Browse files
committed
Add .naturaldocs
1 parent e3af54f commit a983b13

31 files changed

+452
-47
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
!/**/.w3mplus/doc
1111
!/**/.w3mplus/lib
1212
!/**/.w3mplus/search-config
13+
/.naturaldocs/Working\ Data

.naturaldocs/Comments.txt

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
Format: 2.2
2+
3+
# This is the Natural Docs comments file for this project. If you change
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+
8+
9+
# Ignored Keywords
10+
# ------------------------------------------------------------------------
11+
12+
# If you'd like to prevent keywords from being recognized by Natural Docs,
13+
# you can do it like this:
14+
#
15+
# Ignore Keywords:
16+
# [keyword]
17+
# [keyword]
18+
# ...
19+
20+
21+
# Comment Types
22+
# ------------------------------------------------------------------------
23+
24+
# Each Natural Docs comment has a corresponding type which determine its
25+
# behavior. You can define your own here or override the settings of the
26+
# existing ones.
27+
#
28+
# Comment Type: [name]
29+
# Alter Comment Type: [name]
30+
# Creates a new comment type or changes an existing one.
31+
#
32+
# Display Name: [name]
33+
# Plural Display Name: [name]
34+
# The singular and plural name of the comment type as it should appear in
35+
# the output.
36+
#
37+
# Simple Identifier: [name]
38+
# The name of the comment type using only the letters A to Z. No spaces,
39+
# numbers, symbols, or Unicode allowed. Defaults to the comment type name
40+
# minus any unacceptable characters. This is used to generate things like
41+
# CSS class names.
42+
#
43+
# Scope: [normal|start|end|always global]
44+
# How the comment affects scope. Defaults to normal.
45+
# normal - The comment stays within the current scope.
46+
# start - The comment starts a new scope for all the comments
47+
# beneath it, like class comments.
48+
# end - The comment resets the scope back to global for all the
49+
# comments beneath it, like section comments.
50+
# always global - The comment is defined as a global symbol, but does not
51+
# change the scope for any other comments.
52+
#
53+
# Flags: [flag], [flag], ...
54+
# A combination of settings that apply to the comment type.
55+
# Code, File, or Documentation
56+
# Whether it's used to describe a code element, a file, or is a
57+
# standalone documentation comment. Defaults to Code.
58+
# Variable Type
59+
# Whether it describes a code element that can be used as a variable's
60+
# type.
61+
# Class Hierarchy or Database Hierarchy
62+
# Whether it describes a code element that should be included in the
63+
# class or database hierarchy. Requires Scope: Start.
64+
# Enum
65+
# Whether it describes an enum.
66+
#
67+
# Keywords:
68+
# [keyword]
69+
# [keyword], [plural keyword]
70+
# ...
71+
# A list of the comment type's keywords. Each line after the heading is
72+
# the keyword and optionally its plural form for list comments. You can
73+
# reuse existing keywords to change their definition. When using
74+
# "Alter Comment Type", these keywords are added to the existing ones
75+
# rather than replacing them.
76+
#
77+
# [Language] Keywords:
78+
# [keyword]
79+
# [keyword], [plural keyword]
80+
# ...
81+
# A list of keywords that only apply to the comment type when using a
82+
# specific programming language. Each line after the heading is the
83+
# keyword and optionally its plural form for list comments.

.naturaldocs/Languages.txt

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
Format: 2.2
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. 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+
8+
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+
#
15+
# Ignore Extensions: [extension] [extension] ...
16+
17+
18+
# Languages
19+
# ------------------------------------------------------------------------
20+
# The syntax reference is after the definitions.
21+
22+
Language: ShellScript
23+
24+
Extension: sh
25+
Shebang String: sh
26+
27+
Line Comment: ##
28+
Block Comment: <<'__DOCMENTATION__' __DOCMENTATION__
29+
30+
31+
Language: AWK
32+
33+
Extension: awk
34+
Shebang String: awk
35+
36+
Line Comment: ##
37+
38+
Function Prototype Ender: {
39+
Variable Prototype Ender: =
40+
41+
42+
# These settings define the languages Natural Docs knows how to parse. You
43+
# can define your own here or override the settings of the existing ones.
44+
# Note that all lists are space separated so that commas can be used as
45+
# values.
46+
#
47+
# Language: [name]
48+
# Alter Language: [name]
49+
# Defines a new language or alters an existing one. Its name can use any
50+
# characters. If any of the properties below have an add/replace form, you
51+
# must use that when using Alter Language.
52+
#
53+
# The language Shebang Script is special. It's entry is only used for
54+
# extensions, and files with those extensions have their shebang (#!) lines
55+
# read to determine the real language of the file. Extensionless files are
56+
# always treated this way.
57+
#
58+
# The language Text File is also special. It's treated as one big comment
59+
# so you can put Natural Docs content in them without special symbols.
60+
#
61+
# Extensions: [extension] [extension] ...
62+
# [Add/Replace] Extensions: [extension] [extension] ...
63+
# Defines the file extensions of the language's source files.
64+
#
65+
# Shebang Strings: [string] [string] ...
66+
# [Add/Replace] Shebang Strings: [string] [string] ...
67+
# Defines a list of strings that can appear in the shebang (#!) line to
68+
# designate that it's part of the language.
69+
#
70+
# Simple Identifier: [name]
71+
# The name of the language using only the letters A to Z. No spaces,
72+
# numbers, symbols, or Unicode allowed. Defaults to the language name
73+
# minus any unacceptable characters. This is used to generate things like
74+
# CSS class names.
75+
#
76+
# Aliases: [alias] [alias] ...
77+
# [Add/Replace] Aliases: [alias] [alias] ...
78+
# Defines alternative names for the language that can be used to start a
79+
# code block.
80+
#
81+
#
82+
# Properties for Basic Language Support Only
83+
# ------------------------------------------------------------------------
84+
# If you're adding your own language to Natural Docs you must define these.
85+
#
86+
# Line Comments: [symbol] [symbol] ...
87+
# Defines a space-separated list of symbols that are used for line comments,
88+
# if any.
89+
#
90+
# Block Comments: [opening sym] [closing sym] [opening sym] [closing sym] ...
91+
# Defines a space-separated list of symbol pairs that are used for block
92+
# comments, if any.
93+
#
94+
# Member Operator: [symbol]
95+
# Defines the default member operator symbol. The default is a dot.
96+
#
97+
# Line Extender: [symbol]
98+
# Defines the symbol that allows a prototype to span multiple lines if
99+
# normally a line break would end it.
100+
#
101+
# Enum Values: [global|under type|under parent]
102+
# Defines how enum values are referenced. The default is global.
103+
# global - Values are always global, referenced as 'value'.
104+
# under type - Values are under the enum type, referenced as
105+
# 'class.enum.value'.
106+
# under parent - Values are under the enum's parent, referenced as
107+
# 'class.value'.
108+
#
109+
# Case Sensitive: [yes|no]
110+
# Defines whether the language's identifiers are case sensitive. The
111+
# default is yes.
112+
#
113+
# [Comment Type] Prototype Enders: [symbol] [symbol] ...
114+
# When defined, Natural Docs will attempt to get a prototype from the code
115+
# immediately following the comment type. It stops when it reaches one of
116+
# these symbols. Use \n for line breaks.

0 commit comments

Comments
 (0)