Codefix: Documentation comment in IndustryDirectoryWindow (#13059)
[openttd-github.git] / src / textfile_type.h
blob8482106f126e0e41c5bc5fc4ce07e8229eb79e1e
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file textfile_type.h Types related to textfiles. */
10 #ifndef TEXTFILE_TYPE_H
11 #define TEXTFILE_TYPE_H
13 /** Additional text files accompanying Tar archives */
14 enum TextfileType {
15 TFT_CONTENT_BEGIN,
17 TFT_README = TFT_CONTENT_BEGIN, ///< Content readme
18 TFT_CHANGELOG, ///< Content changelog
19 TFT_LICENSE, ///< Content license
21 TFT_CONTENT_END, // This marker is used to generate the above three buttons in sequence by various of places in the code.
23 TFT_SURVEY_RESULT = TFT_CONTENT_END, ///< Survey result (preview)
24 TFT_GAME_MANUAL, ///< Game manual/documentation file
26 TFT_END,
28 DECLARE_POSTFIX_INCREMENT(TextfileType)
29 DECLARE_ENUM_AS_ADDABLE(TextfileType)
31 #endif /* TEXTFILE_TYPE_H */