1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef ADC_DISPLAY_HFI_DOC_HXX 25*b1cdbd2cSJim Jagielski #define ADC_DISPLAY_HFI_DOC_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski // USED SERVICES 30*b1cdbd2cSJim Jagielski // BASE CLASSES 31*b1cdbd2cSJim Jagielski #include "hi_factory.hxx" 32*b1cdbd2cSJim Jagielski // COMPONENTS 33*b1cdbd2cSJim Jagielski // PARAMETERS 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski class HF_DocEntryList; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski class HF_IdlDocu : public HtmlFactory_Idl 40*b1cdbd2cSJim Jagielski { 41*b1cdbd2cSJim Jagielski public: 42*b1cdbd2cSJim Jagielski HF_IdlDocu( 43*b1cdbd2cSJim Jagielski Environment & io_rEnv, 44*b1cdbd2cSJim Jagielski HF_DocEntryList & o_rOut ); 45*b1cdbd2cSJim Jagielski virtual ~HF_IdlDocu(); 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski /** Produces documentation by the CodeInfo accompanying 49*b1cdbd2cSJim Jagielski ->i_ce. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski void Produce_fromCodeEntity( 52*b1cdbd2cSJim Jagielski const client & i_ce ) const; 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski /** Produces documentation by the CodeInfo accompanying 55*b1cdbd2cSJim Jagielski a link or reference to a CodeEntity. 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski @param i_rScopeGivingCe 58*b1cdbd2cSJim Jagielski Gives the scope from which links are to be calculated. 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielski void Produce_fromReference( 61*b1cdbd2cSJim Jagielski const ce_info & i_rDocuForReference, 62*b1cdbd2cSJim Jagielski const client & i_rScopeGivingCe ) const; 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski private: 65*b1cdbd2cSJim Jagielski // Locals 66*b1cdbd2cSJim Jagielski /** Produces documentation. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param i_rScopeGivingCe 69*b1cdbd2cSJim Jagielski Gives the scope from which links are to be calculated. 70*b1cdbd2cSJim Jagielski */ 71*b1cdbd2cSJim Jagielski void Produce_byDocuAndScope( 72*b1cdbd2cSJim Jagielski const ce_info & i_rDocu, 73*b1cdbd2cSJim Jagielski const client * i_pClient, /// May be 0. 74*b1cdbd2cSJim Jagielski const client & i_rScopeGivingCe ) const; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski // DATA 77*b1cdbd2cSJim Jagielski HF_DocEntryList & rOut; 78*b1cdbd2cSJim Jagielski }; 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski #endif 82