autodoc/source/parser/inc/x_docu.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ADC_X_DOCU_HXX
  21 #define ADC_X_DOCU_HXX
  22
  23 // BASE CLASSES
  24 #include <autodoc/x_parsing.hxx>
  25
  26
  27
  28
  29 class X_Docu : public autodoc::X_Parser_Ifc
  30 {
  31   public:
  32     // LIFECYCLE
  33                         X_Docu(
  34                             const char *        i_tag,
  35                             const char *        i_explanation );
  36                         ~X_Docu();
  37     // INQUIRY
  38     virtual E_Event     GetEvent() const;
  39     virtual void        GetInfo(
  40                             std::ostream &      o_rOutputMedium ) const;
  41
  42   private:
  43     String              sTagName;
  44     String              sExplanation;
  45 };
  46
  47
  48
  49
  50 #endif
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */