Doc.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// 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
// (at your option) 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/>.
 
 
#ifndef _GranOO_libCore_Doc_hpp_
#define _GranOO_libCore_Doc_hpp_
 
#include <vector>
#include <string>
 
 
namespace GranOO3
{
  namespace Core
  {
 
    // Main class to store and display GranOO's documentation
 
    class Doc
    {
 
      // Static members (main interface)
 
    public:
      static bool add(const std::string& section, const std::string& subsection,
                      const std::string& file_name, const std::string& description);
 
      static bool add(const std::string& section,
                      const std::string& file_name, const std::string& description);
 
      static std::string list(const std::vector<Doc>&, bool desc);
      static std::string list_all(bool desc);
      static std::string list_section(const std::string base_regexp, bool desc);
      static std::string list_subsection(const std::string child_regexp, const std::string base_regexp, bool desc);
      static std::vector<Doc> get_section(const std::string base_regexp);
 
    private:
      static std::vector<Doc>& all();
 
    public:
      // For section and subsection description
      Doc(const std::string&, const std::string&, const std::string&, const std::string&);
      // For section description
      Doc(const std::string&, const std::string&, const std::string&);
 
    public:
      const std::string section;
      const std::string subsection;
      const std::string file_name;
      const std::string description;
      const bool subsection_description;
    };
 
 
 
  }
}
 
#endif