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