← Back to branch summary

~mortenoh/+junk/dhis2-detailed-import-export

« back to all changes in this revision

Viewing changes to gis/dhis-gis-geostat/mfbase/openlayers/apidoc_config/Topics.txt

  • Committer: larshelge at gmail
  • Date: 2009-03-03 16:46:36 UTC
  • Revision ID: larshelge@gmail.com-20090303164636-2sjlrquo7ib1gf7r
Initial check-in

Show diffs side-by-side

added added

removed removed

Lines of Context:
gis/dhis-gis-geostat/mfbase/openlayers/apidoc_config/Topics.txt
 
1
Format: Development Release 12-07-2007 (1.35 base)
 
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
Ignore Keywords: 
 
10
   function, functions
 
11
   func, funcs
 
12
   procedure, procedures
 
13
   proc, procs
 
14
   routine, routines
 
15
   subroutine, subroutines
 
16
   sub, subs
 
17
   method, methods
 
18
   callback, callbacks
 
19
   property, properties
 
20
   prop, props
 
21
 
 
22
 
 
23
#-------------------------------------------------------------------------------
 
24
# SYNTAX:
 
25
#
 
26
# Topic Type: [name]
 
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: - / . '
 
31
#
 
32
# Plural: [name]
 
33
#    Sets the plural name of the topic type, if different.
 
34
#
 
35
# Keywords:
 
36
#    [keyword]
 
37
#    [keyword], [plural keyword]
 
38
#    ...
 
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
 
42
#    main topics file.
 
43
#
 
44
# Index: [yes|no]
 
45
#    Whether the topics get their own index.  Defaults to yes.  Everything is
 
46
#    included in the general index regardless of this setting.
 
47
#
 
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,
 
52
#                    like class topics.
 
53
#    end           - Topics reset the scope back to global for all the topics
 
54
#                    beneath it.
 
55
#    always global - Topics are defined as global, but do not change the scope
 
56
#                    for any other topics.
 
57
#
 
58
# Class Hierarchy: [yes|no]
 
59
#    Whether the topics are part of the class hierarchy.  Defaults to no.
 
60
#
 
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.
 
64
#
 
65
# Break Lists: [yes|no]
 
66
#    Whether list topics should be broken into individual topics in the output.
 
67
#    Defaults to no.
 
68
#
 
69
# Can Group With: [type], [type], ...
 
70
#    Defines a list of topic types that this one can possibly be grouped with.
 
71
#    Defaults to none.
 
72
#-------------------------------------------------------------------------------
 
73
 
 
74
# The following topics are defined in the main file, if you'd like to alter
 
75
# their behavior or add keywords:
 
76
#
 
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
 
81
 
 
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.
 
85
 
 
86
 
 
87
Topic Type: Constructor
 
88
 
 
89
   Class Hierarchy: Yes
 
90
   Keywords:
 
91
      constructor
 
92
      initialize
 
93
 
 
94
 
 
95
Alter Topic Type: Function
 
96
 
 
97
   Add Keywords:
 
98
      apimethod
 
99
      apifunction
 
100
 
 
101
 
 
102
Alter Topic Type: Property
 
103
 
 
104
   Add Keywords:
 
105
      apiproperty