xref: /aoo41x/main/autodoc/inc/ary/idl/ik_ce.hxx (revision 1c78a5d6)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19*1c78a5d6SAndrew Rist  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ARY_IDL_IK_CE_HXX
25cdf0e10cSrcweir #define ARY_IDL_IK_CE_HXX
26cdf0e10cSrcweir //  KORR_DEPRECATED_3.0
27cdf0e10cSrcweir 
28cdf0e10cSrcweir 
29cdf0e10cSrcweir 
30cdf0e10cSrcweir // USED SERVICES
31cdf0e10cSrcweir 	// BASE CLASSES
32cdf0e10cSrcweir 	// COMPONENTS
33cdf0e10cSrcweir 	// PARAMETERS
34cdf0e10cSrcweir #include <ary/idl/i_types4idl.hxx>
35cdf0e10cSrcweir #include <ary/stdconstiter.hxx>
36cdf0e10cSrcweir 
37cdf0e10cSrcweir namespace ary
38cdf0e10cSrcweir {
39cdf0e10cSrcweir namespace info
40cdf0e10cSrcweir {
41cdf0e10cSrcweir  	class Text;
42cdf0e10cSrcweir }
43cdf0e10cSrcweir namespace idl
44cdf0e10cSrcweir {
45cdf0e10cSrcweir 
46cdf0e10cSrcweir 
47cdf0e10cSrcweir namespace ifc_ce
48cdf0e10cSrcweir {
49cdf0e10cSrcweir 
50cdf0e10cSrcweir 
51cdf0e10cSrcweir typedef ::ary::Dyn_StdConstIterator<Ce_id>      Dyn_CeIterator;
52cdf0e10cSrcweir typedef ::ary::Dyn_StdConstIterator<Type_id>    Dyn_TypeIterator;
53cdf0e10cSrcweir typedef ::ary::info::Text                       DocText;
54cdf0e10cSrcweir 
55cdf0e10cSrcweir 
56cdf0e10cSrcweir 
57cdf0e10cSrcweir struct attr
58cdf0e10cSrcweir {
59cdf0e10cSrcweir     static Ce_id        CeId(
60cdf0e10cSrcweir                             const CodeEntity &  i_ce );
61cdf0e10cSrcweir     static const String &
62cdf0e10cSrcweir                         LocalName(
63cdf0e10cSrcweir                             const CodeEntity &  i_ce );
64cdf0e10cSrcweir     static Ce_id        NameRoom(
65cdf0e10cSrcweir                             const CodeEntity &  i_ce );
66cdf0e10cSrcweir     static Rid          Owner(
67cdf0e10cSrcweir                             const CodeEntity &  i_ce );
68cdf0e10cSrcweir     static E_SightLevel SightLevel(
69cdf0e10cSrcweir                             const CodeEntity &  i_ce );
Search_Memberary::idl::ifc_ce::attr70cdf0e10cSrcweir     static bool         Search_Member(
71cdf0e10cSrcweir                             const CodeEntity &  ,
72cdf0e10cSrcweir                             const String &      )
73cdf0e10cSrcweir                             { return true; }    // KORR_FUTURE
74cdf0e10cSrcweir };
75cdf0e10cSrcweir 
76cdf0e10cSrcweir struct xref
77cdf0e10cSrcweir {
78cdf0e10cSrcweir };
79cdf0e10cSrcweir 
80cdf0e10cSrcweir struct doc
81cdf0e10cSrcweir {
82cdf0e10cSrcweir     static const DocText &
83cdf0e10cSrcweir                         ShortInfo(          /// @return a short description of the CodeEntity
84cdf0e10cSrcweir                             const CodeEntity &  i_ce );
85cdf0e10cSrcweir 
86cdf0e10cSrcweir     static const DocText &
87cdf0e10cSrcweir                         TagAuthor(
88cdf0e10cSrcweir                             const CodeEntity &  i_ce );
89cdf0e10cSrcweir     static const DocText &
90cdf0e10cSrcweir                         TagExample(
91cdf0e10cSrcweir                             const CodeEntity &  i_ce );
92cdf0e10cSrcweir     static const DocText &
93cdf0e10cSrcweir                         TagDescr(
94cdf0e10cSrcweir                             const CodeEntity &  i_ce );
95cdf0e10cSrcweir     static const DocText &
96cdf0e10cSrcweir                         TagGuarantees(
97cdf0e10cSrcweir                             const CodeEntity &  i_ce );
98cdf0e10cSrcweir     static const DocText &
99cdf0e10cSrcweir                         TagKey(
100cdf0e10cSrcweir                             const CodeEntity &  i_ce );
101cdf0e10cSrcweir     static const DocText &
102cdf0e10cSrcweir                         TagMissing(
103cdf0e10cSrcweir                             const CodeEntity &  i_ce );
104cdf0e10cSrcweir     static const DocText &
105cdf0e10cSrcweir                         TagSee(
106cdf0e10cSrcweir                             const CodeEntity &  i_ce );
107cdf0e10cSrcweir     static const DocText &
108cdf0e10cSrcweir                         TagShort(
109cdf0e10cSrcweir                             const CodeEntity &  i_ce );
110cdf0e10cSrcweir     static const DocText &
111cdf0e10cSrcweir                         TagVersion(
112cdf0e10cSrcweir                             const CodeEntity &  i_ce );
113cdf0e10cSrcweir 
114cdf0e10cSrcweir     void                Get_UnkownTags(
115cdf0e10cSrcweir                             Dyn_CeIterator &    o_result,
116cdf0e10cSrcweir                             const CodeEntity &  i_ce );
117cdf0e10cSrcweir 
118cdf0e10cSrcweir     bool                IsDeprecated(
119cdf0e10cSrcweir                             const CodeEntity &  i_ce );
120cdf0e10cSrcweir     bool                IsIncomplete(
121cdf0e10cSrcweir                             const CodeEntity &  i_ce );
122cdf0e10cSrcweir     bool                IsInternal(
123cdf0e10cSrcweir                             const CodeEntity &  i_ce );
124cdf0e10cSrcweir     bool                IsNodoc(
125cdf0e10cSrcweir                             const CodeEntity &  i_ce );
126cdf0e10cSrcweir     bool                IsOptional(
127cdf0e10cSrcweir                             const CodeEntity &  i_ce );
128cdf0e10cSrcweir     bool                IsSuspicious(
129cdf0e10cSrcweir                             const CodeEntity &  i_ce );
130cdf0e10cSrcweir 
131cdf0e10cSrcweir };
132cdf0e10cSrcweir 
133cdf0e10cSrcweir 
134cdf0e10cSrcweir }   // namespace ifc_ce
135cdf0e10cSrcweir 
136cdf0e10cSrcweir 
137cdf0e10cSrcweir }   // namspace idl
138cdf0e10cSrcweir }   // namspace ary
139cdf0e10cSrcweir 
140cdf0e10cSrcweir #endif
141cdf0e10cSrcweir 
142cdf0e10cSrcweir 
143