mirror of
https://github.com/vcmi/vcmi.git
synced 2026-06-19 22:57:37 +02:00
28 lines
642 B
C++
28 lines
642 B
C++
/*
|
|
* DocExport.h, part of VCMI engine
|
|
*
|
|
* Authors: listed in file AUTHORS in main folder
|
|
*
|
|
* License: GNU General Public License v2.0 or later
|
|
* Full text of license available in license.txt file, in main folder
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <boost/filesystem/path.hpp>
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
namespace scripting::api
|
|
{
|
|
|
|
/// Walks Registry::getAllTypes(), drives a DocRegistrar per type and writes two reference
|
|
/// files into outDir: API.md (Markdown) and api.lua (Lua Language Server definitions).
|
|
/// Creates outDir if it does not exist.
|
|
void exportLuaApiDocs(const boost::filesystem::path & outDir);
|
|
|
|
}
|
|
|
|
VCMI_LIB_NAMESPACE_END
|