Skip to content

Commit

Permalink
Add references
Browse files Browse the repository at this point in the history
  • Loading branch information
qq542vev committed Sep 7, 2022
1 parent 6f32640 commit de8258b
Show file tree
Hide file tree
Showing 114 changed files with 953 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.naturaldocs/Working\ Data
83 changes: 83 additions & 0 deletions .naturaldocs/Comments.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
Format: 2.2

# This is the Natural Docs comments file for this project. If you change
# anything here, it will apply to THIS PROJECT ONLY. You can edit the version
# in Natural Docs' Config folder to make the changes apply to all projects,
# but it's recommended that you edit this version instead.


# Ignored Keywords
# ------------------------------------------------------------------------

# If you'd like to prevent keywords from being recognized by Natural Docs,
# you can do it like this:
#
# Ignore Keywords:
# [keyword]
# [keyword]
# ...


# Comment Types
# ------------------------------------------------------------------------

# Each Natural Docs comment has a corresponding type which determine its
# behavior. You can define your own here or override the settings of the
# existing ones.
#
# Comment Type: [name]
# Alter Comment Type: [name]
# Creates a new comment type or changes an existing one.
#
# Display Name: [name]
# Plural Display Name: [name]
# The singular and plural name of the comment type as it should appear in
# the output.
#
# Simple Identifier: [name]
# The name of the comment type using only the letters A to Z. No spaces,
# numbers, symbols, or Unicode allowed. Defaults to the comment type name
# minus any unacceptable characters. This is used to generate things like
# CSS class names.
#
# Scope: [normal|start|end|always global]
# How the comment affects scope. Defaults to normal.
# normal - The comment stays within the current scope.
# start - The comment starts a new scope for all the comments
# beneath it, like class comments.
# end - The comment resets the scope back to global for all the
# comments beneath it, like section comments.
# always global - The comment is defined as a global symbol, but does not
# change the scope for any other comments.
#
# Flags: [flag], [flag], ...
# A combination of settings that apply to the comment type.
# Code, File, or Documentation
# Whether it's used to describe a code element, a file, or is a
# standalone documentation comment. Defaults to Code.
# Variable Type
# Whether it describes a code element that can be used as a variable's
# type.
# Class Hierarchy or Database Hierarchy
# Whether it describes a code element that should be included in the
# class or database hierarchy. Requires Scope: Start.
# Enum
# Whether it describes an enum.
#
# Keywords:
# [keyword]
# [keyword], [plural keyword]
# ...
# A list of the comment type's keywords. Each line after the heading is
# the keyword and optionally its plural form for list comments. You can
# reuse existing keywords to change their definition. When using
# "Alter Comment Type", these keywords are added to the existing ones
# rather than replacing them.
#
# [Language] Keywords:
# [keyword]
# [keyword], [plural keyword]
# ...
# A list of keywords that only apply to the comment type when using a
# specific programming language. Each line after the heading is the
# keyword and optionally its plural form for list comments.
119 changes: 119 additions & 0 deletions .naturaldocs/Languages.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
Format: 2.2

# This is the Natural Docs languages file for this project. If you change
# anything here, it will apply to THIS PROJECT ONLY. You can edit the version
# in Natural Docs' Config folder to make the changes apply to all projects,
# but it's recommended that you edit this version instead.


# Ignored Extensions
# ------------------------------------------------------------------------

# If you'd like to prevent certain file extensions from being scanned by
# Natural Docs, you can do it like this:
#
# Ignore Extensions: [extension] [extension] ...


# Languages
# ------------------------------------------------------------------------
# The syntax reference is after the definitions.

Language: ShellScript

Extension: sh
Shebang String: sh

Line Comment: ##
Block Comment: <<'__DOCMENTATION__' __DOCMENTATION__


Language: Newsbeuter

Shebang String: newsbeuter

Line Comment: ##


Language: Newsboat

Shebang String: newsboat

Line Comment: ##


# These settings define the languages Natural Docs knows how to parse. You
# can define your own here or override the settings of the existing ones.
# Note that all lists are space separated so that commas can be used as
# values.
#
# Language: [name]
# Alter Language: [name]
# Defines a new language or alters an existing one. Its name can use any
# characters. If any of the properties below have an add/replace form, you
# must use that when using Alter Language.
#
# 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.
#
# Extensions: [extension] [extension] ...
# [Add/Replace] Extensions: [extension] [extension] ...
# Defines the file extensions of the language's source files.
#
# Shebang Strings: [string] [string] ...
# [Add/Replace] 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.
#
# Simple Identifier: [name]
# The name of the language using only the letters A to Z. No spaces,
# numbers, symbols, or Unicode allowed. Defaults to the language name
# minus any unacceptable characters. This is used to generate things like
# CSS class names.
#
# Aliases: [alias] [alias] ...
# [Add/Replace] Aliases: [alias] [alias] ...
# Defines alternative names for the language that can be used to start a
# code block.
#
#
# Properties for Basic Language Support Only
# ------------------------------------------------------------------------
# If you're adding your own language to Natural Docs you must define these.
#
# 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.
#
# Member Operator: [symbol]
# Defines the default member operator symbol. The default is a dot.
#
# 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
# 'class.enum.value'.
# under parent - Values are under the enum's parent, referenced as
# 'class.value'.
#
# Case Sensitive: [yes|no]
# Defines whether the language's identifiers are case sensitive. The
# default is yes.
#
# [Comment Type] Prototype Enders: [symbol] [symbol] ...
# When defined, Natural Docs will attempt to get a prototype from the code
# immediately following the comment type. It stops when it reaches one of
# these symbols. Use \n for line breaks.
Loading

0 comments on commit de8258b

Please sign in to comment.