|
| 1 | +Format: 2.3 |
| 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. |
0 commit comments