autodoc/inc/ary/idl/ik_function.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: ik_function.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 ARY_IDL_IK_SERVICE_HXX
  32 #define ARY_IDL_IK_SERVICE_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <ary/idl/i_param.hxx>
  39 #include <ary/idl/ik_ce.hxx>
  40     // COMPONENTS
  41     // PARAMETERS
  42
  43
  44 namespace ary
  45 {
  46 namespace idl
  47 {
  48
  49
  50
  51 namespace ifc_function
  52 {
  53
  54 using ::ary::idl::ifc_ce::Dyn_CeIterator;
  55 using ::ary::idl::ifc_ce::Dyn_TypeIterator;
  56 using ::ary::idl::ifc_ce::DocText;
  57
  58
  59 struct attr: public ifc_ce::attr
  60 {
  61     static Type_id      ReturnType(
  62                             const CodeEntity &  i_ce );
  63     static bool         IsOneway(
  64                             const CodeEntity &  i_ce );
  65     static bool         HasEllipse(
  66                             const CodeEntity &  i_ce );
  67     static void         Get_Parameters(
  68                             Dyn_StdConstIterator<ary::idl::Parameter> &
  69                                                 o_result,
  70                             const CodeEntity &  i_ce );
  71     static void         Get_Exceptions(
  72                             Dyn_TypeIterator &  o_result,
  73                             const CodeEntity &  i_ce );
  74 };
  75
  76 struct xref : public ifc_ce::xref
  77 {
  78 };
  79
  80 struct doc : public ifc_ce::doc
  81 {
  82 //      aStateMachine.AddToken( "@param",   nTok_at_param,       A_nAtTagDefStatus, finAtTag );
  83 //      aStateMachine.AddToken( "@throws",  nTok_at_throws,      A_nAtTagDefStatus, finAtTag );
  84 //      aStateMachine.AddToken( "@exception",
  85 //      aStateMachine.AddToken( "@return",  nTok_at_return,      A_nAtTagDefStatus, finAtTag );
  86 //      aStateMachine.AddToken( "@returns", nTok_at_return,      A_nAtTagDefStatus, finAtTag );
  87 };
  88
  89
  90 }   // namespace ifc_function
  91
  92
  93
  94 }   // namespace idl
  95 }   // namespace ary
  96
  97
  98 #endif
  99