xref: /aoo42x/main/autodoc/inc/ary/info/inftypes.hxx (revision 1c78a5d6)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ARY_INFO_INFTYPES_HXX
25 #define ARY_INFO_INFTYPES_HXX
26 
27 
28 // USED SERVICES
29 	// BASE CLASSES
30 	// COMPONENTS
31 	// PARAMETERS
32 
33 
34 namespace ary
35 {
36 namespace info
37 {
38 
39 
40 
41 
42 typedef uintt GlobalTextId;
43 
44 
45 
46 /** Because this enum is used as index list for displayed
47     tag headlines, the items must neither be moved nor deleted.
48     Only adding to the end is allowed. atid_MAX always has to exist
49     and to be the last used value.
50     Also assigning numbers to the values is forbidden.
51 */
52 enum E_AtTagId
53 {
54 	atid_ATT = 0,
55 	atid_author,
56 	atid_change,
57 	atid_collab,
58 	atid_contact,
59 
60 	atid_copyright,
61     atid_deprecated,
62 	atid_descr,
63 	atid_docdate,
64 	atid_derive,
65 
66 	atid_dyn,
67 	atid_instance,
68 	atid_interface,
69 	atid_invariant,
70 	atid_life,
71 
72 	atid_multi,
73 	atid_onerror,
74 	atid_persist,
75 	atid_postcond,
76 	atid_precond,
77 
78 	atid_resp,
79 	atid_return,
80 	atid_short,
81 	atid_todo,
82 	atid_version,
83 
84 	atid_MAX
85 };
86 
87 /** Because this enum is used as index list for displayed
88     tag headlines, the items must neither be moved nor deleted.
89     Only adding to the end is allowed. C_eAtTag_NrOfClasses always has to exist
90     and to be the last used value.
91     Also assigning other numbers to the values, than in this
92     existing scheme, is forbidden.
93 */
94 enum E_AtTagClass
95 {
96 	atc_std = 0,
97 
98 	atc_base = atid_MAX,
99 	atc_exception = atid_MAX + 1,
100 	atc_implements = atid_MAX + 2,
101 	atc_keyword = atid_MAX + 3,
102 	atc_parameter = atid_MAX + 4,
103 
104 	atc_see = atid_MAX + 5,
105 	atc_template = atid_MAX + 6,
106 	atc_label = atid_MAX + 7,
107 	atc_since = atid_MAX + 8,
108 	C_eAtTag_NrOfClasses
109 };
110 
111 
112 
113 }   // namespace info
114 }   // namespace ary
115 
116 
117 #endif
118 
119