1
0
mirror of https://github.com/OpenTTD/OpenTTD synced 2026-01-19 18:32:35 +01:00

Doc: Add @file annotation to generated strings table.

This commit is contained in:
Cyprian Klimaszewski
2026-01-12 15:34:45 +01:00
committed by rubidium42
parent 54b0fcf6dc
commit aa6309e784

View File

@@ -228,7 +228,10 @@ struct HeaderFileWriter : HeaderWriter, FileWriter {
HeaderFileWriter(const std::filesystem::path &path) : FileWriter("tmp.xxx", std::ofstream::out),
real_path(path), prev(0), total_strings(0)
{
this->output_stream << "/* This file is automatically generated. Do not modify */\n\n";
this->output_stream << "/**\n";
this->output_stream << " * @file strings.h This file contains IDs for all registered strings.\n";
this->output_stream << " * @attention This file is automatically generated. Do not modify.\n";
this->output_stream << " */\n\n";
this->output_stream << "#ifndef TABLE_STRINGS_H\n";
this->output_stream << "#define TABLE_STRINGS_H\n";
}