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
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], ...
13 # Or you can use the list syntax like how they are defined:
16 # [keyword], [plural keyword]
20 #-------------------------------------------------------------------------------
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: - / . '
30 # Sets the plural name of the topic type, if different.
34 # [keyword], [plural keyword]
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
42 # Whether the topics get their own index. Defaults to yes. Everything is
43 # included in the general index regardless of this setting.
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,
50 # end - Topics reset the scope back to global for all the topics
52 # always global - Topics are defined as global, but do not change the scope
53 # for any other topics.
55 # Class Hierarchy: [yes|no]
56 # Whether the topics are part of the class hierarchy. Defaults to no.
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.
62 # Break Lists: [yes|no]
63 # Whether list topics should be broken into individual topics in the output.
66 # Can Group With: [type], [type], ...
67 # Defines a list of topic types that this one can possibly be grouped with.
69 #-------------------------------------------------------------------------------
71 # The following topics are defined in the main file, if you'd like to alter
72 # their behavior or add keywords:
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
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.
84 Topic Type: Constructor
92 Alter Topic Type: Function
99 Alter Topic Type: Property