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 ADC_DOC_DEAL_HXX
29*cdf0e10cSrcweir #define ADC_DOC_DEAL_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir // BASE CLASSES
32*cdf0e10cSrcweir #include <tokens/tokproct.hxx>
33*cdf0e10cSrcweir // USED SERVICES
34*cdf0e10cSrcweir #include <ary/cpp/c_types4cpp.hxx>
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir namespace ary
37*cdf0e10cSrcweir {
38*cdf0e10cSrcweir namespace doc
39*cdf0e10cSrcweir {
40*cdf0e10cSrcweir     class OldCppDocu;
41*cdf0e10cSrcweir }
42*cdf0e10cSrcweir }
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir 
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir class DocuDealer
48*cdf0e10cSrcweir {
49*cdf0e10cSrcweir   public:
50*cdf0e10cSrcweir     // INQUIRY
51*cdf0e10cSrcweir 	virtual				~DocuDealer() {}
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir     // OPERATIONS
54*cdf0e10cSrcweir     /** @descr
55*cdf0e10cSrcweir         This distributes the let_drDocu to the matching ary::RepositoryEntity .
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir         If the docu is not inline, it will be saved and later given to the next
58*cdf0e10cSrcweir         ary::CodeEntity. Or it will be discarded, if there does not come a matching
59*cdf0e10cSrcweir         ary::CodeEntity .
60*cdf0e10cSrcweir 
61*cdf0e10cSrcweir         If the docu is inline after a function header or after an enum value
62*cdf0e10cSrcweir         or after a function parameter or after a base class, it will be stored
63*cdf0e10cSrcweir         together with the matching function, enum value, parameter or base class.
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir         If the documentation is @file or @project or @glos(sary) it will be
66*cdf0e10cSrcweir         stored at the matching ary::cpp::FileGroup, ary::cpp::ProjectGroup
67*cdf0e10cSrcweir         or ary::Glossary.
68*cdf0e10cSrcweir     */
69*cdf0e10cSrcweir     void                TakeDocu(
70*cdf0e10cSrcweir                             DYN ary::doc::OldCppDocu &
71*cdf0e10cSrcweir                                                 let_drInfo );
72*cdf0e10cSrcweir   private:
73*cdf0e10cSrcweir     virtual void        do_TakeDocu(
74*cdf0e10cSrcweir                             DYN ary::doc::OldCppDocu &
75*cdf0e10cSrcweir                                                 let_drInfo ) = 0;
76*cdf0e10cSrcweir };
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir 
81*cdf0e10cSrcweir // IMPLEMENTATION
82*cdf0e10cSrcweir inline void
83*cdf0e10cSrcweir DocuDealer::TakeDocu( DYN ary::doc::OldCppDocu & let_drInfo )
84*cdf0e10cSrcweir     { do_TakeDocu(let_drInfo); }
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir 
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir 
89*cdf0e10cSrcweir #endif
90