mirror of
https://github.com/godotengine/godot
synced 2024-09-05 17:40:22 +00:00
55 lines
3 KiB
C++
55 lines
3 KiB
C++
/**************************************************************************/
|
|
/* gdscript_docgen.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef GDSCRIPT_DOCGEN_H
|
|
#define GDSCRIPT_DOCGEN_H
|
|
|
|
#include "../gdscript_parser.h"
|
|
|
|
#include "core/doc_data.h"
|
|
|
|
class GDScriptDocGen {
|
|
using GDP = GDScriptParser;
|
|
using GDType = GDP::DataType;
|
|
|
|
static HashMap<String, String> singletons; // Script path to singleton name.
|
|
|
|
static String _get_script_name(const String &p_path);
|
|
static String _get_class_name(const GDP::ClassNode &p_class);
|
|
static void _doctype_from_gdtype(const GDType &p_gdtype, String &r_type, String &r_enum, bool p_is_return = false);
|
|
static String _docvalue_from_variant(const Variant &p_variant, int p_recursion_level = 1);
|
|
static void _generate_docs(GDScript *p_script, const GDP::ClassNode *p_class);
|
|
|
|
public:
|
|
static void generate_docs(GDScript *p_script, const GDP::ClassNode *p_class);
|
|
};
|
|
|
|
#endif // GDSCRIPT_DOCGEN_H
|