xref: /aoo41x/main/autodoc/source/parser/inc/x_docu.hxx (revision 1c78a5d6)
1*1c78a5d6SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*1c78a5d6SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*1c78a5d6SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*1c78a5d6SAndrew Rist  * distributed with this work for additional information
6*1c78a5d6SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*1c78a5d6SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*1c78a5d6SAndrew Rist  * "License"); you may not use this file except in compliance
9*1c78a5d6SAndrew Rist  * with the License.  You may obtain a copy of the License at
10*1c78a5d6SAndrew Rist  *
11*1c78a5d6SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*1c78a5d6SAndrew Rist  *
13*1c78a5d6SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*1c78a5d6SAndrew Rist  * software distributed under the License is distributed on an
15*1c78a5d6SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*1c78a5d6SAndrew Rist  * KIND, either express or implied.  See the License for the
17*1c78a5d6SAndrew Rist  * specific language governing permissions and limitations
18*1c78a5d6SAndrew Rist  * under the License.
19*1c78a5d6SAndrew Rist  *
20*1c78a5d6SAndrew Rist  *************************************************************/
21*1c78a5d6SAndrew Rist 
22*1c78a5d6SAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef ADC_X_DOCU_HXX
25cdf0e10cSrcweir #define ADC_X_DOCU_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir // BASE CLASSES
28cdf0e10cSrcweir #include <autodoc/x_parsing.hxx>
29cdf0e10cSrcweir 
30cdf0e10cSrcweir 
31cdf0e10cSrcweir 
32cdf0e10cSrcweir 
33cdf0e10cSrcweir class X_Docu : public autodoc::X_Parser_Ifc
34cdf0e10cSrcweir {
35cdf0e10cSrcweir   public:
36cdf0e10cSrcweir 	// LIFECYCLE
37cdf0e10cSrcweir 						X_Docu(
38cdf0e10cSrcweir 							const char *        i_tag,
39cdf0e10cSrcweir                             const char *        i_explanation );
40cdf0e10cSrcweir                         ~X_Docu();
41cdf0e10cSrcweir 	// INQUIRY
42cdf0e10cSrcweir 	virtual E_Event	   	GetEvent() const;
43cdf0e10cSrcweir 	virtual void	   	GetInfo(
44cdf0e10cSrcweir 							std::ostream &      o_rOutputMedium ) const;
45cdf0e10cSrcweir 
46cdf0e10cSrcweir   private:
47cdf0e10cSrcweir 	String 				sTagName;
48cdf0e10cSrcweir 	String 				sExplanation;
49cdf0e10cSrcweir };
50cdf0e10cSrcweir 
51cdf0e10cSrcweir 
52cdf0e10cSrcweir 
53cdf0e10cSrcweir 
54cdf0e10cSrcweir #endif
55