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