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
15 subroutine, subroutines
23 #-------------------------------------------------------------------------------
27 # Alter Topic Type: [name]
28 # Creates a new topic type or alters one from the main file. Each type gets
29 # its own index and behavior settings. Its name can have letters, numbers,
30 # spaces, and these charaters: - / . '
33 # Sets the plural name of the topic type, if different.
37 # [keyword], [plural keyword]
39 # Defines or adds to the list of keywords for the topic type. They may only
40 # contain letters, numbers, and spaces and are not case sensitive. Plural
41 # keywords are used for list topics. You can redefine keywords found in the
45 # Whether the topics get their own index. Defaults to yes. Everything is
46 # included in the general index regardless of this setting.
48 # Scope: [normal|start|end|always global]
49 # How the topics affects scope. Defaults to normal.
50 # normal - Topics stay within the current scope.
51 # start - Topics start a new scope for all the topics beneath it,
53 # end - Topics reset the scope back to global for all the topics
55 # always global - Topics are defined as global, but do not change the scope
56 # for any other topics.
58 # Class Hierarchy: [yes|no]
59 # Whether the topics are part of the class hierarchy. Defaults to no.
61 # Page Title If First: [yes|no]
62 # Whether the topic's title becomes the page title if it's the first one in
63 # a file. Defaults to no.
65 # Break Lists: [yes|no]
66 # Whether list topics should be broken into individual topics in the output.
69 # Can Group With: [type], [type], ...
70 # Defines a list of topic types that this one can possibly be grouped with.
72 #-------------------------------------------------------------------------------
74 # The following topics are defined in the main file, if you'd like to alter
75 # their behavior or add keywords:
77 # Generic, Class, Interface, Section, File, Group, Function, Variable,
78 # Property, Type, Constant, Enumeration, Event, Delegate, Macro,
79 # Database, Database Table, Database View, Database Index, Database
80 # Cursor, Database Trigger, Cookie, Build Target
82 # If you add something that you think would be useful to other developers
83 # and should be included in Natural Docs by default, please e-mail it to
84 # topics [at] naturaldocs [dot] org.
87 Topic Type: Constructor
95 Alter Topic Type: Function
102 Alter Topic Type: Property