autodoc/source/parser/inc/x_docu.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: x_parse.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_X_DOCU_HXX
  32 #define ADC_X_DOCU_HXX
  33
  34 // BASE CLASSES
  35 #include <autodoc/x_parsing.hxx>
  36
  37
  38
  39
  40 class X_Docu : public autodoc::X_Parser_Ifc
  41 {
  42   public:
  43     // LIFECYCLE
  44                         X_Docu(
  45                             const char *        i_tag,
  46                             const char *        i_explanation );
  47                         ~X_Docu();
  48     // INQUIRY
  49     virtual E_Event             GetEvent() const;
  50     virtual void                GetInfo(
  51                             std::ostream &      o_rOutputMedium ) const;
  52
  53   private:
  54     String                              sTagName;
  55     String                              sExplanation;
  56 };
  57
  58
  59
  60
  61 #endif