autodoc/source/parser/inc/doc_deal.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: doc_deal.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ADC_DOC_DEAL_HXX
  32 #define ADC_DOC_DEAL_HXX
  33
  34 // BASE CLASSES
  35 #include <tokens/tokproct.hxx>
  36 // USED SERVICES
  37 #include <ary/cpp/c_types4cpp.hxx>
  38
  39 namespace ary
  40 {
  41 namespace doc
  42 {
  43     class OldCppDocu;
  44 }
  45 }
  46
  47
  48
  49
  50 class DocuDealer
  51 {
  52   public:
  53     // INQUIRY
  54     virtual                             ~DocuDealer() {}
  55
  56     // OPERATIONS
  57     /** @descr
  58         This distributes the let_drDocu to the matching ary::RepositoryEntity .
  59
  60         If the docu is not inline, it will be saved and later given to the next
  61         ary::CodeEntity. Or it will be discarded, if there does not come a matching
  62         ary::CodeEntity .
  63
  64         If the docu is inline after a function header or after an enum value
  65         or after a function parameter or after a base class, it will be stored
  66         together with the matching function, enum value, parameter or base class.
  67
  68         If the documentation is @file or @project or @glos(sary) it will be
  69         stored at the matching ary::cpp::FileGroup, ary::cpp::ProjectGroup
  70         or ary::Glossary.
  71     */
  72     void                TakeDocu(
  73                             DYN ary::doc::OldCppDocu &
  74                                                 let_drInfo );
  75   private:
  76     virtual void        do_TakeDocu(
  77                             DYN ary::doc::OldCppDocu &
  78                                                 let_drInfo ) = 0;
  79 };
  80
  81
  82
  83
  84 // IMPLEMENTATION
  85 inline void
  86 DocuDealer::TakeDocu( DYN ary::doc::OldCppDocu & let_drInfo )
  87     { do_TakeDocu(let_drInfo); }
  88
  89
  90
  91
  92 #endif