xref: /AOO41X/main/autodoc/source/parser_i/inc/s2_dsapi/tk_atag2.hxx (revision 1c78a5d6c0093dece4c096ba53051800fbad6e33)
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 DSAPI_TK_ATAG2_HXX
25 #define DSAPI_TK_ATAG2_HXX
26 
27 // USED SERVICES
28     // BASE CLASSES
29 #include <s2_dsapi/dsapitok.hxx>
30     // COMPONENTS
31     // PARAMETERS
32 #include <luxenum.hxx>
33 
34 namespace csi
35 {
36 namespace dsapi
37 {
38 
39 
40 class Tok_AtTag : public Token
41 {
42   public:
43     // TYPE
44     enum E_TokenId
45     {
46         e_none = 0,
47         author =  1,
48         see = 2,
49         param = 3,
50         e_return = 4,
51         e_throw = 5,
52         example = 6,
53         deprecated = 7,
54         suspicious = 8,
55         missing = 9,
56         incomplete = 10,
57         version = 11,
58         guarantees = 12,
59         exception = 13,
60         since = 14
61     };
62     typedef lux::Enum<E_TokenId> EV_TokenId;
63 
64     // Spring and Fall
Tok_AtTag(EV_TokenId i_eTag)65                         Tok_AtTag(
66                             EV_TokenId          i_eTag )
67                                                 :   eTag(i_eTag) {}
68     // OPERATIONS
69     virtual void        Trigger(
70                             TokenInterpreter &  io_rInterpreter ) const;
71     // INQUIRY
72     virtual const char* Text() const;
Id() const73     E_TokenId           Id() const              { return eTag; }
74 
75   private:
76     EV_TokenId          eTag;
77 };
78 
79 }   // namespace dsapi
80 }   // namespace csi
81 
82 
83 #endif
84 
85