1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  *   http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
20 #ifndef T_DOC_H
21 #define T_DOC_H
22 
23 #include "thrift/globals.h"
24 #include "thrift/logging.h"
25 
26 /**
27  * Documentation stubs
28  *
29  */
30 class t_doc {
31 
32 public:
t_doc()33   t_doc() : has_doc_(false) {}
34   virtual ~t_doc() = default;
35 
set_doc(const std::string & doc)36   void set_doc(const std::string& doc) {
37     doc_ = doc;
38     has_doc_ = true;
39     if ((g_program_doctext_lineno == g_doctext_lineno)
40         && (g_program_doctext_status == STILL_CANDIDATE)) {
41       g_program_doctext_status = ALREADY_PROCESSED;
42       pdebug("%s", "program doctext set to ALREADY_PROCESSED");
43     }
44   }
45 
get_doc()46   const std::string& get_doc() const { return doc_; }
47 
has_doc()48   bool has_doc() { return has_doc_; }
49 
50 private:
51   std::string doc_;
52   bool has_doc_;
53 };
54 
55 #endif
56