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