Skip to content

Commit 1a39153

Browse files
committed
Added documentation config for Natural Docs
1 parent 0d47ee6 commit 1a39153

5 files changed

Lines changed: 406 additions & 1 deletion

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44
# Tooling directories
55
.dvt/*
66

7-
7+
# Documentation Build Files
8+
docs/html
9+
docs/config/Working\ Data/

docs/config/Comments.txt

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
Format: 2.3.1
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+
# The syntax reference is after the definitions.
24+
25+
Comment Type: Signals
26+
27+
Display Name: Signal
28+
Plural Display Name: Signals
29+
30+
SystemVerilog Keywords:
31+
signal, signals
32+
33+
34+
Comment Type: Instances
35+
36+
Keywords:
37+
inst
38+
instance, instances
39+
40+
41+
# Each Natural Docs comment has a corresponding type which determine its
42+
# behavior. You can define your own here or override the settings of the
43+
# existing ones.
44+
#
45+
# Comment Type: [name]
46+
# Alter Comment Type: [name]
47+
# Creates a new comment type or changes an existing one.
48+
#
49+
# Display Name: [name]
50+
# Plural Display Name: [name]
51+
# The singular and plural name of the comment type as it should appear in
52+
# the output.
53+
#
54+
# Simple Identifier: [name]
55+
# The name of the comment type using only the letters A to Z. No spaces,
56+
# numbers, symbols, or Unicode allowed. Defaults to the comment type name
57+
# minus any unacceptable characters. This is used to generate things like
58+
# CSS class names.
59+
#
60+
# Scope: [normal|start|end|always global]
61+
# How the comment affects scope. Defaults to normal.
62+
# normal - The comment stays within the current scope.
63+
# start - The comment starts a new scope for all the comments
64+
# beneath it, like class comments.
65+
# end - The comment resets the scope back to global for all the
66+
# comments beneath it, like section comments.
67+
# always global - The comment is defined as a global symbol, but does not
68+
# change the scope for any other comments.
69+
#
70+
# Flags: [flag], [flag], ...
71+
# A combination of settings that apply to the comment type.
72+
# Code, File, or Documentation
73+
# Whether it's used to describe a code element, a file, or is a
74+
# standalone documentation comment. Defaults to Code.
75+
# Variable Type
76+
# Whether it describes a code element that can be used as a variable's
77+
# type.
78+
# Class Hierarchy or Database Hierarchy
79+
# Whether it describes a code element that should be included in the
80+
# class or database hierarchy. Requires Scope: Start.
81+
# Enum
82+
# Whether it describes an enum.
83+
#
84+
# Keywords:
85+
# [keyword]
86+
# [keyword], [plural keyword]
87+
# ...
88+
# A list of the comment type's keywords. Each line after the heading is
89+
# the keyword and optionally its plural form for list comments. You can
90+
# reuse existing keywords to change their definition. When using
91+
# "Alter Comment Type", these keywords are added to the existing ones
92+
# rather than replacing them.
93+
#
94+
# [Language] Keywords:
95+
# [keyword]
96+
# [keyword], [plural keyword]
97+
# ...
98+
# A list of keywords that only apply to the comment type when using a
99+
# specific programming language. Each line after the heading is the
100+
# keyword and optionally its plural form for list comments.

docs/config/Languages.txt

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

0 commit comments

Comments
 (0)