ClassDocumentation.h

// -*- C++ -*-
//
// ClassDocumentation.h is a part of ThePEG - Toolkit for HEP Event Generation
// Copyright (C) 1999-2019 Leif Lonnblad
//
// ThePEG is licenced under version 3 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef ThePEG_ClassDocumentation_H
#define ThePEG_ClassDocumentation_H
// This is the declaration of the ClassDocumentation class.

#include "ThePEG/Config/ThePEG.h"
#include "ClassDocumentation.fh"

namespace ThePEG {

class ClassDocumentationBase  {

protected:

  ClassDocumentationBase(string newDocumentation,
                         string newModelDescription,
                         string newModelReferences,
                         const type_info & newTypeInfo);

public:

  virtual ~ClassDocumentationBase() {}

public:

  string documentation() const { return theDocumentation; }

  string modelDescription() const { return theModelDescription; }

  string modelReferences() const { return theModelReferences; }

private:

  string theDocumentation;

  string theModelDescription;

  string theModelReferences;

private:

  ClassDocumentationBase();

  ClassDocumentationBase(const ClassDocumentationBase &);

  ClassDocumentationBase & operator=(const ClassDocumentationBase &) = delete;

};


template <typename T>
class ClassDocumentation: public ClassDocumentationBase {

public:

  ClassDocumentation(string newDocumentation,
                     string newModelDescription = "",
                     string newModelReferences = "")
    : ClassDocumentationBase(newDocumentation, newModelDescription,
                             newModelReferences, typeid(T)) {}

private:

  ClassDocumentation();

  ClassDocumentation(const ClassDocumentation &);

  ClassDocumentation & operator=(const ClassDocumentation &) = delete;

};

}

#endif /* ThePEG_ClassDocumentation_H */