blob: e52068cb49b88b7ac5706280d1da893de49bef04 [file] [log] [blame]
David Reissea2cba82009-03-30 21:35:00 +00001/*
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 */
Mark Sleee9ce01c2007-05-16 02:29:53 +000019
Mark Slee74eea202007-02-05 21:47:03 +000020#ifndef T_DOC_H
21#define T_DOC_H
22
23/**
Mark Sleee9ce01c2007-05-16 02:29:53 +000024 * Documentation stubs
Mark Slee74eea202007-02-05 21:47:03 +000025 *
Mark Slee74eea202007-02-05 21:47:03 +000026 */
27class t_doc {
28
Mark Sleee9ce01c2007-05-16 02:29:53 +000029 public:
David Reissc2532a92007-07-30 23:46:11 +000030 t_doc() : has_doc_(false) {}
31
Mark Sleee9ce01c2007-05-16 02:29:53 +000032 void set_doc(const std::string& doc) {
33 doc_ = doc;
34 has_doc_ = true;
35 }
David Reiss0c90f6f2008-02-06 22:18:40 +000036
Mark Sleee9ce01c2007-05-16 02:29:53 +000037 const std::string& get_doc() const {
38 return doc_;
39 }
David Reiss0c90f6f2008-02-06 22:18:40 +000040
Mark Sleee9ce01c2007-05-16 02:29:53 +000041 bool has_doc() {
42 return has_doc_;
43 }
David Reiss0c90f6f2008-02-06 22:18:40 +000044
Mark Sleee9ce01c2007-05-16 02:29:53 +000045 private:
46 std::string doc_;
47 bool has_doc_;
Mark Slee74eea202007-02-05 21:47:03 +000048
49};
50
51#endif