diff options
Diffstat (limited to 'doc/gen/Topics.txt')
-rw-r--r-- | doc/gen/Topics.txt | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/gen/Topics.txt b/doc/gen/Topics.txt new file mode 100644 index 0000000..c825869 --- /dev/null +++ b/doc/gen/Topics.txt | |||
@@ -0,0 +1,90 @@ | |||
1 | Format: 1.51 | ||
2 | |||
3 | # This is the Natural Docs topics file for this project. If you change anything | ||
4 | # here, it will apply to THIS PROJECT ONLY. If you'd like to change something | ||
5 | # for all your projects, edit the Topics.txt in Natural Docs' Config directory | ||
6 | # instead. | ||
7 | |||
8 | |||
9 | # If you'd like to prevent keywords from being recognized by Natural Docs, you | ||
10 | # can do it like this: | ||
11 | # Ignore Keywords: [keyword], [keyword], ... | ||
12 | # | ||
13 | # Or you can use the list syntax like how they are defined: | ||
14 | # Ignore Keywords: | ||
15 | # [keyword] | ||
16 | # [keyword], [plural keyword] | ||
17 | # ... | ||
18 | |||
19 | |||
20 | #------------------------------------------------------------------------------- | ||
21 | # SYNTAX: | ||
22 | # | ||
23 | # Topic Type: [name] | ||
24 | # Alter Topic Type: [name] | ||
25 | # Creates a new topic type or alters one from the main file. Each type gets | ||
26 | # its own index and behavior settings. Its name can have letters, numbers, | ||
27 | # spaces, and these charaters: - / . ' | ||
28 | # | ||
29 | # Plural: [name] | ||
30 | # Sets the plural name of the topic type, if different. | ||
31 | # | ||
32 | # Keywords: | ||
33 | # [keyword] | ||
34 | # [keyword], [plural keyword] | ||
35 | # ... | ||
36 | # Defines or adds to the list of keywords for the topic type. They may only | ||
37 | # contain letters, numbers, and spaces and are not case sensitive. Plural | ||
38 | # keywords are used for list topics. You can redefine keywords found in the | ||
39 | # main topics file. | ||
40 | # | ||
41 | # Index: [yes|no] | ||
42 | # Whether the topics get their own index. Defaults to yes. Everything is | ||
43 | # included in the general index regardless of this setting. | ||
44 | # | ||
45 | # Scope: [normal|start|end|always global] | ||
46 | # How the topics affects scope. Defaults to normal. | ||
47 | # normal - Topics stay within the current scope. | ||
48 | # start - Topics start a new scope for all the topics beneath it, | ||
49 | # like class topics. | ||
50 | # end - Topics reset the scope back to global for all the topics | ||
51 | # beneath it. | ||
52 | # always global - Topics are defined as global, but do not change the scope | ||
53 | # for any other topics. | ||
54 | # | ||
55 | # Class Hierarchy: [yes|no] | ||
56 | # Whether the topics are part of the class hierarchy. Defaults to no. | ||
57 | # | ||
58 | # Page Title If First: [yes|no] | ||
59 | # Whether the topic's title becomes the page title if it's the first one in | ||
60 | # a file. Defaults to no. | ||
61 | # | ||
62 | # Break Lists: [yes|no] | ||
63 | # Whether list topics should be broken into individual topics in the output. | ||
64 | # Defaults to no. | ||
65 | # | ||
66 | # Can Group With: [type], [type], ... | ||
67 | # Defines a list of topic types that this one can possibly be grouped with. | ||
68 | # Defaults to none. | ||
69 | #------------------------------------------------------------------------------- | ||
70 | |||
71 | # The following topics are defined in the main file, if you'd like to alter | ||
72 | # their behavior or add keywords: | ||
73 | # | ||
74 | # Generic, Class, Interface, Section, File, Group, Function, Variable, | ||
75 | # Property, Type, Constant, Enumeration, Event, Delegate, Macro, | ||
76 | # Database, Database Table, Database View, Database Index, Database | ||
77 | # Cursor, Database Trigger, Cookie, Build Target | ||
78 | |||
79 | # If you add something that you think would be useful to other developers | ||
80 | # and should be included in Natural Docs by default, please e-mail it to | ||
81 | # topics [at] naturaldocs [dot] org. | ||
82 | |||
83 | |||
84 | Topic Type: Struct | ||
85 | |||
86 | Plural: Structs | ||
87 | Class Hierarchy: Yes | ||
88 | |||
89 | Keywords: | ||
90 | struct | ||