DocumentationGenerator.cpp

Go to the documentation of this file.

/*
 *  CepGen: a central exclusive processes event generator
 *  Copyright (C) 2024  Laurent Forthomme
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "CepGen/Modules/DocumentationGeneratorFactory.h"
#include "CepGen/Utils/DocumentationGenerator.h"
#include "CepGenAddOns/PythonWrapper/ConfigWriter.h"
 
namespace cepgen {
  namespace python {
    class DocumentationGenerator final : public cepgen::utils::DocumentationGenerator {
    public:
      explicit DocumentationGenerator(const ParametersList& params)
          : cepgen::utils::DocumentationGenerator(params), writer_(params_) {}
 
      static ParametersDescription description() {
        auto desc = cepgen::utils::DocumentationGenerator::description();
        desc.setDescription("Python modules documentation generator");
        desc += ConfigWriter::description();
        desc.add<std::string>("filename", "output.py").setDescription("Python output filename");
        desc.add<bool>("camelCaseModuleNames", true);
        return desc;
      }
 
      std::string describe() override {
        for (const auto& cat : categories_) {
          if (cat.second.modules.empty())
            continue;
          for (const auto& mod : cat.second.modules)
            writer_ << mod.second;
        }
        return writer_();
      }
 
    private:
      ConfigWriter writer_;
    };
  }  // namespace python
}  // namespace cepgen
using cepgen::python::DocumentationGenerator;
REGISTER_DOCUMENTATION_GENERATOR("python", DocumentationGenerator);