forked from degauden/Elements
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathPrintProject.h
More file actions
50 lines (42 loc) · 1.73 KB
/
Copy pathPrintProject.h
File metadata and controls
50 lines (42 loc) · 1.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/**
* @file PrintProject.h
* @brief function that displays the current project properties
* @date 2020-05-14
* @author hubert
*
* @copyright 2012-2020 Euclid Science Ground Segment
*
* This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General
* Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
/**
* @addtogroup ElementsExamples ElementsExamples
* @{
*/
#ifndef ELEMENTSEXAMPLES_ELEMENTSEXAMPLES_PRINTPROJECT_H_
#define ELEMENTSEXAMPLES_ELEMENTSEXAMPLES_PRINTPROJECT_H_
#include "ElementsKernel/Export.h"
namespace Elements::Examples {
/**
* @brief Prints the project information to the standard output.
*
* This method retrieves information about the current project, such as its
* name or version, and outputs it to the console. It is a basic utility
* function designed to display project details in a human-readable format.
*
* Usage of this method may be helpful for logging or debugging purposes to
* provide contextual information about the project execution environment.
*/
ELEMENTS_API void printProject();
} // namespace Elements::Examples
#endif // ELEMENTSEXAMPLES_ELEMENTSEXAMPLES_PRINTPROJECT_H_
/**@}*/