Commit 50a067f0 authored by frey_m's avatar frey_m
Browse files

add doxygen + file header

parent 3a663fd8
//
// Implements the member function of the EarlyLeaveException class.
//
// Copyright (c) 2008-2019
// Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved.
//
// OPAL is licensed under GNU GPL version 3.
//
#include "Utilities/EarlyLeaveException.h"
......
//
// This exception class is used to intentionally exit OPAL even if no
// error occurred. It is used in case of the tune calculation with
// the matched distribution option.
//
// Copyright (c) 2008-2019
// Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved.
//
// OPAL is licensed under GNU GPL version 3.
//
#ifndef OPAL_EARLY_LEAVE_EXCEPTION_HH
#define OPAL_EARLY_LEAVE_EXCEPTION_HH
#include "Utilities/ClassicException.h"
/*!
This exception class is used to inentionally exit OPAL when no error occurred.
*/
class EarlyLeaveException: public ClassicException {
public:
/// The usual constructor.
// Arguments:
// [DL]
// [DT][b]meth[/b]
// [DD]the name of the method or function detecting the exception
// [DT][b]msg [/b]
// [DD]the message string identifying the exception
// [/DL]
/** The usual constructor.
* @param[in] meth the name of the method or function detecting the exception
* @param[in] msg the message string identifying the exception
*/
explicit EarlyLeaveException(const std::string &meth, const std::string &msg);
EarlyLeaveException(const EarlyLeaveException &);
......@@ -30,7 +40,7 @@ public:
private:
// Not implemented.
EarlyLeaveException();
EarlyLeaveException() delete;
};
#endif
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment