doc-string.h

// Copyright (c) 2020-now by the Zeek Project. See LICENSE for details.
 
#pragma once
 
#include <string>
#include <vector>
 
#include <hilti/compiler/printer.h>
 
namespace hilti {
 
class DocString {
public:
    const auto& summary() const { return _summary; }
 
    const auto& text() const { return _text; }
 
    void addSummary(const std::string& line) { _summary.push_back(_normalize(line)); }
 
    void addText(const std::string& line) { _text.push_back(_normalize(line)); }
 
    void print(std::ostream& out) const;
 
    void print(hilti::printer::Stream& out) const;
 
    std::string dump() const;
 
    explicit operator bool() const { return ! (_summary.empty() && _text.empty()); }
 
private:
    // Removes any comment prefix from a line.
    std::string _normalize(const std::string& line) const;
 
    std::vector<std::string> _summary;
    std::vector<std::string> _text;
};
 
} // namespace hilti