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