izzy/shinobu
0
0
Fork 0
mirror of https://github.com/izzy2lost/shinobu.git synced 2026-03-26 16:50:24 -07:00
Code Issues Packages Projects Releases Wiki Activity

-Make sure that ProjectSettings are properly dumped when dumping docs.

Browse Source 
-Documented all properties of project settings

Update documentation for ProjectSettings
This commit is contained in:
Juan Linietsky
2018-06-11 13:41:16 -03:00
parent 76875ba145
commit d5bb6faac7
12 changed files with 813 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/@GDScript.xml
+1 -1
View File
@@ -1160,7 +1160,7 @@
<constant name="INF" value="inf">
A positive infinity. (For negative infinity, use -INF).
</constant>
<constant name="NAN" value="nan">
<constant name="NAN" value="-nan(ind)">
Macro constant that expands to an expression of type float that represents a NaN.
The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0.
</constant>
doc/classes/@GlobalScope.xml
-3
View File
@@ -29,9 +29,6 @@
<member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
[GodotSharp] singleton
</member>
<member name="IP" type="IP" setter="" getter="">
[IP] singleton
</member>
doc/classes/Animation.xml
+226
View File
@@ -24,6 +24,214 @@
Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration.
</description>
</method>
<method name="animation_track_get_key_animation" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="animation_track_insert_key">
<return type="int">
</return>
<argument index="0" name="track" type="int">
</argument>
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="animation" type="String">
</argument>
<description>
</description>
</method>
<method name="animation_track_set_key_animation">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="animation" type="String">
</argument>
<description>
</description>
</method>
<method name="audio_track_get_key_end_offset" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="audio_track_get_key_start_offset" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="audio_track_get_key_stream" qualifiers="const">
<return type="Resource">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="audio_track_insert_key">
<return type="int">
</return>
<argument index="0" name="track" type="int">
</argument>
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="stream" type="Resource">
</argument>
<argument index="3" name="start_offset" type="float" default="0">
</argument>
<argument index="4" name="end_offset" type="float" default="0">
</argument>
<description>
</description>
</method>
<method name="audio_track_set_key_end_offset">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="offset" type="float">
</argument>
<description>
</description>
</method>
<method name="audio_track_set_key_start_offset">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="offset" type="float">
</argument>
<description>
</description>
</method>
<method name="audio_track_set_key_stream">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="stream" type="Resource">
</argument>
<description>
</description>
</method>
<method name="bezier_track_get_key_in_handle" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="bezier_track_get_key_out_handle" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="bezier_track_get_key_value" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="bezier_track_insert_key">
<return type="int">
</return>
<argument index="0" name="track" type="int">
</argument>
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="value" type="float">
</argument>
<argument index="3" name="in_handle" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<argument index="4" name="out_handle" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
</description>
</method>
<method name="bezier_track_interpolate" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="track" type="int">
</argument>
<argument index="1" name="time" type="float">
</argument>
<description>
</description>
</method>
<method name="bezier_track_set_key_in_handle">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="in_handle" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="bezier_track_set_key_out_handle">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="out_handle" type="Vector2">
</argument>
<description>
</description>
</method>
<method name="bezier_track_set_key_value">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="value" type="float">
</argument>
<description>
</description>
</method>
<method name="clear">
<return type="void">
</return>
@@ -347,6 +555,16 @@
Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
</description>
</method>
<method name="track_swap">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="with_idx" type="int">
</argument>
<description>
</description>
</method>
<method name="transform_track_insert_key">
<return type="int">
</return>
@@ -430,6 +648,12 @@
<constant name="TYPE_METHOD" value="2" enum="TrackType">
Method tracks call functions with given arguments per key.
</constant>
<constant name="TYPE_BEZIER" value="3" enum="TrackType">
</constant>
<constant name="TYPE_AUDIO" value="4" enum="TrackType">
</constant>
<constant name="TYPE_ANIMATION" value="5" enum="TrackType">
</constant>
<constant name="INTERPOLATION_NEAREST" value="0" enum="InterpolationType">
No interpolation (nearest value).
</constant>
@@ -448,5 +672,7 @@
<constant name="UPDATE_TRIGGER" value="2" enum="UpdateMode">
Update at the keyframes.
</constant>
<constant name="UPDATE_CAPTURE" value="3" enum="UpdateMode">
</constant>
</constants>
</class>
doc/classes/FileDialog.xml
+6
View File
@@ -33,6 +33,12 @@
<description>
</description>
</method>
<method name="get_line_edit">
<return type="LineEdit">
</return>
<description>
</description>
</method>
<method name="get_vbox">
<return type="VBoxContainer">
</return>
doc/classes/Image.xml
+6
View File
@@ -393,6 +393,12 @@
Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same.
</description>
</method>
<method name="rgbe_to_srgb">
<return type="Image">
</return>
<description>
</description>
</method>
<method name="save_png" qualifiers="const">
<return type="int" enum="Error">
</return>
doc/classes/Object.xml
+1 -1
View File
@@ -16,7 +16,7 @@
</demos>
<methods>
<method name="_get" qualifiers="virtual">
<return type="void">
<return type="Variant">
</return>
<argument index="0" name="property" type="String">
</argument>
doc/classes/PopupMenu.xml
+18
View File
@@ -303,6 +303,14 @@
Return whether the item is a separator. If it is, it would be displayed as a line.
</description>
</method>
<method name="is_item_shortcut_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
</description>
</method>
<method name="remove_item">
<return type="void">
</return>
@@ -433,6 +441,16 @@
<description>
</description>
</method>
<method name="set_item_shortcut_disabled">
<return type="void">
</return>
<argument index="0" name="idx" type="int">
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_item_submenu">
<return type="void">
</return>
doc/classes/ProjectSettings.xml
+528
View File
File diff suppressed because it is too large Load Diff
doc/classes/ScrollContainer.xml
+12
View File
@@ -11,6 +11,18 @@
<demos>
</demos>
<methods>
<method name="get_h_scrollbar">
<return type="HScrollBar">
</return>
<description>
</description>
</method>
<method name="get_v_scrollbar">
<return type="VScrollBar">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="scroll_deadzone" type="int" setter="set_deadzone" getter="get_deadzone">
doc/classes/Tween.xml
+6
View File
@@ -181,6 +181,12 @@
Returns [code]true[/code] if any tweens are currently running. Note that this method doesn't consider tweens that have ended.
</description>
</method>
<method name="is_stopped" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="remove">
<return type="bool">
</return>
editor/doc/doc_data.cpp
+8 -1
View File
@@ -233,7 +233,14 @@ void DocData::generate(bool p_basic_types) {
c.category = ClassDB::get_category(name);
List<PropertyInfo> properties;
ClassDB::get_property_list(name, &properties, true);
if (name=="ProjectSettings") {
//special case for project settings, so settings can be documented
ProjectSettings::get_singleton()->get_property_list(&properties);
} else {
ClassDB::get_property_list(name, &properties, true);
}
for (List<PropertyInfo>::Element *E = properties.front(); E; E = E->next()) {
if (E->get().usage & PROPERTY_USAGE_GROUP || E->get().usage & PROPERTY_USAGE_CATEGORY || E->get().usage & PROPERTY_USAGE_INTERNAL)
platform/windows/detect.py
+1 -1
View File
@@ -332,7 +332,7 @@ def configure(env):
# First figure out which compiler, version, and target arch we're using
if os.getenv("VCINSTALLDIR"):
# Manual setup of MSVC
# Manual setup of MSVC
setup_msvc_manual(env)
env.msvc = True
manual_msvc_config = True