1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski #ifndef ADC_DOC_DEAL_HXX
25*b1cdbd2cSJim Jagielski #define ADC_DOC_DEAL_HXX
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski // BASE CLASSES
28*b1cdbd2cSJim Jagielski #include <tokens/tokproct.hxx>
29*b1cdbd2cSJim Jagielski // USED SERVICES
30*b1cdbd2cSJim Jagielski #include <ary/cpp/c_types4cpp.hxx>
31*b1cdbd2cSJim Jagielski
32*b1cdbd2cSJim Jagielski namespace ary
33*b1cdbd2cSJim Jagielski {
34*b1cdbd2cSJim Jagielski namespace doc
35*b1cdbd2cSJim Jagielski {
36*b1cdbd2cSJim Jagielski class OldCppDocu;
37*b1cdbd2cSJim Jagielski }
38*b1cdbd2cSJim Jagielski }
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski class DocuDealer
44*b1cdbd2cSJim Jagielski {
45*b1cdbd2cSJim Jagielski public:
46*b1cdbd2cSJim Jagielski // INQUIRY
~DocuDealer()47*b1cdbd2cSJim Jagielski virtual ~DocuDealer() {}
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski // OPERATIONS
50*b1cdbd2cSJim Jagielski /** @descr
51*b1cdbd2cSJim Jagielski This distributes the let_drDocu to the matching ary::RepositoryEntity .
52*b1cdbd2cSJim Jagielski
53*b1cdbd2cSJim Jagielski If the docu is not inline, it will be saved and later given to the next
54*b1cdbd2cSJim Jagielski ary::CodeEntity. Or it will be discarded, if there does not come a matching
55*b1cdbd2cSJim Jagielski ary::CodeEntity .
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski If the docu is inline after a function header or after an enum value
58*b1cdbd2cSJim Jagielski or after a function parameter or after a base class, it will be stored
59*b1cdbd2cSJim Jagielski together with the matching function, enum value, parameter or base class.
60*b1cdbd2cSJim Jagielski
61*b1cdbd2cSJim Jagielski If the documentation is @file or @project or @glos(sary) it will be
62*b1cdbd2cSJim Jagielski stored at the matching ary::cpp::FileGroup, ary::cpp::ProjectGroup
63*b1cdbd2cSJim Jagielski or ary::Glossary.
64*b1cdbd2cSJim Jagielski */
65*b1cdbd2cSJim Jagielski void TakeDocu(
66*b1cdbd2cSJim Jagielski DYN ary::doc::OldCppDocu &
67*b1cdbd2cSJim Jagielski let_drInfo );
68*b1cdbd2cSJim Jagielski private:
69*b1cdbd2cSJim Jagielski virtual void do_TakeDocu(
70*b1cdbd2cSJim Jagielski DYN ary::doc::OldCppDocu &
71*b1cdbd2cSJim Jagielski let_drInfo ) = 0;
72*b1cdbd2cSJim Jagielski };
73*b1cdbd2cSJim Jagielski
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski // IMPLEMENTATION
78*b1cdbd2cSJim Jagielski inline void
TakeDocu(DYN ary::doc::OldCppDocu & let_drInfo)79*b1cdbd2cSJim Jagielski DocuDealer::TakeDocu( DYN ary::doc::OldCppDocu & let_drInfo )
80*b1cdbd2cSJim Jagielski { do_TakeDocu(let_drInfo); }
81*b1cdbd2cSJim Jagielski
82*b1cdbd2cSJim Jagielski
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski
85*b1cdbd2cSJim Jagielski #endif
86