xref: /aoo42x/main/autodoc/inc/ary/cpp/c_cppentity.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_CPP_C_CPPENTITY_HXX
25cdf0e10cSrcweir #define ARY_CPP_C_CPPENTITY_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir 
28cdf0e10cSrcweir 
29cdf0e10cSrcweir // USED SERVICES
30cdf0e10cSrcweir     // BASE CLASSES
31cdf0e10cSrcweir #include <ary/entity.hxx>
32cdf0e10cSrcweir     // OTHER
33cdf0e10cSrcweir #include <ary/doc/d_docu.hxx>
34cdf0e10cSrcweir 
35cdf0e10cSrcweir 
36cdf0e10cSrcweir 
37cdf0e10cSrcweir namespace ary
38cdf0e10cSrcweir {
39cdf0e10cSrcweir namespace cpp
40cdf0e10cSrcweir {
41cdf0e10cSrcweir 
42cdf0e10cSrcweir 
43cdf0e10cSrcweir /** A C++ code entity as parsed by Autodoc.
44cdf0e10cSrcweir */
45cdf0e10cSrcweir class CppEntity : public Entity
46cdf0e10cSrcweir {
47cdf0e10cSrcweir   public:
48cdf0e10cSrcweir     // LIFECYCLE
~CppEntity()49cdf0e10cSrcweir     virtual             ~CppEntity() {}
50cdf0e10cSrcweir 
51cdf0e10cSrcweir     // OPERATIONS
52cdf0e10cSrcweir 
53cdf0e10cSrcweir     // INQUIRY
54cdf0e10cSrcweir     const ary::doc::Documentation &
55cdf0e10cSrcweir                         Docu() const;
56cdf0e10cSrcweir     // ACCESS
57cdf0e10cSrcweir     void                Set_Docu(
58cdf0e10cSrcweir                             DYN ary::doc::Node &
59cdf0e10cSrcweir                                                 pass_docudata );
60cdf0e10cSrcweir   private:
61cdf0e10cSrcweir     // DATA
62cdf0e10cSrcweir 	ary::doc::Documentation
63cdf0e10cSrcweir 	                    aDocu;
64cdf0e10cSrcweir };
65cdf0e10cSrcweir 
66cdf0e10cSrcweir 
67cdf0e10cSrcweir 
68cdf0e10cSrcweir 
69cdf0e10cSrcweir // IMPLEMENTATION
70cdf0e10cSrcweir inline const doc::Documentation &
Docu() const71cdf0e10cSrcweir CppEntity::Docu() const
72cdf0e10cSrcweir {
73cdf0e10cSrcweir     return aDocu;
74cdf0e10cSrcweir }
75cdf0e10cSrcweir 
76cdf0e10cSrcweir inline void
Set_Docu(ary::doc::Node & pass_docudata)77cdf0e10cSrcweir CppEntity::Set_Docu(ary::doc::Node & pass_docudata)
78cdf0e10cSrcweir {
79cdf0e10cSrcweir     aDocu.Set_Data(pass_docudata);
80cdf0e10cSrcweir }
81cdf0e10cSrcweir 
82cdf0e10cSrcweir 
83cdf0e10cSrcweir 
84cdf0e10cSrcweir 
85cdf0e10cSrcweir }   // namespace cpp
86cdf0e10cSrcweir }   // namespace ary
87cdf0e10cSrcweir #endif
88