GPL_bin_fullset/NaturalDocs/Config/Topics.txt

   1 Format: 1.52\r
   2 \r
   3 # This is the main Natural Docs topics file.  If you change anything here, it\r
   4 # will apply to EVERY PROJECT you use Natural Docs on.  If you'd like to\r
   5 # change something for just one project, edit the Topics.txt in its project\r
   6 # directory instead.\r
   7 \r
   8 \r
   9 #-------------------------------------------------------------------------------\r
  10 # SYNTAX:\r
  11 #\r
  12 # Topic Type: [name]\r
  13 #    Creates a new topic type.  Each type gets its own index and behavior\r
  14 #    settings.  Its name can have letters, numbers, spaces, and these\r
  15 #    charaters: - / . '\r
  16 #\r
  17 #    The Enumeration type is special.  It's indexed with Types but its members\r
  18 #    are indexed with Constants according to the rules in Languages.txt.\r
  19 #\r
  20 # Plural: [name]\r
  21 #    Sets the plural name of the topic type, if different.\r
  22 #\r
  23 # Keywords:\r
  24 #    [keyword]\r
  25 #    [keyword], [plural keyword]\r
  26 #    ...\r
  27 #    Defines a list of keywords for the topic type.  They may only contain\r
  28 #    letters, numbers, and spaces and are not case sensitive.  Plural keywords\r
  29 #    are used for list topics.\r
  30 #\r
  31 # Index: [yes|no]\r
  32 #    Whether the topics get their own index.  Defaults to yes.  Everything is\r
  33 #    included in the general index regardless of this setting.\r
  34 #\r
  35 # Scope: [normal|start|end|always global]\r
  36 #    How the topics affects scope.  Defaults to normal.\r
  37 #    normal        - Topics stay within the current scope.\r
  38 #    start         - Topics start a new scope for all the topics beneath it,\r
  39 #                    like class topics.\r
  40 #    end           - Topics reset the scope back to global for all the topics\r
  41 #                    beneath it.\r
  42 #    always global - Topics are defined as global, but do not change the scope\r
  43 #                    for any other topics.\r
  44 #\r
  45 # Class Hierarchy: [yes|no]\r
  46 #    Whether the topics are part of the class hierarchy.  Defaults to no.\r
  47 #\r
  48 # Page Title If First: [yes|no]\r
  49 #    Whether the topic's title becomes the page title if it's the first one in\r
  50 #    a file.  Defaults to no.\r
  51 #\r
  52 # Break Lists: [yes|no]\r
  53 #    Whether list topics should be broken into individual topics in the output.\r
  54 #    Defaults to no.\r
  55 #\r
  56 # Can Group With: [type], [type], ...\r
  57 #    Defines a list of topic types that this one can possibly be grouped with.\r
  58 #    Defaults to none.\r
  59 #-------------------------------------------------------------------------------\r
  60 \r
  61 # The following topics MUST be defined in this file:\r
  62 #\r
  63 #    Generic, Class, Interface, Section, File, Group, Function, Variable,\r
  64 #    Property, Type, Constant, Enumeration, Event, Delegate\r
  65 \r
  66 # If you add something that you think would be useful to other developers\r
  67 # and should be included in Natural Docs by default, please e-mail it to\r
  68 # topics [at] naturaldocs [dot] org.\r
  69 \r
  70 \r
  71 Topic Type: Generic\r
  72 \r
  73    Index: No\r
  74    Keywords:\r
  75       topic, topics\r
  76       about, list\r
  77 \r
  78 \r
  79 Topic Type: Class\r
  80 \r
  81    Plural: Classes\r
  82    Scope: Start\r
  83    Class Hierarchy: Yes\r
  84    Page Title If First: Yes\r
  85    Can Group With: Interfaces\r
  86 \r
  87    Keywords:\r
  88       class, classes\r
  89       structure, structures\r
  90       struct, structs\r
  91       package, packages\r
  92       namespace, namespaces\r
  93 \r
  94 \r
  95 Topic Type: Interface\r
  96 \r
  97    Plural: Interfaces\r
  98    Scope: Start\r
  99    Class Hierarchy: Yes\r
 100    Page Title If First: Yes\r
 101    Can Group With: Classes\r
 102 \r
 103    Keywords:\r
 104       interface, interfaces\r
 105 \r
 106 \r
 107 Topic Type: Section\r
 108 \r
 109    Plural: Sections\r
 110    Index: No\r
 111    Scope: End\r
 112    Page Title If First: Yes\r
 113 \r
 114    Keywords:\r
 115       section\r
 116       title\r
 117 \r
 118 \r
 119 Topic Type: File\r
 120 \r
 121    Plural: Files\r
 122    Scope: Always global\r
 123    Page Title If First: Yes\r
 124 \r
 125    Keywords:\r
 126       file, files\r
 127       program, programs\r
 128       script, scripts\r
 129       document, documents\r
 130       doc, docs\r
 131       header, headers\r
 132 \r
 133 \r
 134 Topic Type: Group\r
 135 \r
 136    Plural: Groups\r
 137    Index: No\r
 138 \r
 139    Keywords:\r
 140       group\r
 141 \r
 142 \r
 143 Topic Type: Function\r
 144 \r
 145    Plural: Functions\r
 146    Break Lists: Yes\r
 147    Can Group With: Properties\r
 148 \r
 149    Keywords:\r
 150       function, functions\r
 151       func, funcs\r
 152       procedure, procedures\r
 153       proc, procs\r
 154       routine, routines\r
 155       subroutine, subroutines\r
 156       sub, subs\r
 157       method, methods\r
 158       callback, callbacks\r
 159       constructor, constructors\r
 160       destructor, destructors\r
 161       operator, operators\r
 162 \r
 163 \r
 164 Topic Type: Variable\r
 165 \r
 166    Plural: Variables\r
 167    Can Group With: Types, Constants, Macros, Enumerations\r
 168 \r
 169    Keywords:\r
 170       variable, variables\r
 171       var, vars\r
 172       integer, integers\r
 173       int, ints\r
 174       uint, uints\r
 175       long, longs\r
 176       ulong, ulongs\r
 177       short, shorts\r
 178       ushort, ushorts\r
 179       byte, bytes\r
 180       ubyte, ubytes\r
 181       sbyte, sbytes\r
 182       float, floats\r
 183       double, doubles\r
 184       real, reals\r
 185       decimal, decimals\r
 186       scalar, scalars\r
 187       array, arrays\r
 188       arrayref, arrayrefs\r
 189       hash, hashes\r
 190       hashref, hashrefs\r
 191       bool, bools\r
 192       boolean, booleans\r
 193       flag, flags\r
 194       bit, bits\r
 195       bitfield, bitfields\r
 196       field, fields\r
 197       pointer, pointers\r
 198       ptr, ptrs\r
 199       reference, references\r
 200       ref, refs\r
 201       object, objects\r
 202       obj, objs\r
 203       character, characters\r
 204       wcharacter, wcharacters\r
 205       char, chars\r
 206       wchar, wchars\r
 207       string, strings\r
 208       wstring, wstrings\r
 209       str, strs\r
 210       wstr, wstrs\r
 211       handle, handles\r
 212 \r
 213 \r
 214 Topic Type: Property\r
 215 \r
 216    Plural: Properties\r
 217    Can Group With: Functions\r
 218 \r
 219    Keywords:\r
 220       property, properties\r
 221       prop, props\r
 222 \r
 223 \r
 224 Topic Type: Type\r
 225 \r
 226    Plural: Types\r
 227    Can Group With: Variables, Constants, Macros, Enumerations\r
 228 \r
 229    Keywords:\r
 230       type, types\r
 231       typedef, typedefs\r
 232 \r
 233 \r
 234 Topic Type: Constant\r
 235 \r
 236    Plural: Constants\r
 237    Can Group With: Variables, Types, Macros, Enumerations\r
 238 \r
 239    Keywords:\r
 240       constant, constants\r
 241       const, consts\r
 242 \r
 243 \r
 244 Topic Type: Enumeration\r
 245 \r
 246    Plural: Enumerations\r
 247    Index: No\r
 248    Can Group With: Variables, Types, Macros, Constants\r
 249 \r
 250    Keywords:\r
 251       enum, enums\r
 252       enumeration, enumerations\r
 253 \r
 254 \r
 255 Topic Type: Event\r
 256 \r
 257    Plural: Events\r
 258    Keywords:\r
 259       event, events\r
 260 \r
 261 \r
 262 Topic Type: Delegate\r
 263 \r
 264    Plural: Delegates\r
 265    Keywords:\r
 266       delegate, delegates\r
 267 \r
 268 \r
 269 Topic Type: Macro\r
 270 \r
 271    Plural: Macros\r
 272    Can Group With: Variables, Types, Constants\r
 273 \r
 274    Keywords:\r
 275       define, defines\r
 276       def, defs\r
 277       macro, macros\r
 278 \r
 279 \r
 280 Topic Type: Database\r
 281 \r
 282    Plural: Databases\r
 283    Page Title If First: Yes\r
 284 \r
 285    Keywords:\r
 286       database, databases\r
 287       db, dbs\r
 288 \r
 289 \r
 290 Topic Type: Database Table\r
 291 \r
 292    Plural: Database Tables\r
 293    Scope: Start\r
 294    Page Title If First: Yes\r
 295 \r
 296    Keywords:\r
 297       table, tables\r
 298       database table, database tables\r
 299       databasetable, databasetables\r
 300       db table, db tables\r
 301       dbtable, dbtables\r
 302 \r
 303 \r
 304 Topic Type: Database View\r
 305 \r
 306    Plural: Database Views\r
 307    Scope: Start\r
 308    Page Title If First: Yes\r
 309 \r
 310    Keywords:\r
 311       view, views\r
 312       database view, database views\r
 313       databaseview, databaseviews\r
 314       db view, db views\r
 315       dbview, dbviews\r
 316 \r
 317 \r
 318 Topic Type: Database Index\r
 319 \r
 320    Plural: Database Indexes\r
 321    Keywords:\r
 322       index, indexes\r
 323       index, indices\r
 324       database index, database indexes\r
 325       database index, database indices\r
 326       databaseindex, databaseindexes\r
 327       databaseindex, databaseindices\r
 328       db index, db indexes\r
 329       db index, db indices\r
 330       dbindex, dbindexes\r
 331       dbindex, dbindices\r
 332       key, keys\r
 333       database key, database keys\r
 334       databasekey, databasekeys\r
 335       db key, db keys\r
 336       dbkey, dbkeys\r
 337       primary key, primary keys\r
 338       primarykey, primarykeys\r
 339       database primary key, database primary keys\r
 340       databaseprimarykey, databaseprimarykeys\r
 341       db primary key, db primary keys\r
 342       dbprimarykey, dbprimarykeys\r
 343 \r
 344 \r
 345 Topic Type: Database Cursor\r
 346 \r
 347    Plural: Database Cursors\r
 348    Keywords:\r
 349       cursor, cursors\r
 350       database cursor, database cursors\r
 351       databasecursor, databasecursors\r
 352       db cursor, db cursors\r
 353       dbcursor, dbcursors\r
 354 \r
 355 \r
 356 Topic Type: Database Trigger\r
 357 \r
 358    Plural: Database Triggers\r
 359    Keywords:\r
 360       trigger, triggers\r
 361       database trigger, database triggers\r
 362       databasetrigger, databasetriggers\r
 363       db trigger, db triggers\r
 364       dbtrigger, dbtriggers\r
 365 \r
 366 \r
 367 Topic Type: Cookie\r
 368 \r
 369    Plural: Cookies\r
 370    Scope: Always global\r
 371 \r
 372    Keywords:\r
 373       cookie, cookies\r
 374 \r
 375 \r
 376 Topic Type: Build Target\r
 377 \r
 378    Plural: Build Targets\r
 379    Keywords:\r
 380       target, targets\r
 381       build target, build targets\r
 382       buildtarget, buildtargets\r