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_X_DOCU_HXX
25*b1cdbd2cSJim Jagielski #define ADC_X_DOCU_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski // BASE CLASSES
28*b1cdbd2cSJim Jagielski #include <autodoc/x_parsing.hxx>
29*b1cdbd2cSJim Jagielski 
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski 
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski class X_Docu : public autodoc::X_Parser_Ifc
34*b1cdbd2cSJim Jagielski {
35*b1cdbd2cSJim Jagielski   public:
36*b1cdbd2cSJim Jagielski 	// LIFECYCLE
37*b1cdbd2cSJim Jagielski 						X_Docu(
38*b1cdbd2cSJim Jagielski 							const char *        i_tag,
39*b1cdbd2cSJim Jagielski                             const char *        i_explanation );
40*b1cdbd2cSJim Jagielski                         ~X_Docu();
41*b1cdbd2cSJim Jagielski 	// INQUIRY
42*b1cdbd2cSJim Jagielski 	virtual E_Event	   	GetEvent() const;
43*b1cdbd2cSJim Jagielski 	virtual void	   	GetInfo(
44*b1cdbd2cSJim Jagielski 							std::ostream &      o_rOutputMedium ) const;
45*b1cdbd2cSJim Jagielski 
46*b1cdbd2cSJim Jagielski   private:
47*b1cdbd2cSJim Jagielski 	String 				sTagName;
48*b1cdbd2cSJim Jagielski 	String 				sExplanation;
49*b1cdbd2cSJim Jagielski };
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski 
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski #endif
55