autodoc/source/display/idl/hfi_doc.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_DISPLAY_HFI_DOC_HXX
  21 #define ADC_DISPLAY_HFI_DOC_HXX
  22
  23
  24
  25 // USED SERVICES
  26     // BASE CLASSES
  27 #include "hi_factory.hxx"
  28     // COMPONENTS
  29     // PARAMETERS
  30
  31
  32 class HF_DocEntryList;
  33
  34
  35 class HF_IdlDocu : public HtmlFactory_Idl
  36 {
  37   public:
  38                         HF_IdlDocu(
  39                             Environment &       io_rEnv,
  40                             HF_DocEntryList &   o_rOut );
  41     virtual             ~HF_IdlDocu();
  42
  43
  44     /** Produces documentation by the CodeInfo accompanying
  45         ->i_ce.
  46     */
  47     void                Produce_fromCodeEntity(
  48                             const client &      i_ce ) const;
  49
  50     /** Produces documentation by the CodeInfo accompanying
  51         a link or reference to a CodeEntity.
  52
  53         @param i_rScopeGivingCe
  54         Gives the scope from which links are to be calculated.
  55     */
  56     void                Produce_fromReference(
  57                             const ce_info &     i_rDocuForReference,
  58                             const client &      i_rScopeGivingCe ) const;
  59
  60   private:
  61     // Locals
  62     /** Produces documentation.
  63
  64         @param i_rScopeGivingCe
  65         Gives the scope from which links are to be calculated.
  66     */
  67     void                Produce_byDocuAndScope(
  68                             const ce_info &     i_rDocu,
  69                             const client *      i_pClient,      /// May be 0.
  70                             const client &      i_rScopeGivingCe ) const;
  71
  72     // DATA
  73     HF_DocEntryList &   rOut;
  74 };
  75
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */