1 /* 2 * Copyright (C) 2018 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef DOC_COMMENT_H_ 18 19 #define DOC_COMMENT_H_ 20 21 #include <hidl-util/Formatter.h> 22 23 #include <string> 24 25 namespace android { 26 27 struct DocComment { 28 DocComment(const std::string& comment); 29 30 void merge(const DocComment* comment); 31 32 void emit(Formatter& out) const; 33 34 private: 35 std::string mComment; 36 }; 37 38 struct DocCommentable { setDocCommentDocCommentable39 void setDocComment(const DocComment* docComment) { mDocComment = docComment; } emitDocCommentDocCommentable40 void emitDocComment(Formatter& out) const { 41 if (mDocComment != nullptr) { 42 mDocComment->emit(out); 43 } 44 } 45 46 protected: getDocCommentDocCommentable47 const DocComment* getDocComment() const { return mDocComment; } 48 49 private: 50 const DocComment* mDocComment = nullptr; 51 }; 52 53 } // namespace android 54 55 #endif // DOC_COMMENT_H_ 56