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