autodoc/inc/ary/cpp/c_cppentity.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: c_cppentity.hxx,v $
  10  * $Revision: 1.3 $
  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 ARY_CPP_C_CPPENTITY_HXX
  32 #define ARY_CPP_C_CPPENTITY_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <ary/entity.hxx>
  39     // OTHER
  40 #include <ary/doc/d_docu.hxx>
  41
  42
  43
  44 namespace ary
  45 {
  46 namespace cpp
  47 {
  48
  49
  50 /** A C++ code entity as parsed by Autodoc.
  51 */
  52 class CppEntity : public Entity
  53 {
  54   public:
  55     // LIFECYCLE
  56     virtual             ~CppEntity() {}
  57
  58     // OPERATIONS
  59
  60     // INQUIRY
  61     const ary::doc::Documentation &
  62                         Docu() const;
  63     // ACCESS
  64     void                Set_Docu(
  65                             DYN ary::doc::Node &
  66                                                 pass_docudata );
  67   private:
  68     // DATA
  69     ary::doc::Documentation
  70                         aDocu;
  71 };
  72
  73
  74
  75
  76 // IMPLEMENTATION
  77 inline const doc::Documentation &
  78 CppEntity::Docu() const
  79 {
  80     return aDocu;
  81 }
  82
  83 inline void
  84 CppEntity::Set_Docu(ary::doc::Node & pass_docudata)
  85 {
  86     aDocu.Set_Data(pass_docudata);
  87 }
  88
  89
  90
  91
  92 }   // namespace cpp
  93 }   // namespace ary
  94 #endif