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