Line data    Source code

       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             :  * Modifications Copyright (c) Juniper Networks, Inc.
      20             :  * Copyright Contributors to the OpenSDN project
      21             :  */
      22             : 
      23             : #ifndef T_DOC_H
      24             : #define T_DOC_H
      25             : 
      26             : /**
      27             :  * Documentation stubs
      28             :  *
      29             :  */
      30             : class t_doc {
      31             : 
      32             :  public:
      33      187467 :   t_doc() : has_doc_(false) {}
      34             : 
      35       17609 :   void set_doc(const std::string& doc) {
      36       17609 :     doc_ = doc;
      37       17609 :     has_doc_ = true;
      38       17609 :   }
      39             : 
      40         253 :   const std::string& get_doc() const {
      41         253 :     return doc_;
      42             :   }
      43             : 
      44        4276 :   bool has_doc() {
      45        4276 :     return has_doc_;
      46             :   }
      47             : 
      48             :  private:
      49             :   std::string doc_;
      50             :   bool has_doc_;
      51             : 
      52             : };
      53             : 
      54             : #endif