xref: /aoo41x/main/autodoc/inc/ary/cpp/c_cppentity.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef ARY_CPP_C_CPPENTITY_HXX
29 #define ARY_CPP_C_CPPENTITY_HXX
30 
31 
32 
33 // USED SERVICES
34     // BASE CLASSES
35 #include <ary/entity.hxx>
36     // OTHER
37 #include <ary/doc/d_docu.hxx>
38 
39 
40 
41 namespace ary
42 {
43 namespace cpp
44 {
45 
46 
47 /** A C++ code entity as parsed by Autodoc.
48 */
49 class CppEntity : public Entity
50 {
51   public:
52     // LIFECYCLE
53     virtual             ~CppEntity() {}
54 
55     // OPERATIONS
56 
57     // INQUIRY
58     const ary::doc::Documentation &
59                         Docu() const;
60     // ACCESS
61     void                Set_Docu(
62                             DYN ary::doc::Node &
63                                                 pass_docudata );
64   private:
65     // DATA
66 	ary::doc::Documentation
67 	                    aDocu;
68 };
69 
70 
71 
72 
73 // IMPLEMENTATION
74 inline const doc::Documentation &
75 CppEntity::Docu() const
76 {
77     return aDocu;
78 }
79 
80 inline void
81 CppEntity::Set_Docu(ary::doc::Node & pass_docudata)
82 {
83     aDocu.Set_Data(pass_docudata);
84 }
85 
86 
87 
88 
89 }   // namespace cpp
90 }   // namespace ary
91 #endif
92