diff options
Diffstat (limited to 'tools/intergen/cppgen/include/cppgen/comment.h')
-rw-r--r-- | tools/intergen/cppgen/include/cppgen/comment.h | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/tools/intergen/cppgen/include/cppgen/comment.h b/tools/intergen/cppgen/include/cppgen/comment.h new file mode 100644 index 0000000000..f4fdfb45ed --- /dev/null +++ b/tools/intergen/cppgen/include/cppgen/comment.h @@ -0,0 +1,61 @@ +/** + * Copyright (c) 2014, Ford Motor Company + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following + * disclaimer in the documentation and/or other materials provided with the + * distribution. + * + * Neither the name of the Ford Motor Company nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef COMMENT_H_ +#define COMMENT_H_ + +#include <iosfwd> + +#include "utils/common_types.h" + +namespace codegen { + +// Class that represents C++ comment that can easily be output to +// ostream, +// comment text is wrapped with C++ comment marks (//) or /star automatically +class Comment { + public: + // Create comment object from Description collected from xml + explicit Comment(const Description& description); + // Create single-line comment from string + explicit Comment(const std::string& text); + ~Comment(); + private: + Description description_; + friend std::ostream& operator<<(std::ostream& os, const Comment& comment); +}; + +std::ostream& operator<<(std::ostream& os, const Comment& comment); + +} // namespace codegen + +#endif /* COMMENT_H_ */ |