tools/NaturaldocsGeneration/Topics.txt

#///////////////////////////////////////////////////////////////////////////////
#// Copyright (c) 2000-2019 Ericsson Telecom AB                               //
#//                                                                           //
#// All rights reserved. This program and the accompanying materials          //
#// are made available under the terms of the Eclipse Public License v2.0     //
#// which accompanies this distribution, and is available at                  //
#// https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html                                 //
#///////////////////////////////////////////////////////////////////////////////
Format: 1.35

# This is the Natural Docs topics file for this project.  If you change anything
# here, it will apply to THIS PROJECT ONLY.  If you'd like to change something
# for all your projects, edit the Topics.txt in Natural Docs' Config directory
# instead.


Ignore Keywords: 
   note, notes


#-------------------------------------------------------------------------------
# SYNTAX:
#
# Topic Type: [name]
# Alter Topic Type: [name]
#    Creates a new topic type or alters one from the main file.  Each type gets
#    its own index and behavior settings.  Its name can have letters, numbers,
#    spaces, and these charaters: - / . '
#
# Plural: [name]
#    Sets the plural name of the topic type, if different.
#
# Keywords:
#    [keyword]
#    [keyword], [plural keyword]
#    ...
#    Defines or adds to the list of keywords for the topic type.  They may only
#    contain letters, numbers, and spaces and are not case sensitive.  Plural
#    keywords are used for list topics.  You can redefine keywords found in the
#    main topics file.
#
# Index: [yes|no]
#    Whether the topics get their own index.  Defaults to yes.  Everything is
#    included in the general index regardless of this setting.
#
# Scope: [normal|start|end|always global]
#    How the topics affects scope.  Defaults to normal.
#    normal        - Topics stay within the current scope.
#    start         - Topics start a new scope for all the topics beneath it,
#                    like class topics.
#    end           - Topics reset the scope back to global for all the topics
#                    beneath it.
#    always global - Topics are defined as global, but do not change the scope
#                    for any other topics.
#
# Class Hierarchy: [yes|no]
#    Whether the topics are part of the class hierarchy.  Defaults to no.
#
# Variable Type: [yes|no]
#    Whether the topics can be a variable type.  Defaults to no.
#
# Page Title If First: [yes|no]
#    Whether the topic's title becomes the page title if it's the first one in
#    a file.  Defaults to no.
#
# Break Lists: [yes|no]
#    Whether list topics should be broken into individual topics in the output.
#    Defaults to no.
#
# Can Group With: [type], [type], ...
#    Defines a list of topic types that this one can possibly be grouped with.
#    Defaults to none.
#-------------------------------------------------------------------------------

# The following topics are defined in the main file, if you'd like to alter
# their behavior or add keywords:
#
#    Generic, Class, Interface, Section, File, Group, Function, Variable,
#    Property, Type, Constant, Enumeration, Event, Delegate, Macro,
#    Database, Database Table, Database View, Database Index, Database
#    Cursor, Database Trigger, Cookie, Build Target

# If you add something that you think would be useful to other developers
# and should be included in Natural Docs by default, please e-mail it to
# topics [at] naturaldocs [dot] org.


Topic Type: Testcase

   Plural: Testcases
   Keywords:
      testcase, testcases
      testcasefunction, testcasefunctions


Topic Type: RequirementTestcase

   Plural: RequirementTestcases
   Keywords:
      requirementtestcase, requirementtestcases


Topic Type: RequirementFunction

   Plural: RequirementFunctions
   Keywords:
      requirementfunction, requirementfunctions


Topic Type: Procedure

   Plural: Procedures
   Keywords:
      procedure, procedures


Topic Type: RequirementProcedure

   Plural: RequirementProcedures
   Keywords:
      requirementprocedure, requirementprocedures


Topic Type: Primitive

   Plural: Primitives
   Keywords:
      primitive, primitives


Topic Type: Altstep

   Plural: Altsteps
   Keywords:
      altstep, altsteps


Topic Type: Private Function

   Plural: Private Functions
   Keywords:
      private function, private functions


Topic Type: RequirementAltstep

   Plural: RequirementAltsteps
   Keywords:
      requirementaltstep, requirementaltsteps


Topic Type: Template

   Plural: Templates
   Keywords:
      template, templates


Topic Type: RequirementType

   Plural: RequirementTypes
   Keywords:
      requirementtype, requirementtypes


Alter Topic Type: Group

   Plural: Groups
   Index: No

   Add Keywords:
      group


Alter Topic Type: Generic



Alter Topic Type: File

   Add Keywords:
      module
      asnmodule


Topic Type: AsnType

   Plural: AsnTypes
   Keywords:
      asntype, asntypes


Topic Type: Component

   Plural: Components
   Keywords:
      component, components