Skip to content

Instantly share code, notes, and snippets.

@neikeq

neikeq/GodotSharp.diff

Created March 23, 2019 19:00
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save neikeq/5298b69567a24a683a42777aa3fcdbb7 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save neikeq/5298b69567a24a683a42777aa3fcdbb7 to your computer and use it in GitHub Desktop.
Download ZIP
Diff after translating BBCode documentation to XML comments
Raw
GodotSharp.diff
This file has been truncated, but you can view the full file.
diff -ur GodotSharp_before/GodotSharp/Core/GD_constants.cs GodotSharp_after/GodotSharp/Core/GD_constants.cs
--- GodotSharp_before/GodotSharp/Core/GD_constants.cs 2019-03-20 21:16:54.214304500 +0100
+++ GodotSharp_after/GodotSharp/Core/GD_constants.cs 2019-03-23 19:57:07.538196400 +0100
@@ -5,7 +5,7 @@
public static partial class GD
{
/// <summary>
- /// Scancodes with this bit applied are non printable.
+ /// <para>Scancodes with this bit applied are non printable.</para>
/// </summary>
public const int Spkey = 16777216;
}
@@ -13,19 +13,19 @@
public enum Margin
{
/// <summary>
- /// Left margin, used usually for [Control] or [StyleBox] derived classes.
+ /// <para>Left margin, used usually for <see cref="Godot.Control"/> or <see cref="Godot.StyleBox"/> derived classes.</para>
/// </summary>
Left = 0,
/// <summary>
- /// Top margin, used usually for [Control] or [StyleBox] derived classes.
+ /// <para>Top margin, used usually for <see cref="Godot.Control"/> or <see cref="Godot.StyleBox"/> derived classes.</para>
/// </summary>
Top = 1,
/// <summary>
- /// Right margin, used usually for [Control] or [StyleBox] derived classes.
+ /// <para>Right margin, used usually for <see cref="Godot.Control"/> or <see cref="Godot.StyleBox"/> derived classes.</para>
/// </summary>
Right = 2,
/// <summary>
- /// Bottom margin, used usually for [Control] or [StyleBox] derived classes.
+ /// <para>Bottom margin, used usually for <see cref="Godot.Control"/> or <see cref="Godot.StyleBox"/> derived classes.</para>
/// </summary>
Bottom = 3
}
@@ -53,11 +53,11 @@
public enum Orientation
{
/// <summary>
- /// General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
+ /// <para>General vertical alignment, used usually for <see cref="Godot.Separator"/>, <see cref="Godot.ScrollBar"/>, <see cref="Godot.Slider"/>, etc.</para>
/// </summary>
Vertical = 1,
/// <summary>
- /// General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc.
+ /// <para>General horizontal alignment, used usually for <see cref="Godot.Separator"/>, <see cref="Godot.ScrollBar"/>, <see cref="Godot.Slider"/>, etc.</para>
/// </summary>
Horizontal = 0
}
@@ -65,15 +65,15 @@
public enum HAlign
{
/// <summary>
- /// Horizontal left alignment, usually for text-derived classes.
+ /// <para>Horizontal left alignment, usually for text-derived classes.</para>
/// </summary>
Left = 0,
/// <summary>
- /// Horizontal center alignment, usually for text-derived classes.
+ /// <para>Horizontal center alignment, usually for text-derived classes.</para>
/// </summary>
Center = 1,
/// <summary>
- /// Horizontal right alignment, usually for text-derived classes.
+ /// <para>Horizontal right alignment, usually for text-derived classes.</para>
/// </summary>
Right = 2
}
@@ -81,15 +81,15 @@
public enum VAlign
{
/// <summary>
- /// Vertical top alignment, usually for text-derived classes.
+ /// <para>Vertical top alignment, usually for text-derived classes.</para>
/// </summary>
Top = 0,
/// <summary>
- /// Vertical center alignment, usually for text-derived classes.
+ /// <para>Vertical center alignment, usually for text-derived classes.</para>
/// </summary>
Center = 1,
/// <summary>
- /// Vertical bottom alignment, usually for text-derived classes.
+ /// <para>Vertical bottom alignment, usually for text-derived classes.</para>
/// </summary>
Bottom = 2
}
@@ -97,707 +97,707 @@
public enum KeyList
{
/// <summary>
- /// Escape Key
+ /// <para>Escape Key</para>
/// </summary>
Escape = 16777217,
/// <summary>
- /// Tab Key
+ /// <para>Tab Key</para>
/// </summary>
Tab = 16777218,
/// <summary>
- /// Shift-Tab Key
+ /// <para>Shift-Tab Key</para>
/// </summary>
Backtab = 16777219,
/// <summary>
- /// Backspace Key
+ /// <para>Backspace Key</para>
/// </summary>
Backspace = 16777220,
/// <summary>
- /// Return Key (On Main Keyboard)
+ /// <para>Return Key (On Main Keyboard)</para>
/// </summary>
Enter = 16777221,
/// <summary>
- /// Enter Key (On Numpad)
+ /// <para>Enter Key (On Numpad)</para>
/// </summary>
KpEnter = 16777222,
/// <summary>
- /// Insert Key
+ /// <para>Insert Key</para>
/// </summary>
Insert = 16777223,
/// <summary>
- /// Delete Key
+ /// <para>Delete Key</para>
/// </summary>
Delete = 16777224,
/// <summary>
- /// Pause Key
+ /// <para>Pause Key</para>
/// </summary>
Pause = 16777225,
/// <summary>
- /// Printscreen Key
+ /// <para>Printscreen Key</para>
/// </summary>
Print = 16777226,
/// <summary>
- /// System Request Key
+ /// <para>System Request Key</para>
/// </summary>
Sysreq = 16777227,
/// <summary>
- /// Clear Key
+ /// <para>Clear Key</para>
/// </summary>
Clear = 16777228,
/// <summary>
- /// Home Key
+ /// <para>Home Key</para>
/// </summary>
Home = 16777229,
/// <summary>
- /// End Key
+ /// <para>End Key</para>
/// </summary>
End = 16777230,
/// <summary>
- /// Left Arrow Key
+ /// <para>Left Arrow Key</para>
/// </summary>
Left = 16777231,
/// <summary>
- /// Up Arrow Key
+ /// <para>Up Arrow Key</para>
/// </summary>
Up = 16777232,
/// <summary>
- /// Right Arrow Key
+ /// <para>Right Arrow Key</para>
/// </summary>
Right = 16777233,
/// <summary>
- /// Down Arrow Key
+ /// <para>Down Arrow Key</para>
/// </summary>
Down = 16777234,
/// <summary>
- /// Pageup Key
+ /// <para>Pageup Key</para>
/// </summary>
Pageup = 16777235,
/// <summary>
- /// Pagedown Key
+ /// <para>Pagedown Key</para>
/// </summary>
Pagedown = 16777236,
/// <summary>
- /// Shift Key
+ /// <para>Shift Key</para>
/// </summary>
Shift = 16777237,
/// <summary>
- /// Control Key
+ /// <para>Control Key</para>
/// </summary>
Control = 16777238,
/// <summary>
- /// Meta Key
+ /// <para>Meta Key</para>
/// </summary>
Meta = 16777239,
/// <summary>
- /// Alt Key
+ /// <para>Alt Key</para>
/// </summary>
Alt = 16777240,
/// <summary>
- /// Capslock Key
+ /// <para>Capslock Key</para>
/// </summary>
Capslock = 16777241,
/// <summary>
- /// Numlock Key
+ /// <para>Numlock Key</para>
/// </summary>
Numlock = 16777242,
/// <summary>
- /// Scrolllock Key
+ /// <para>Scrolllock Key</para>
/// </summary>
Scrolllock = 16777243,
/// <summary>
- /// F1 Key
+ /// <para>F1 Key</para>
/// </summary>
F1 = 16777244,
/// <summary>
- /// F2 Key
+ /// <para>F2 Key</para>
/// </summary>
F2 = 16777245,
/// <summary>
- /// F3 Key
+ /// <para>F3 Key</para>
/// </summary>
F3 = 16777246,
/// <summary>
- /// F4 Key
+ /// <para>F4 Key</para>
/// </summary>
F4 = 16777247,
/// <summary>
- /// F5 Key
+ /// <para>F5 Key</para>
/// </summary>
F5 = 16777248,
/// <summary>
- /// F6 Key
+ /// <para>F6 Key</para>
/// </summary>
F6 = 16777249,
/// <summary>
- /// F7 Key
+ /// <para>F7 Key</para>
/// </summary>
F7 = 16777250,
/// <summary>
- /// F8 Key
+ /// <para>F8 Key</para>
/// </summary>
F8 = 16777251,
/// <summary>
- /// F9 Key
+ /// <para>F9 Key</para>
/// </summary>
F9 = 16777252,
/// <summary>
- /// F10 Key
+ /// <para>F10 Key</para>
/// </summary>
F10 = 16777253,
/// <summary>
- /// F11 Key
+ /// <para>F11 Key</para>
/// </summary>
F11 = 16777254,
/// <summary>
- /// F12 Key
+ /// <para>F12 Key</para>
/// </summary>
F12 = 16777255,
/// <summary>
- /// F13 Key
+ /// <para>F13 Key</para>
/// </summary>
F13 = 16777256,
/// <summary>
- /// F14 Key
+ /// <para>F14 Key</para>
/// </summary>
F14 = 16777257,
/// <summary>
- /// F15 Key
+ /// <para>F15 Key</para>
/// </summary>
F15 = 16777258,
/// <summary>
- /// F16 Key
+ /// <para>F16 Key</para>
/// </summary>
F16 = 16777259,
/// <summary>
- /// Multiply Key on Numpad
+ /// <para>Multiply Key on Numpad</para>
/// </summary>
KpMultiply = 16777345,
/// <summary>
- /// Divide Key on Numpad
+ /// <para>Divide Key on Numpad</para>
/// </summary>
KpDivide = 16777346,
/// <summary>
- /// Subtract Key on Numpad
+ /// <para>Subtract Key on Numpad</para>
/// </summary>
KpSubtract = 16777347,
/// <summary>
- /// Period Key on Numpad
+ /// <para>Period Key on Numpad</para>
/// </summary>
KpPeriod = 16777348,
/// <summary>
- /// Add Key on Numpad
+ /// <para>Add Key on Numpad</para>
/// </summary>
KpAdd = 16777349,
/// <summary>
- /// Number 0 on Numpad
+ /// <para>Number 0 on Numpad</para>
/// </summary>
Kp0 = 16777350,
/// <summary>
- /// Number 1 on Numpad
+ /// <para>Number 1 on Numpad</para>
/// </summary>
Kp1 = 16777351,
/// <summary>
- /// Number 2 on Numpad
+ /// <para>Number 2 on Numpad</para>
/// </summary>
Kp2 = 16777352,
/// <summary>
- /// Number 3 on Numpad
+ /// <para>Number 3 on Numpad</para>
/// </summary>
Kp3 = 16777353,
/// <summary>
- /// Number 4 on Numpad
+ /// <para>Number 4 on Numpad</para>
/// </summary>
Kp4 = 16777354,
/// <summary>
- /// Number 5 on Numpad
+ /// <para>Number 5 on Numpad</para>
/// </summary>
Kp5 = 16777355,
/// <summary>
- /// Number 6 on Numpad
+ /// <para>Number 6 on Numpad</para>
/// </summary>
Kp6 = 16777356,
/// <summary>
- /// Number 7 on Numpad
+ /// <para>Number 7 on Numpad</para>
/// </summary>
Kp7 = 16777357,
/// <summary>
- /// Number 8 on Numpad
+ /// <para>Number 8 on Numpad</para>
/// </summary>
Kp8 = 16777358,
/// <summary>
- /// Number 9 on Numpad
+ /// <para>Number 9 on Numpad</para>
/// </summary>
Kp9 = 16777359,
/// <summary>
- /// Left Super Key (Windows Key)
+ /// <para>Left Super Key (Windows Key)</para>
/// </summary>
SuperL = 16777260,
/// <summary>
- /// Right Super Key (Windows Key)
+ /// <para>Right Super Key (Windows Key)</para>
/// </summary>
SuperR = 16777261,
/// <summary>
- /// Context menu key
+ /// <para>Context menu key</para>
/// </summary>
Menu = 16777262,
/// <summary>
- /// Left Hyper Key
+ /// <para>Left Hyper Key</para>
/// </summary>
HyperL = 16777263,
/// <summary>
- /// Right Hyper Key
+ /// <para>Right Hyper Key</para>
/// </summary>
HyperR = 16777264,
/// <summary>
- /// Help key
+ /// <para>Help key</para>
/// </summary>
Help = 16777265,
/// <summary>
- /// Left Direction Key
+ /// <para>Left Direction Key</para>
/// </summary>
DirectionL = 16777266,
/// <summary>
- /// Right Direction Key
+ /// <para>Right Direction Key</para>
/// </summary>
DirectionR = 16777267,
/// <summary>
- /// Back key
+ /// <para>Back key</para>
/// </summary>
Back = 16777280,
/// <summary>
- /// Forward key
+ /// <para>Forward key</para>
/// </summary>
Forward = 16777281,
/// <summary>
- /// Stop key
+ /// <para>Stop key</para>
/// </summary>
Stop = 16777282,
/// <summary>
- /// Refresh key
+ /// <para>Refresh key</para>
/// </summary>
Refresh = 16777283,
/// <summary>
- /// Volume down key
+ /// <para>Volume down key</para>
/// </summary>
Volumedown = 16777284,
/// <summary>
- /// Mute volume key
+ /// <para>Mute volume key</para>
/// </summary>
Volumemute = 16777285,
/// <summary>
- /// Volume up key
+ /// <para>Volume up key</para>
/// </summary>
Volumeup = 16777286,
/// <summary>
- /// Bass Boost Key
+ /// <para>Bass Boost Key</para>
/// </summary>
Bassboost = 16777287,
/// <summary>
- /// Bass Up Key
+ /// <para>Bass Up Key</para>
/// </summary>
Bassup = 16777288,
/// <summary>
- /// Bass Down Key
+ /// <para>Bass Down Key</para>
/// </summary>
Bassdown = 16777289,
/// <summary>
- /// Treble Up Key
+ /// <para>Treble Up Key</para>
/// </summary>
Trebleup = 16777290,
/// <summary>
- /// Treble Down Key
+ /// <para>Treble Down Key</para>
/// </summary>
Trebledown = 16777291,
/// <summary>
- /// Media play key
+ /// <para>Media play key</para>
/// </summary>
Mediaplay = 16777292,
/// <summary>
- /// Media stop key
+ /// <para>Media stop key</para>
/// </summary>
Mediastop = 16777293,
/// <summary>
- /// Previous song key
+ /// <para>Previous song key</para>
/// </summary>
Mediaprevious = 16777294,
/// <summary>
- /// Next song key
+ /// <para>Next song key</para>
/// </summary>
Medianext = 16777295,
/// <summary>
- /// Media record key
+ /// <para>Media record key</para>
/// </summary>
Mediarecord = 16777296,
/// <summary>
- /// Home page key
+ /// <para>Home page key</para>
/// </summary>
Homepage = 16777297,
/// <summary>
- /// Favorites key
+ /// <para>Favorites key</para>
/// </summary>
Favorites = 16777298,
/// <summary>
- /// Search key
+ /// <para>Search key</para>
/// </summary>
Search = 16777299,
/// <summary>
- /// Standby Key
+ /// <para>Standby Key</para>
/// </summary>
Standby = 16777300,
/// <summary>
- /// Open URL / Launch Browser Key
+ /// <para>Open URL / Launch Browser Key</para>
/// </summary>
Openurl = 16777301,
/// <summary>
- /// Launch Mail Key
+ /// <para>Launch Mail Key</para>
/// </summary>
Launchmail = 16777302,
/// <summary>
- /// Launch Media Key
+ /// <para>Launch Media Key</para>
/// </summary>
Launchmedia = 16777303,
/// <summary>
- /// Launch Shortcut 0 Key
+ /// <para>Launch Shortcut 0 Key</para>
/// </summary>
Launch0 = 16777304,
/// <summary>
- /// Launch Shortcut 1 Key
+ /// <para>Launch Shortcut 1 Key</para>
/// </summary>
Launch1 = 16777305,
/// <summary>
- /// Launch Shortcut 2 Key
+ /// <para>Launch Shortcut 2 Key</para>
/// </summary>
Launch2 = 16777306,
/// <summary>
- /// Launch Shortcut 3 Key
+ /// <para>Launch Shortcut 3 Key</para>
/// </summary>
Launch3 = 16777307,
/// <summary>
- /// Launch Shortcut 4 Key
+ /// <para>Launch Shortcut 4 Key</para>
/// </summary>
Launch4 = 16777308,
/// <summary>
- /// Launch Shortcut 5 Key
+ /// <para>Launch Shortcut 5 Key</para>
/// </summary>
Launch5 = 16777309,
/// <summary>
- /// Launch Shortcut 6 Key
+ /// <para>Launch Shortcut 6 Key</para>
/// </summary>
Launch6 = 16777310,
/// <summary>
- /// Launch Shortcut 7 Key
+ /// <para>Launch Shortcut 7 Key</para>
/// </summary>
Launch7 = 16777311,
/// <summary>
- /// Launch Shortcut 8 Key
+ /// <para>Launch Shortcut 8 Key</para>
/// </summary>
Launch8 = 16777312,
/// <summary>
- /// Launch Shortcut 9 Key
+ /// <para>Launch Shortcut 9 Key</para>
/// </summary>
Launch9 = 16777313,
/// <summary>
- /// Launch Shortcut A Key
+ /// <para>Launch Shortcut A Key</para>
/// </summary>
Launcha = 16777314,
/// <summary>
- /// Launch Shortcut B Key
+ /// <para>Launch Shortcut B Key</para>
/// </summary>
Launchb = 16777315,
/// <summary>
- /// Launch Shortcut C Key
+ /// <para>Launch Shortcut C Key</para>
/// </summary>
Launchc = 16777316,
/// <summary>
- /// Launch Shortcut D Key
+ /// <para>Launch Shortcut D Key</para>
/// </summary>
Launchd = 16777317,
/// <summary>
- /// Launch Shortcut E Key
+ /// <para>Launch Shortcut E Key</para>
/// </summary>
Launche = 16777318,
/// <summary>
- /// Launch Shortcut F Key
+ /// <para>Launch Shortcut F Key</para>
/// </summary>
Launchf = 16777319,
/// <summary>
- /// Unknown Key
+ /// <para>Unknown Key</para>
/// </summary>
Unknown = 33554431,
/// <summary>
- /// Space Key
+ /// <para>Space Key</para>
/// </summary>
Space = 32,
/// <summary>
- /// ! key
+ /// <para>! key</para>
/// </summary>
Exclam = 33,
/// <summary>
- /// " key
+ /// <para>" key</para>
/// </summary>
Quotedbl = 34,
/// <summary>
- /// # key
+ /// <para># key</para>
/// </summary>
Numbersign = 35,
/// <summary>
- /// $ key
+ /// <para>$ key</para>
/// </summary>
Dollar = 36,
/// <summary>
- /// % key
+ /// <para>% key</para>
/// </summary>
Percent = 37,
/// <summary>
- /// &amp; key
+ /// <para>&amp; key</para>
/// </summary>
Ampersand = 38,
/// <summary>
- /// ' key
+ /// <para>' key</para>
/// </summary>
Apostrophe = 39,
/// <summary>
- /// ( key
+ /// <para>( key</para>
/// </summary>
Parenleft = 40,
/// <summary>
- /// ) key
+ /// <para>) key</para>
/// </summary>
Parenright = 41,
/// <summary>
- /// * key
+ /// <para>* key</para>
/// </summary>
Asterisk = 42,
/// <summary>
- /// + key
+ /// <para>+ key</para>
/// </summary>
Plus = 43,
/// <summary>
- /// , key
+ /// <para>, key</para>
/// </summary>
Comma = 44,
/// <summary>
- /// - key
+ /// <para>- key</para>
/// </summary>
Minus = 45,
/// <summary>
- /// . key
+ /// <para>. key</para>
/// </summary>
Period = 46,
/// <summary>
- /// / key
+ /// <para>/ key</para>
/// </summary>
Slash = 47,
/// <summary>
- /// Number 0
+ /// <para>Number 0</para>
/// </summary>
Key0 = 48,
/// <summary>
- /// Number 1
+ /// <para>Number 1</para>
/// </summary>
Key1 = 49,
/// <summary>
- /// Number 2
+ /// <para>Number 2</para>
/// </summary>
Key2 = 50,
/// <summary>
- /// Number 3
+ /// <para>Number 3</para>
/// </summary>
Key3 = 51,
/// <summary>
- /// Number 4
+ /// <para>Number 4</para>
/// </summary>
Key4 = 52,
/// <summary>
- /// Number 5
+ /// <para>Number 5</para>
/// </summary>
Key5 = 53,
/// <summary>
- /// Number 6
+ /// <para>Number 6</para>
/// </summary>
Key6 = 54,
/// <summary>
- /// Number 7
+ /// <para>Number 7</para>
/// </summary>
Key7 = 55,
/// <summary>
- /// Number 8
+ /// <para>Number 8</para>
/// </summary>
Key8 = 56,
/// <summary>
- /// Number 9
+ /// <para>Number 9</para>
/// </summary>
Key9 = 57,
/// <summary>
- /// : key
+ /// <para>: key</para>
/// </summary>
Colon = 58,
/// <summary>
- /// ; key
+ /// <para>; key</para>
/// </summary>
Semicolon = 59,
/// <summary>
- /// Lower than key
+ /// <para>Lower than key</para>
/// </summary>
Less = 60,
/// <summary>
- /// = key
+ /// <para>= key</para>
/// </summary>
Equal = 61,
/// <summary>
- /// Greater than key
+ /// <para>Greater than key</para>
/// </summary>
Greater = 62,
/// <summary>
- /// ? key
+ /// <para>? key</para>
/// </summary>
Question = 63,
/// <summary>
- /// @ key
+ /// <para>@ key</para>
/// </summary>
At = 64,
/// <summary>
- /// A Key
+ /// <para>A Key</para>
/// </summary>
A = 65,
/// <summary>
- /// B Key
+ /// <para>B Key</para>
/// </summary>
B = 66,
/// <summary>
- /// C Key
+ /// <para>C Key</para>
/// </summary>
C = 67,
/// <summary>
- /// D Key
+ /// <para>D Key</para>
/// </summary>
D = 68,
/// <summary>
- /// E Key
+ /// <para>E Key</para>
/// </summary>
E = 69,
/// <summary>
- /// F Key
+ /// <para>F Key</para>
/// </summary>
F = 70,
/// <summary>
- /// G Key
+ /// <para>G Key</para>
/// </summary>
G = 71,
/// <summary>
- /// H Key
+ /// <para>H Key</para>
/// </summary>
H = 72,
/// <summary>
- /// I Key
+ /// <para>I Key</para>
/// </summary>
I = 73,
/// <summary>
- /// J Key
+ /// <para>J Key</para>
/// </summary>
J = 74,
/// <summary>
- /// K Key
+ /// <para>K Key</para>
/// </summary>
K = 75,
/// <summary>
- /// L Key
+ /// <para>L Key</para>
/// </summary>
L = 76,
/// <summary>
- /// M Key
+ /// <para>M Key</para>
/// </summary>
M = 77,
/// <summary>
- /// N Key
+ /// <para>N Key</para>
/// </summary>
N = 78,
/// <summary>
- /// O Key
+ /// <para>O Key</para>
/// </summary>
O = 79,
/// <summary>
- /// P Key
+ /// <para>P Key</para>
/// </summary>
P = 80,
/// <summary>
- /// Q Key
+ /// <para>Q Key</para>
/// </summary>
Q = 81,
/// <summary>
- /// R Key
+ /// <para>R Key</para>
/// </summary>
R = 82,
/// <summary>
- /// S Key
+ /// <para>S Key</para>
/// </summary>
S = 83,
/// <summary>
- /// T Key
+ /// <para>T Key</para>
/// </summary>
T = 84,
/// <summary>
- /// U Key
+ /// <para>U Key</para>
/// </summary>
U = 85,
/// <summary>
- /// V Key
+ /// <para>V Key</para>
/// </summary>
V = 86,
/// <summary>
- /// W Key
+ /// <para>W Key</para>
/// </summary>
W = 87,
/// <summary>
- /// X Key
+ /// <para>X Key</para>
/// </summary>
X = 88,
/// <summary>
- /// Y Key
+ /// <para>Y Key</para>
/// </summary>
Y = 89,
/// <summary>
- /// Z Key
+ /// <para>Z Key</para>
/// </summary>
Z = 90,
/// <summary>
- /// [ key
+ /// <para>[ key</para>
/// </summary>
Bracketleft = 91,
/// <summary>
- /// \ key
+ /// <para>\ key</para>
/// </summary>
Backslash = 92,
/// <summary>
- /// ] key
+ /// <para>] key</para>
/// </summary>
Bracketright = 93,
/// <summary>
- /// ^ key
+ /// <para>^ key</para>
/// </summary>
Asciicircum = 94,
/// <summary>
- /// _ key
+ /// <para>_ key</para>
/// </summary>
Underscore = 95,
/// <summary>
- /// Left Quote Key
+ /// <para>Left Quote Key</para>
/// </summary>
Quoteleft = 96,
/// <summary>
- /// { key
+ /// <para>{ key</para>
/// </summary>
Braceleft = 123,
/// <summary>
- /// | key
+ /// <para>| key</para>
/// </summary>
Bar = 124,
/// <summary>
- /// } key
+ /// <para>} key</para>
/// </summary>
Braceright = 125,
/// <summary>
- /// ~ key
+ /// <para>~ key</para>
/// </summary>
Asciitilde = 126,
/// <summary>
@@ -809,7 +809,7 @@
/// </summary>
Exclamdown = 161,
/// <summary>
- /// ¢ key
+ /// <para>¢ key</para>
/// </summary>
Cent = 162,
/// <summary>
@@ -821,23 +821,23 @@
/// </summary>
Currency = 164,
/// <summary>
- /// Yen Key
+ /// <para>Yen Key</para>
/// </summary>
Yen = 165,
/// <summary>
- /// ¦ key
+ /// <para>¦ key</para>
/// </summary>
Brokenbar = 166,
/// <summary>
- /// § key
+ /// <para>§ key</para>
/// </summary>
Section = 167,
/// <summary>
- /// ¨ key
+ /// <para>¨ key</para>
/// </summary>
Diaeresis = 168,
/// <summary>
- /// © key
+ /// <para>© key</para>
/// </summary>
Copyright = 169,
/// <summary>
@@ -845,223 +845,223 @@
/// </summary>
Ordfeminine = 170,
/// <summary>
- /// « key
+ /// <para>« key</para>
/// </summary>
Guillemotleft = 171,
/// <summary>
- /// » key
+ /// <para>» key</para>
/// </summary>
Notsign = 172,
/// <summary>
- /// ‐ key
+ /// <para>‐ key</para>
/// </summary>
Hyphen = 173,
/// <summary>
- /// ® key
+ /// <para>® key</para>
/// </summary>
Registered = 174,
/// <summary>
- /// Macron Key
+ /// <para>Macron Key</para>
/// </summary>
Macron = 175,
/// <summary>
- /// ° key
+ /// <para>° key</para>
/// </summary>
Degree = 176,
/// <summary>
- /// ± key
+ /// <para>± key</para>
/// </summary>
Plusminus = 177,
/// <summary>
- /// ² key
+ /// <para>² key</para>
/// </summary>
Twosuperior = 178,
/// <summary>
- /// ³ key
+ /// <para>³ key</para>
/// </summary>
Threesuperior = 179,
/// <summary>
- /// ´ key
+ /// <para>´ key</para>
/// </summary>
Acute = 180,
/// <summary>
- /// µ key
+ /// <para>µ key</para>
/// </summary>
Mu = 181,
/// <summary>
- /// Paragraph Key
+ /// <para>Paragraph Key</para>
/// </summary>
Paragraph = 182,
/// <summary>
- /// · key
+ /// <para>· key</para>
/// </summary>
Periodcentered = 183,
/// <summary>
- /// ¬ key
+ /// <para>¬ key</para>
/// </summary>
Cedilla = 184,
/// <summary>
- /// ¹ key
+ /// <para>¹ key</para>
/// </summary>
Onesuperior = 185,
/// <summary>
- /// ♂ key
+ /// <para>♂ key</para>
/// </summary>
Masculine = 186,
/// <summary>
- /// » key
+ /// <para>» key</para>
/// </summary>
Guillemotright = 187,
/// <summary>
- /// ¼ key
+ /// <para>¼ key</para>
/// </summary>
Onequarter = 188,
/// <summary>
- /// ½ key
+ /// <para>½ key</para>
/// </summary>
Onehalf = 189,
/// <summary>
- /// ¾ key
+ /// <para>¾ key</para>
/// </summary>
Threequarters = 190,
/// <summary>
- /// ¿ key
+ /// <para>¿ key</para>
/// </summary>
Questiondown = 191,
/// <summary>
- /// à key
+ /// <para>à key</para>
/// </summary>
Agrave = 192,
/// <summary>
- /// á key
+ /// <para>á key</para>
/// </summary>
Aacute = 193,
/// <summary>
- /// â key
+ /// <para>â key</para>
/// </summary>
Acircumflex = 194,
/// <summary>
- /// ã key
+ /// <para>ã key</para>
/// </summary>
Atilde = 195,
/// <summary>
- /// ä key
+ /// <para>ä key</para>
/// </summary>
Adiaeresis = 196,
/// <summary>
- /// å key
+ /// <para>å key</para>
/// </summary>
Aring = 197,
/// <summary>
- /// æ key
+ /// <para>æ key</para>
/// </summary>
Ae = 198,
/// <summary>
- /// ç key
+ /// <para>ç key</para>
/// </summary>
Ccedilla = 199,
/// <summary>
- /// è key
+ /// <para>è key</para>
/// </summary>
Egrave = 200,
/// <summary>
- /// é key
+ /// <para>é key</para>
/// </summary>
Eacute = 201,
/// <summary>
- /// ê key
+ /// <para>ê key</para>
/// </summary>
Ecircumflex = 202,
/// <summary>
- /// ë key
+ /// <para>ë key</para>
/// </summary>
Ediaeresis = 203,
/// <summary>
- /// ì key
+ /// <para>ì key</para>
/// </summary>
Igrave = 204,
/// <summary>
- /// í key
+ /// <para>í key</para>
/// </summary>
Iacute = 205,
/// <summary>
- /// î key
+ /// <para>î key</para>
/// </summary>
Icircumflex = 206,
/// <summary>
- /// ë key
+ /// <para>ë key</para>
/// </summary>
Idiaeresis = 207,
/// <summary>
- /// ð key
+ /// <para>ð key</para>
/// </summary>
Eth = 208,
/// <summary>
- /// ñ key
+ /// <para>ñ key</para>
/// </summary>
Ntilde = 209,
/// <summary>
- /// ò key
+ /// <para>ò key</para>
/// </summary>
Ograve = 210,
/// <summary>
- /// ó key
+ /// <para>ó key</para>
/// </summary>
Oacute = 211,
/// <summary>
- /// ô key
+ /// <para>ô key</para>
/// </summary>
Ocircumflex = 212,
/// <summary>
- /// õ key
+ /// <para>õ key</para>
/// </summary>
Otilde = 213,
/// <summary>
- /// ö key
+ /// <para>ö key</para>
/// </summary>
Odiaeresis = 214,
/// <summary>
- /// × key
+ /// <para>× key</para>
/// </summary>
Multiply = 215,
/// <summary>
- /// ø key
+ /// <para>ø key</para>
/// </summary>
Ooblique = 216,
/// <summary>
- /// ù key
+ /// <para>ù key</para>
/// </summary>
Ugrave = 217,
/// <summary>
- /// ú key
+ /// <para>ú key</para>
/// </summary>
Uacute = 218,
/// <summary>
- /// û key
+ /// <para>û key</para>
/// </summary>
Ucircumflex = 219,
/// <summary>
- /// ü key
+ /// <para>ü key</para>
/// </summary>
Udiaeresis = 220,
/// <summary>
- /// ý key
+ /// <para>ý key</para>
/// </summary>
Yacute = 221,
/// <summary>
- /// þ key
+ /// <para>þ key</para>
/// </summary>
Thorn = 222,
/// <summary>
- /// ß key
+ /// <para>ß key</para>
/// </summary>
Ssharp = 223,
/// <summary>
- /// ÷ key
+ /// <para>÷ key</para>
/// </summary>
Division = 247,
/// <summary>
- /// ÿ key
+ /// <para>ÿ key</para>
/// </summary>
Ydiaeresis = 255
}
@@ -1069,39 +1069,39 @@
public enum KeyModifierMask
{
/// <summary>
- /// Key Code Mask
+ /// <para>Key Code Mask</para>
/// </summary>
CodeMask = 33554431,
/// <summary>
- /// Modifier Key Mask
+ /// <para>Modifier Key Mask</para>
/// </summary>
ModifierMask = -16777216,
/// <summary>
- /// Shift Key Mask
+ /// <para>Shift Key Mask</para>
/// </summary>
MaskShift = 33554432,
/// <summary>
- /// Alt Key Mask
+ /// <para>Alt Key Mask</para>
/// </summary>
MaskAlt = 67108864,
/// <summary>
- /// Meta Key Mask
+ /// <para>Meta Key Mask</para>
/// </summary>
MaskMeta = 134217728,
/// <summary>
- /// CTRL Key Mask
+ /// <para>CTRL Key Mask</para>
/// </summary>
MaskCtrl = 268435456,
/// <summary>
- /// CMD Key Mask
+ /// <para>CMD Key Mask</para>
/// </summary>
MaskCmd = 268435456,
/// <summary>
- /// Keypad Key Mask
+ /// <para>Keypad Key Mask</para>
/// </summary>
MaskKpad = 536870912,
/// <summary>
- /// Group Switch Key Mask
+ /// <para>Group Switch Key Mask</para>
/// </summary>
MaskGroupSwitch = 1073741824
}
@@ -1109,59 +1109,59 @@
public enum ButtonList
{
/// <summary>
- /// Left Mouse Button
+ /// <para>Left Mouse Button</para>
/// </summary>
Left = 1,
/// <summary>
- /// Right Mouse Button
+ /// <para>Right Mouse Button</para>
/// </summary>
Right = 2,
/// <summary>
- /// Middle Mouse Button
+ /// <para>Middle Mouse Button</para>
/// </summary>
Middle = 3,
/// <summary>
- /// Extra Mouse Button 1
+ /// <para>Extra Mouse Button 1</para>
/// </summary>
Xbutton1 = 8,
/// <summary>
- /// Extra Mouse Button 2
+ /// <para>Extra Mouse Button 2</para>
/// </summary>
Xbutton2 = 9,
/// <summary>
- /// Mouse wheel up
+ /// <para>Mouse wheel up</para>
/// </summary>
WheelUp = 4,
/// <summary>
- /// Mouse wheel down
+ /// <para>Mouse wheel down</para>
/// </summary>
WheelDown = 5,
/// <summary>
- /// Mouse wheel left button
+ /// <para>Mouse wheel left button</para>
/// </summary>
WheelLeft = 6,
/// <summary>
- /// Mouse wheel right button
+ /// <para>Mouse wheel right button</para>
/// </summary>
WheelRight = 7,
/// <summary>
- /// Left Mouse Button Mask
+ /// <para>Left Mouse Button Mask</para>
/// </summary>
MaskLeft = 1,
/// <summary>
- /// Right Mouse Button Mask
+ /// <para>Right Mouse Button Mask</para>
/// </summary>
MaskRight = 2,
/// <summary>
- /// Middle Mouse Button Mask
+ /// <para>Middle Mouse Button Mask</para>
/// </summary>
MaskMiddle = 4,
/// <summary>
- /// Extra Mouse Button 1 Mask
+ /// <para>Extra Mouse Button 1 Mask</para>
/// </summary>
MaskXbutton1 = 128,
/// <summary>
- /// Extra Mouse Button 2 Mask
+ /// <para>Extra Mouse Button 2 Mask</para>
/// </summary>
MaskXbutton2 = 256
}
@@ -1169,183 +1169,183 @@
public enum JoystickList
{
/// <summary>
- /// Joypad Button 0
+ /// <para>Joypad Button 0</para>
/// </summary>
Button0 = 0,
/// <summary>
- /// Joypad Button 1
+ /// <para>Joypad Button 1</para>
/// </summary>
Button1 = 1,
/// <summary>
- /// Joypad Button 2
+ /// <para>Joypad Button 2</para>
/// </summary>
Button2 = 2,
/// <summary>
- /// Joypad Button 3
+ /// <para>Joypad Button 3</para>
/// </summary>
Button3 = 3,
/// <summary>
- /// Joypad Button 4
+ /// <para>Joypad Button 4</para>
/// </summary>
Button4 = 4,
/// <summary>
- /// Joypad Button 5
+ /// <para>Joypad Button 5</para>
/// </summary>
Button5 = 5,
/// <summary>
- /// Joypad Button 6
+ /// <para>Joypad Button 6</para>
/// </summary>
Button6 = 6,
/// <summary>
- /// Joypad Button 7
+ /// <para>Joypad Button 7</para>
/// </summary>
Button7 = 7,
/// <summary>
- /// Joypad Button 8
+ /// <para>Joypad Button 8</para>
/// </summary>
Button8 = 8,
/// <summary>
- /// Joypad Button 9
+ /// <para>Joypad Button 9</para>
/// </summary>
Button9 = 9,
/// <summary>
- /// Joypad Button 10
+ /// <para>Joypad Button 10</para>
/// </summary>
Button10 = 10,
/// <summary>
- /// Joypad Button 11
+ /// <para>Joypad Button 11</para>
/// </summary>
Button11 = 11,
/// <summary>
- /// Joypad Button 12
+ /// <para>Joypad Button 12</para>
/// </summary>
Button12 = 12,
/// <summary>
- /// Joypad Button 13
+ /// <para>Joypad Button 13</para>
/// </summary>
Button13 = 13,
/// <summary>
- /// Joypad Button 14
+ /// <para>Joypad Button 14</para>
/// </summary>
Button14 = 14,
/// <summary>
- /// Joypad Button 15
+ /// <para>Joypad Button 15</para>
/// </summary>
Button15 = 15,
/// <summary>
- /// Joypad Button 16
+ /// <para>Joypad Button 16</para>
/// </summary>
ButtonMax = 16,
/// <summary>
- /// DUALSHOCK circle button
+ /// <para>DUALSHOCK circle button</para>
/// </summary>
SonyCircle = 1,
/// <summary>
- /// DUALSHOCK X button
+ /// <para>DUALSHOCK X button</para>
/// </summary>
SonyX = 0,
/// <summary>
- /// DUALSHOCK square button
+ /// <para>DUALSHOCK square button</para>
/// </summary>
SonySquare = 2,
/// <summary>
- /// DUALSHOCK triangle button
+ /// <para>DUALSHOCK triangle button</para>
/// </summary>
SonyTriangle = 3,
/// <summary>
- /// XBOX controller B button
+ /// <para>XBOX controller B button</para>
/// </summary>
XboxB = 1,
/// <summary>
- /// XBOX controller A button
+ /// <para>XBOX controller A button</para>
/// </summary>
XboxA = 0,
/// <summary>
- /// XBOX controller X button
+ /// <para>XBOX controller X button</para>
/// </summary>
XboxX = 2,
/// <summary>
- /// XBOX controller Y button
+ /// <para>XBOX controller Y button</para>
/// </summary>
XboxY = 3,
/// <summary>
- /// DualShock controller A button
+ /// <para>DualShock controller A button</para>
/// </summary>
DsA = 1,
/// <summary>
- /// DualShock controller B button
+ /// <para>DualShock controller B button</para>
/// </summary>
DsB = 0,
/// <summary>
- /// DualShock controller X button
+ /// <para>DualShock controller X button</para>
/// </summary>
DsX = 3,
/// <summary>
- /// DualShock controller Y button
+ /// <para>DualShock controller Y button</para>
/// </summary>
DsY = 2,
/// <summary>
- /// Joypad Button Select
+ /// <para>Joypad Button Select</para>
/// </summary>
Select = 10,
/// <summary>
- /// Joypad Button Start
+ /// <para>Joypad Button Start</para>
/// </summary>
Start = 11,
/// <summary>
- /// Joypad DPad Up
+ /// <para>Joypad DPad Up</para>
/// </summary>
DpadUp = 12,
/// <summary>
- /// Joypad DPad Down
+ /// <para>Joypad DPad Down</para>
/// </summary>
DpadDown = 13,
/// <summary>
- /// Joypad DPad Left
+ /// <para>Joypad DPad Left</para>
/// </summary>
DpadLeft = 14,
/// <summary>
- /// Joypad DPad Right
+ /// <para>Joypad DPad Right</para>
/// </summary>
DpadRight = 15,
/// <summary>
- /// Joypad Left Shoulder Button
+ /// <para>Joypad Left Shoulder Button</para>
/// </summary>
L = 4,
/// <summary>
- /// Joypad Left Trigger
+ /// <para>Joypad Left Trigger</para>
/// </summary>
L2 = 6,
/// <summary>
- /// Joypad Left Stick Click
+ /// <para>Joypad Left Stick Click</para>
/// </summary>
L3 = 8,
/// <summary>
- /// Joypad Right Shoulder Button
+ /// <para>Joypad Right Shoulder Button</para>
/// </summary>
R = 5,
/// <summary>
- /// Joypad Right Trigger
+ /// <para>Joypad Right Trigger</para>
/// </summary>
R2 = 7,
/// <summary>
- /// Joypad Right Stick Click
+ /// <para>Joypad Right Stick Click</para>
/// </summary>
R3 = 9,
/// <summary>
- /// Joypad Left Stick Horizontal Axis
+ /// <para>Joypad Left Stick Horizontal Axis</para>
/// </summary>
Axis0 = 0,
/// <summary>
- /// Joypad Left Stick Vertical Axis
+ /// <para>Joypad Left Stick Vertical Axis</para>
/// </summary>
Axis1 = 1,
/// <summary>
- /// Joypad Right Stick Horizontal Axis
+ /// <para>Joypad Right Stick Horizontal Axis</para>
/// </summary>
Axis2 = 2,
/// <summary>
- /// Joypad Right Stick Vertical Axis
+ /// <para>Joypad Right Stick Vertical Axis</para>
/// </summary>
Axis3 = 3,
/// <summary>
@@ -1357,11 +1357,11 @@
/// </summary>
Axis5 = 5,
/// <summary>
- /// Joypad Left Trigger Analog Axis
+ /// <para>Joypad Left Trigger Analog Axis</para>
/// </summary>
Axis6 = 6,
/// <summary>
- /// Joypad Right Trigger Analog Axis
+ /// <para>Joypad Right Trigger Analog Axis</para>
/// </summary>
Axis7 = 7,
/// <summary>
@@ -1377,27 +1377,27 @@
/// </summary>
AxisMax = 10,
/// <summary>
- /// Joypad Left Stick Horizontal Axis
+ /// <para>Joypad Left Stick Horizontal Axis</para>
/// </summary>
AnalogLx = 0,
/// <summary>
- /// Joypad Left Stick Vertical Axis
+ /// <para>Joypad Left Stick Vertical Axis</para>
/// </summary>
AnalogLy = 1,
/// <summary>
- /// Joypad Right Stick Horizontal Axis
+ /// <para>Joypad Right Stick Horizontal Axis</para>
/// </summary>
AnalogRx = 2,
/// <summary>
- /// Joypad Right Stick Vertical Axis
+ /// <para>Joypad Right Stick Vertical Axis</para>
/// </summary>
AnalogRy = 3,
/// <summary>
- /// Joypad Left Analog Trigger
+ /// <para>Joypad Left Analog Trigger</para>
/// </summary>
AnalogL2 = 6,
/// <summary>
- /// Joypad Right Analog Trigger
+ /// <para>Joypad Right Analog Trigger</para>
/// </summary>
AnalogR2 = 7
}
@@ -1437,167 +1437,167 @@
public enum Error
{
/// <summary>
- /// Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT.
+ /// <para>Functions that return Error return OK when no error occurred. Most functions don't return errors and/or just print errors to STDOUT.</para>
/// </summary>
Ok = 0,
/// <summary>
- /// Generic error.
+ /// <para>Generic error.</para>
/// </summary>
Failed = 1,
/// <summary>
- /// Unavailable error
+ /// <para>Unavailable error</para>
/// </summary>
Unavailable = 2,
/// <summary>
- /// Unconfigured error
+ /// <para>Unconfigured error</para>
/// </summary>
Unconfigured = 3,
/// <summary>
- /// Unauthorized error
+ /// <para>Unauthorized error</para>
/// </summary>
Unauthorized = 4,
/// <summary>
- /// Parameter range error
+ /// <para>Parameter range error</para>
/// </summary>
ParameterRangeError = 5,
/// <summary>
- /// Out of memory (OOM) error
+ /// <para>Out of memory (OOM) error</para>
/// </summary>
OutOfMemory = 6,
/// <summary>
- /// File: Not found error
+ /// <para>File: Not found error</para>
/// </summary>
FileNotFound = 7,
/// <summary>
- /// File: Bad drive error
+ /// <para>File: Bad drive error</para>
/// </summary>
FileBadDrive = 8,
/// <summary>
- /// File: Bad path error
+ /// <para>File: Bad path error</para>
/// </summary>
FileBadPath = 9,
/// <summary>
- /// File: No permission error
+ /// <para>File: No permission error</para>
/// </summary>
FileNoPermission = 10,
/// <summary>
- /// File: Already in use error
+ /// <para>File: Already in use error</para>
/// </summary>
FileAlreadyInUse = 11,
/// <summary>
- /// File: Can't open error
+ /// <para>File: Can't open error</para>
/// </summary>
FileCantOpen = 12,
/// <summary>
- /// File: Can't write error
+ /// <para>File: Can't write error</para>
/// </summary>
FileCantWrite = 13,
/// <summary>
- /// File: Can't read error
+ /// <para>File: Can't read error</para>
/// </summary>
FileCantRead = 14,
/// <summary>
- /// File: Unrecognized error
+ /// <para>File: Unrecognized error</para>
/// </summary>
FileUnrecognized = 15,
/// <summary>
- /// File: Corrupt error
+ /// <para>File: Corrupt error</para>
/// </summary>
FileCorrupt = 16,
/// <summary>
- /// File: Missing dependencies error
+ /// <para>File: Missing dependencies error</para>
/// </summary>
FileMissingDependencies = 17,
/// <summary>
- /// File: End of file (EOF) error
+ /// <para>File: End of file (EOF) error</para>
/// </summary>
FileEof = 18,
/// <summary>
- /// Can't open error
+ /// <para>Can't open error</para>
/// </summary>
CantOpen = 19,
/// <summary>
- /// Can't create error
+ /// <para>Can't create error</para>
/// </summary>
CantCreate = 20,
/// <summary>
- /// Parse error
+ /// <para>Parse error</para>
/// </summary>
ParseError = 43,
/// <summary>
- /// Query failed error
+ /// <para>Query failed error</para>
/// </summary>
QueryFailed = 21,
/// <summary>
- /// Already in use error
+ /// <para>Already in use error</para>
/// </summary>
AlreadyInUse = 22,
/// <summary>
- /// Locked error
+ /// <para>Locked error</para>
/// </summary>
Locked = 23,
/// <summary>
- /// Timeout error
+ /// <para>Timeout error</para>
/// </summary>
Timeout = 24,
/// <summary>
- /// Can't acquire resource error
+ /// <para>Can't acquire resource error</para>
/// </summary>
CantAcquireResource = 28,
/// <summary>
- /// Invalid data error
+ /// <para>Invalid data error</para>
/// </summary>
InvalidData = 30,
/// <summary>
- /// Invalid parameter error
+ /// <para>Invalid parameter error</para>
/// </summary>
InvalidParameter = 31,
/// <summary>
- /// Already exists error
+ /// <para>Already exists error</para>
/// </summary>
AlreadyExists = 32,
/// <summary>
- /// Does not exist error
+ /// <para>Does not exist error</para>
/// </summary>
DoesNotExist = 33,
/// <summary>
- /// Database: Read error
+ /// <para>Database: Read error</para>
/// </summary>
DatabaseCantRead = 34,
/// <summary>
- /// Database: Write error
+ /// <para>Database: Write error</para>
/// </summary>
DatabaseCantWrite = 35,
/// <summary>
- /// Compilation failed error
+ /// <para>Compilation failed error</para>
/// </summary>
CompilationFailed = 36,
/// <summary>
- /// Method not found error
+ /// <para>Method not found error</para>
/// </summary>
MethodNotFound = 37,
/// <summary>
- /// Linking failed error
+ /// <para>Linking failed error</para>
/// </summary>
LinkFailed = 38,
/// <summary>
- /// Script failed error
+ /// <para>Script failed error</para>
/// </summary>
ScriptFailed = 39,
/// <summary>
- /// Cycling link (import cycle) error
+ /// <para>Cycling link (import cycle) error</para>
/// </summary>
CyclicLink = 40,
/// <summary>
- /// Busy error
+ /// <para>Busy error</para>
/// </summary>
Busy = 44,
/// <summary>
- /// Help error
+ /// <para>Help error</para>
/// </summary>
Help = 46,
/// <summary>
- /// Bug error
+ /// <para>Bug error</para>
/// </summary>
Bug = 47
}
@@ -1605,19 +1605,19 @@
public enum PropertyHint
{
/// <summary>
- /// No hint for edited property.
+ /// <para>No hint for edited property.</para>
/// </summary>
None = 0,
/// <summary>
- /// Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
+ /// <para>Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.</para>
/// </summary>
Range = 1,
/// <summary>
- /// Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
+ /// <para>Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.</para>
/// </summary>
ExpRange = 2,
/// <summary>
- /// Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
+ /// <para>Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.</para>
/// </summary>
Enum = 3,
/// <summary>
@@ -1633,7 +1633,7 @@
/// </summary>
KeyAccel = 7,
/// <summary>
- /// Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
+ /// <para>Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.</para>
/// </summary>
Flags = 8,
/// <summary>
@@ -1653,11 +1653,11 @@
/// </summary>
Layers3dPhysics = 12,
/// <summary>
- /// String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".
+ /// <para>String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".</para>
/// </summary>
File = 13,
/// <summary>
- /// String property is a directory (so pop up a file dialog when edited).
+ /// <para>String property is a directory (so pop up a file dialog when edited).</para>
/// </summary>
Dir = 14,
/// <summary>
@@ -1669,7 +1669,7 @@
/// </summary>
GlobalDir = 16,
/// <summary>
- /// String property is a resource, so open the resource popup menu when edited.
+ /// <para>String property is a resource, so open the resource popup menu when edited.</para>
/// </summary>
ResourceType = 17,
/// <summary>
@@ -1685,11 +1685,11 @@
/// </summary>
ColorNoAlpha = 20,
/// <summary>
- /// Hints that the image is compressed using lossy compression.
+ /// <para>Hints that the image is compressed using lossy compression.</para>
/// </summary>
ImageCompressLossy = 21,
/// <summary>
- /// Hints that the image is compressed using lossless compression.
+ /// <para>Hints that the image is compressed using lossless compression.</para>
/// </summary>
ImageCompressLossless = 22
}
@@ -1697,11 +1697,11 @@
public enum PropertyUsageFlags
{
/// <summary>
- /// Property will be used as storage (default).
+ /// <para>Property will be used as storage (default).</para>
/// </summary>
Storage = 1,
/// <summary>
- /// Property will be visible in editor (default).
+ /// <para>Property will be visible in editor (default).</para>
/// </summary>
Editor = 2,
/// <summary>
@@ -1745,7 +1745,7 @@
/// </summary>
ScriptVariable = 8192,
/// <summary>
- /// Default usage (storage and editor).
+ /// <para>Default usage (storage and editor).</para>
/// </summary>
Default = 7,
/// <summary>
@@ -1761,11 +1761,11 @@
public enum MethodFlags
{
/// <summary>
- /// Flag for normal method
+ /// <para>Flag for normal method</para>
/// </summary>
Normal = 1,
/// <summary>
- /// Flag for editor method
+ /// <para>Flag for editor method</para>
/// </summary>
Editor = 2,
/// <summary>
@@ -1773,7 +1773,7 @@
/// </summary>
Noscript = 4,
/// <summary>
- /// Flag for constant method
+ /// <para>Flag for constant method</para>
/// </summary>
Const = 8,
/// <summary>
@@ -1781,15 +1781,15 @@
/// </summary>
Reverse = 16,
/// <summary>
- /// Flag for virtual method
+ /// <para>Flag for virtual method</para>
/// </summary>
Virtual = 32,
/// <summary>
- /// Flag for method from script
+ /// <para>Flag for method from script</para>
/// </summary>
FromScript = 64,
/// <summary>
- /// Default method flags
+ /// <para>Default method flags</para>
/// </summary>
Default = 1
}
@@ -1800,115 +1800,115 @@
public enum Type
{
/// <summary>
- /// Variable is of type nil (only applied for null).
+ /// <para>Variable is of type nil (only applied for null).</para>
/// </summary>
Nil = 0,
/// <summary>
- /// Variable is of type [bool].
+ /// <para>Variable is of type <see cref="bool"/>.</para>
/// </summary>
Bool = 1,
/// <summary>
- /// Variable is of type [int].
+ /// <para>Variable is of type <see cref="int"/>.</para>
/// </summary>
Int = 2,
/// <summary>
- /// Variable is of type [float]/real.
+ /// <para>Variable is of type <see cref="float"/>/real.</para>
/// </summary>
Real = 3,
/// <summary>
- /// Variable is of type [String].
+ /// <para>Variable is of type <see cref="string"/>.</para>
/// </summary>
String = 4,
/// <summary>
- /// Variable is of type [Vector2].
+ /// <para>Variable is of type <see cref="Godot.Vector2"/>.</para>
/// </summary>
Vector2 = 5,
/// <summary>
- /// Variable is of type [Rect2].
+ /// <para>Variable is of type <see cref="Godot.Rect2"/>.</para>
/// </summary>
Rect2 = 6,
/// <summary>
- /// Variable is of type [Vector3].
+ /// <para>Variable is of type <see cref="Godot.Vector3"/>.</para>
/// </summary>
Vector3 = 7,
/// <summary>
- /// Variable is of type [Transform2D].
+ /// <para>Variable is of type <see cref="Godot.Transform2D"/>.</para>
/// </summary>
Transform2d = 8,
/// <summary>
- /// Variable is of type [Plane].
+ /// <para>Variable is of type <see cref="Godot.Plane"/>.</para>
/// </summary>
Plane = 9,
/// <summary>
- /// Variable is of type [Quat].
+ /// <para>Variable is of type <see cref="Godot.Quat"/>.</para>
/// </summary>
Quat = 10,
/// <summary>
- /// Variable is of type [AABB].
+ /// <para>Variable is of type <see cref="Godot.AABB"/>.</para>
/// </summary>
Aabb = 11,
/// <summary>
- /// Variable is of type [Basis].
+ /// <para>Variable is of type <see cref="Godot.Basis"/>.</para>
/// </summary>
Basis = 12,
/// <summary>
- /// Variable is of type [Transform].
+ /// <para>Variable is of type <see cref="Godot.Transform"/>.</para>
/// </summary>
Transform = 13,
/// <summary>
- /// Variable is of type [Color].
+ /// <para>Variable is of type <see cref="Godot.Color"/>.</para>
/// </summary>
Color = 14,
/// <summary>
- /// Variable is of type [NodePath].
+ /// <para>Variable is of type <see cref="Godot.NodePath"/>.</para>
/// </summary>
NodePath = 15,
/// <summary>
- /// Variable is of type [RID].
+ /// <para>Variable is of type <see cref="Godot.RID"/>.</para>
/// </summary>
Rid = 16,
/// <summary>
- /// Variable is of type [Object].
+ /// <para>Variable is of type <see cref="Godot.Object"/>.</para>
/// </summary>
Object = 17,
/// <summary>
- /// Variable is of type [Dictionary].
+ /// <para>Variable is of type <see cref="Godot.Collections.Dictionary"/>.</para>
/// </summary>
Dictionary = 18,
/// <summary>
- /// Variable is of type [Array].
+ /// <para>Variable is of type <see cref="Godot.Collections.Array"/>.</para>
/// </summary>
Array = 19,
/// <summary>
- /// Variable is of type [PoolByteArray].
+ /// <para>Variable is of type <see cref="byte"/>.</para>
/// </summary>
RawArray = 20,
/// <summary>
- /// Variable is of type [PoolIntArray].
+ /// <para>Variable is of type <see cref="int"/>.</para>
/// </summary>
IntArray = 21,
/// <summary>
- /// Variable is of type [PoolRealArray].
+ /// <para>Variable is of type <see cref="float"/>.</para>
/// </summary>
RealArray = 22,
/// <summary>
- /// Variable is of type [PoolStringArray].
+ /// <para>Variable is of type <see cref="string"/>.</para>
/// </summary>
StringArray = 23,
/// <summary>
- /// Variable is of type [PoolVector2Array].
+ /// <para>Variable is of type <see cref="Godot.Vector2"/>.</para>
/// </summary>
Vector2Array = 24,
/// <summary>
- /// Variable is of type [PoolVector3Array].
+ /// <para>Variable is of type <see cref="Godot.Vector3"/>.</para>
/// </summary>
Vector3Array = 25,
/// <summary>
- /// Variable is of type [PoolColorArray].
+ /// <para>Variable is of type <see cref="Godot.Color"/>.</para>
/// </summary>
ColorArray = 26,
/// <summary>
- /// Marker for end of type constants.
+ /// <para>Marker for end of type constants.</para>
/// </summary>
Max = 27
}
diff -ur GodotSharp_before/GodotSharp/ObjectType/AcceptDialog.cs GodotSharp_after/GodotSharp/ObjectType/AcceptDialog.cs
--- GodotSharp_before/GodotSharp/ObjectType/AcceptDialog.cs 2019-03-20 21:16:54.266315500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AcceptDialog.cs 2019-03-23 19:57:07.580183200 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.
+ /// <para>This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.</para>
/// </summary>
public partial class AcceptDialog : WindowDialog
{
/// <summary>
- /// The text displayed by this dialog.
+ /// <para>The text displayed by this dialog.</para>
/// </summary>
public string DialogText
{
@@ -26,8 +27,8 @@
}
/// <summary>
- /// If [code]true[/code], the dialog is hidden when the OK button is pressed. You can set it to [code]false[/code] if you want to do e.g. input validation when receiving the [signal confirmed] signal, and handle hiding the dialog in your own logic. Default value: [code]true[/code].
- /// Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example [FileDialog] defaults to [code]false[/code], and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in [FileDialog] to disable hiding the dialog when pressing OK.
+ /// <para>If <c>true</c>, the dialog is hidden when the OK button is pressed. You can set it to <c>false</c> if you want to do e.g. input validation when receiving the <c>confirmed</c> signal, and handle hiding the dialog in your own logic. Default value: <c>true</c>.</para>
+ /// <para>Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example <see cref="Godot.FileDialog"/> defaults to <c>false</c>, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in <see cref="Godot.FileDialog"/> to disable hiding the dialog when pressing OK.</para>
/// </summary>
public bool DialogHideOnOk
{
@@ -55,7 +56,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_ok");
/// <summary>
- /// Return the OK Button.
+ /// <para>Return the OK Button.</para>
/// </summary>
[GodotMethod("get_ok")]
public Button GetOk()
@@ -67,7 +68,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_label");
/// <summary>
- /// Return the label used for built-in text.
+ /// <para>Return the label used for built-in text.</para>
/// </summary>
[GodotMethod("get_label")]
public Label GetLabel()
@@ -97,8 +98,8 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_button");
/// <summary>
- /// Adds a button with label [i]text[/i] and a custom [i]action[/i] to the dialog and returns the created button. [i]action[/i] will be passed to the [signal custom_action] signal when pressed.
- /// If [code]true[/code], [i]right[/i] will place the button to the right of any sibling buttons. Default value: [code]false[/code].
+ /// <para>Adds a button with label text and a custom action to the dialog and returns the created button. action will be passed to the <c>custom_action</c> signal when pressed.</para>
+ /// <para>If <c>true</c>, right will place the button to the right of any sibling buttons. Default value: <c>false</c>.</para>
/// </summary>
[GodotMethod("add_button")]
public Button AddButton(string text, bool right = false, string action = "")
@@ -110,7 +111,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_cancel");
/// <summary>
- /// Adds a button with label [i]name[/i] and a cancel action to the dialog and returns the created button.
+ /// <para>Adds a button with label name and a cancel action to the dialog and returns the created button.</para>
/// </summary>
[GodotMethod("add_cancel")]
public Button AddCancel(string name)
@@ -122,7 +123,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "register_text_enter");
/// <summary>
- /// Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
+ /// <para>Registers a <see cref="Godot.LineEdit"/> in the dialog. When the enter key is pressed, the dialog will be accepted.</para>
/// </summary>
[GodotMethod("register_text_enter")]
public void RegisterTextEnter(Node lineEdit)
@@ -151,3 +152,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimatedSprite.cs GodotSharp_after/GodotSharp/ObjectType/AnimatedSprite.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimatedSprite.cs 2019-03-20 21:16:54.270314000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimatedSprite.cs 2019-03-23 19:57:07.584181200 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.
+ /// <para>Animations are created using a <see cref="Godot.SpriteFrames"/> resource, which can be configured in the editor via the SpriteFrames panel.</para>
/// </summary>
public partial class AnimatedSprite : Node2D
{
/// <summary>
- /// The [SpriteFrames] resource containing the animation(s).
+ /// <para>The <see cref="Godot.SpriteFrames"/> resource containing the animation(s).</para>
/// </summary>
public SpriteFrames Frames
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
+ /// <para>The current animation from the <c>frames</c> resource. If this value changes, the <c>frame</c> counter is reset.</para>
/// </summary>
public string Animation
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The displayed animation frame's index.
+ /// <para>The displayed animation frame's index.</para>
/// </summary>
public int Frame
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// If [code]true[/code], the [member animation] is currently playing.
+ /// <para>If <c>true</c>, the <see cref="Godot.AnimatedSprite.Animation"/> is currently playing.</para>
/// </summary>
public bool Playing
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// If [code]true[/code], texture will be centered. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, texture will be centered. Default value: <c>true</c>.</para>
/// </summary>
public bool Centered
{
@@ -101,7 +102,7 @@
}
/// <summary>
- /// The texture's drawing offset.
+ /// <para>The texture's drawing offset.</para>
/// </summary>
public Vector2 Offset
{
@@ -116,7 +117,7 @@
}
/// <summary>
- /// If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, texture is flipped horizontally. Default value: <c>false</c>.</para>
/// </summary>
public bool FlipH
{
@@ -131,7 +132,7 @@
}
/// <summary>
- /// If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, texture is flipped vertically. Default value: <c>false</c>.</para>
/// </summary>
public bool FlipV
{
@@ -211,7 +212,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play");
/// <summary>
- /// Play the animation set in parameter. If no parameter is provided, the current animation is played.
+ /// <para>Play the animation set in parameter. If no parameter is provided, the current animation is played.</para>
/// </summary>
[GodotMethod("play")]
public void Play(string anim = "")
@@ -223,7 +224,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "stop");
/// <summary>
- /// Stop the current animation (does not reset the frame counter).
+ /// <para>Stop the current animation (does not reset the frame counter).</para>
/// </summary>
[GodotMethod("stop")]
public void Stop()
@@ -235,7 +236,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_playing");
/// <summary>
- /// Return true if an animation if currently being played.
+ /// <para>Return true if an animation if currently being played.</para>
/// </summary>
[GodotMethod("is_playing")]
public bool IsPlaying()
@@ -354,3 +355,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimatedSprite3D.cs GodotSharp_after/GodotSharp/ObjectType/AnimatedSprite3D.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimatedSprite3D.cs 2019-03-20 21:16:54.273313500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimatedSprite3D.cs 2019-03-23 19:57:07.588179500 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.
+ /// <para>Animations are created using a <see cref="Godot.SpriteFrames"/> resource, which can be configured in the editor via the SpriteFrames panel.</para>
/// </summary>
public partial class AnimatedSprite3D : SpriteBase3D
{
/// <summary>
- /// The [SpriteFrames] resource containing the animation(s).
+ /// <para>The <see cref="Godot.SpriteFrames"/> resource containing the animation(s).</para>
/// </summary>
public SpriteFrames Frames
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
+ /// <para>The current animation from the <c>frames</c> resource. If this value changes, the <c>frame</c> counter is reset.</para>
/// </summary>
public string Animation
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The displayed animation frame's index.
+ /// <para>The displayed animation frame's index.</para>
/// </summary>
public int Frame
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// If [code]true[/code], the [member animation] is currently playing.
+ /// <para>If <c>true</c>, the <see cref="Godot.AnimatedSprite3D.Animation"/> is currently playing.</para>
/// </summary>
public bool Playing
{
@@ -136,7 +137,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play");
/// <summary>
- /// Play the animation set in parameter. If no parameter is provided, the current animation is played.
+ /// <para>Play the animation set in parameter. If no parameter is provided, the current animation is played.</para>
/// </summary>
[GodotMethod("play")]
public void Play(string anim = "")
@@ -148,7 +149,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "stop");
/// <summary>
- /// Stop the current animation (does not reset the frame counter).
+ /// <para>Stop the current animation (does not reset the frame counter).</para>
/// </summary>
[GodotMethod("stop")]
public void Stop()
@@ -160,7 +161,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_playing");
/// <summary>
- /// Return true if an animation if currently being played.
+ /// <para>Return true if an animation if currently being played.</para>
/// </summary>
[GodotMethod("is_playing")]
public bool IsPlaying()
@@ -189,3 +190,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimatedTexture.cs GodotSharp_after/GodotSharp/ObjectType/AnimatedTexture.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimatedTexture.cs 2019-03-20 21:16:54.312300800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimatedTexture.cs 2019-03-23 19:57:07.615172500 +0100
@@ -2,23 +2,24 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// [code]AnimatedTexture[/code] is a resource format for simple frame-based animations, where multiple frames textures can be chained automatically with a predefined delay for each frame. It's not a [Node], contrarily to [AnimationPlayer] or [AnimatedSprite], but has the advantage of being usable at any place where a [Texture] resource can be used, e.g. in a [TileSet].
- /// The playback of the animation is controlled by the [member fps] property as well as each frame's optional delay (see [method set_frame_delay]). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame.
- /// [code]AnimatedTexture[/code] currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one.
+ /// <para><c>AnimatedTexture</c> is a resource format for simple frame-based animations, where multiple frames textures can be chained automatically with a predefined delay for each frame. It's not a <see cref="Godot.Node"/>, contrarily to <see cref="Godot.AnimationPlayer"/> or <see cref="Godot.AnimatedSprite"/>, but has the advantage of being usable at any place where a <see cref="Godot.Texture"/> resource can be used, e.g. in a <see cref="Godot.TileSet"/>.</para>
+ /// <para>The playback of the animation is controlled by the <see cref="Godot.AnimatedTexture.Fps"/> property as well as each frame's optional delay (see <see cref="Godot.AnimatedTexture.SetFrameDelay"/>). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame.</para>
+ /// <para><c>AnimatedTexture</c> currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one.</para>
/// </summary>
public partial class AnimatedTexture : Texture
{
/// <summary>
- /// The maximum number of frames supported by [code]AnimatedTexture[/code]. If you need more frames in your animation, use [AnimationPlayer] or [AnimatedSprite].
+ /// <para>The maximum number of frames supported by <c>AnimatedTexture</c>. If you need more frames in your animation, use <see cref="Godot.AnimationPlayer"/> or <see cref="Godot.AnimatedSprite"/>.</para>
/// </summary>
public const int MaxFrames = 256;
/// <summary>
- /// Number of frames to use in the animation. While you can create the frames independently with [method set_frame_texture], you need to set this value for the animation to take new frames into account. The maximum number of frames is [constant MAX_FRAMES]. Default value: 1.
+ /// <para>Number of frames to use in the animation. While you can create the frames independently with <see cref="Godot.AnimatedTexture.SetFrameTexture"/>, you need to set this value for the animation to take new frames into account. The maximum number of frames is [constant MAX_FRAMES]. Default value: 1.</para>
/// </summary>
public int Frames
{
@@ -33,8 +34,8 @@
}
/// <summary>
- /// Number of frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the [member frames] property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see [method set_frame_delay]). Default value: 4.
- /// For example, an animation with 8 frames, no frame delay and a [code]fps[/code] value of 2 will run over 4 seconds, with one frame each 0.5 seconds.
+ /// <para>Number of frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the <see cref="Godot.AnimatedTexture.Frames"/> property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see <see cref="Godot.AnimatedTexture.SetFrameDelay"/>). Default value: 4.</para>
+ /// <para>For example, an animation with 8 frames, no frame delay and a <c>fps</c> value of 2 will run over 4 seconds, with one frame each 0.5 seconds.</para>
/// </summary>
public float Fps
{
@@ -6242,8 +6243,8 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_frame_texture");
/// <summary>
- /// Assigns a [Texture] to the given [code]frame[/code] ID. IDs start at 0 (so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1).
- /// You can define any frame texture up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation.
+ /// <para>Assigns a <see cref="Godot.Texture"/> to the given <c>frame</c> ID. IDs start at 0 (so the first frame has ID 0, and the last frame of the animation has ID <see cref="Godot.AnimatedTexture.Frames"/> - 1).</para>
+ /// <para>You can define any frame texture up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to <see cref="Godot.AnimatedTexture.Frames"/> - 1 will be part of the animation.</para>
/// </summary>
[GodotMethod("set_frame_texture")]
public void SetFrameTexture(int frame, Texture texture)
@@ -6255,7 +6256,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_frame_texture");
/// <summary>
- /// Retrieves the [Texture] assigned to the given [code]frame[/code] ID.
+ /// <para>Retrieves the <see cref="Godot.Texture"/> assigned to the given <c>frame</c> ID.</para>
/// </summary>
[GodotMethod("get_frame_texture")]
public Texture GetFrameTexture(int frame)
@@ -6267,14 +6268,14 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_frame_delay");
/// <summary>
- /// Defines an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code].
- /// For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be:
- /// [codeblock]
+ /// <para>Defines an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by <see cref="Godot.AnimatedTexture.Fps"/>. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be <c>1.0 / fps + delay</c>.</para>
+ /// <para>For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be:</para>
+ /// <para><code>
/// Frame 0: 0.5 s (1 / fps)
/// Frame 1: 1.7 s (1 / fps + 1.2)
/// Frame 2: 0.5 s (1 / fps)
/// Total duration: 2.7 s
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("set_frame_delay")]
public void SetFrameDelay(int frame, float delay)
@@ -6286,7 +6287,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_frame_delay");
/// <summary>
- /// Retrieves the delayed assigned to the given [code]frame[/code] ID.
+ /// <para>Retrieves the delayed assigned to the given <c>frame</c> ID.</para>
/// </summary>
[GodotMethod("get_frame_delay")]
public float GetFrameDelay(int frame)
@@ -6297,3 +6298,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Animation.cs GodotSharp_after/GodotSharp/ObjectType/Animation.cs
--- GodotSharp_before/GodotSharp/ObjectType/Animation.cs 2019-03-20 21:16:54.330294600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Animation.cs 2019-03-23 19:57:07.634164600 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track.
- /// [codeblock]
+ /// <para>An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track.</para>
+ /// <para><code>
/// # This creates an animation that makes the node "Enemy" move to the right by
/// # 100 pixels in 1 second.
/// var animation = Animation.new()
@@ -15,23 +16,23 @@
/// animation.track_set_path(track_index, "Enemy:position.x")
/// animation.track_insert_key(track_index, 0.0, 0)
/// animation.track_insert_key(track_index, 0.5, 100)
- /// [/codeblock]
- /// Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back.
+ /// </code></para>
+ /// <para>Animations are just data containers, and must be added to nodes such as an <see cref="Godot.AnimationPlayer"/> or <see cref="Godot.AnimationTreePlayer"/> to be played back.</para>
/// </summary>
public partial class Animation : Resource
{
public enum TrackType
{
/// <summary>
- /// Value tracks set values in node properties, but only those which can be Interpolated.
+ /// <para>Value tracks set values in node properties, but only those which can be Interpolated.</para>
/// </summary>
Value = 0,
/// <summary>
- /// Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
+ /// <para>Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.</para>
/// </summary>
Transform = 1,
/// <summary>
- /// Method tracks call functions with given arguments per key.
+ /// <para>Method tracks call functions with given arguments per key.</para>
/// </summary>
Method = 2,
/// <summary>
@@ -51,15 +52,15 @@
public enum UpdateMode
{
/// <summary>
- /// Update between keyframes.
+ /// <para>Update between keyframes.</para>
/// </summary>
Continuous = 0,
/// <summary>
- /// Update at the keyframes and hold the value.
+ /// <para>Update at the keyframes and hold the value.</para>
/// </summary>
Discrete = 1,
/// <summary>
- /// Update at the keyframes.
+ /// <para>Update at the keyframes.</para>
/// </summary>
Trigger = 2,
/// <summary>
@@ -71,21 +72,21 @@
public enum InterpolationType
{
/// <summary>
- /// No interpolation (nearest value).
+ /// <para>No interpolation (nearest value).</para>
/// </summary>
Nearest = 0,
/// <summary>
- /// Linear interpolation.
+ /// <para>Linear interpolation.</para>
/// </summary>
Linear = 1,
/// <summary>
- /// Cubic interpolation.
+ /// <para>Cubic interpolation.</para>
/// </summary>
Cubic = 2
}
/// <summary>
- /// The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
+ /// <para>The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.</para>
/// </summary>
public float Length
{
@@ -100,7 +101,7 @@
}
/// <summary>
- /// A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
+ /// <para>A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.</para>
/// </summary>
public bool Loop
{
@@ -115,7 +116,7 @@
}
/// <summary>
- /// The animation step value.
+ /// <para>The animation step value.</para>
/// </summary>
public float Step
{
@@ -143,7 +144,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_track");
/// <summary>
- /// Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration.
+ /// <para>Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration.</para>
/// </summary>
[GodotMethod("add_track")]
public int AddTrack(Animation.TrackType type, int atPosition = -1)
@@ -155,7 +156,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_track");
/// <summary>
- /// Remove a track by specifying the track index.
+ /// <para>Remove a track by specifying the track index.</para>
/// </summary>
[GodotMethod("remove_track")]
public void RemoveTrack(int idx)
@@ -167,7 +168,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_track_count");
/// <summary>
- /// Return the amount of tracks in the animation.
+ /// <para>Return the amount of tracks in the animation.</para>
/// </summary>
[GodotMethod("get_track_count")]
public int GetTrackCount()
@@ -179,7 +180,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_type");
/// <summary>
- /// Get the type of a track.
+ /// <para>Get the type of a track.</para>
/// </summary>
[GodotMethod("track_get_type")]
public Animation.TrackType TrackGetType(int idx)
@@ -191,7 +192,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_path");
/// <summary>
- /// Get the path of a track. for more information on the path format, see [method track_set_path]
+ /// <para>Get the path of a track. for more information on the path format, see <see cref="Godot.Animation.TrackSetPath"/></para>
/// </summary>
[GodotMethod("track_get_path")]
public NodePath TrackGetPath(int idx)
@@ -203,8 +204,8 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_path");
/// <summary>
- /// 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 ":".
- /// [b]Example:[/b] "character/skeleton:ankle" or "character/mesh:transform/local".
+ /// <para>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 ":".</para>
+ /// <para>Example: "character/skeleton:ankle" or "character/mesh:transform/local".</para>
/// </summary>
[GodotMethod("track_set_path")]
public void TrackSetPath(int idx, NodePath path)
@@ -216,7 +217,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "find_track");
/// <summary>
- /// Return the index of the specified track. If the track is not found, return -1.
+ /// <para>Return the index of the specified track. If the track is not found, return -1.</para>
/// </summary>
[GodotMethod("find_track")]
public int FindTrack(NodePath path)
@@ -228,7 +229,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_move_up");
/// <summary>
- /// Move a track up.
+ /// <para>Move a track up.</para>
/// </summary>
[GodotMethod("track_move_up")]
public void TrackMoveUp(int idx)
@@ -240,7 +241,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_move_down");
/// <summary>
- /// Move a track down.
+ /// <para>Move a track down.</para>
/// </summary>
[GodotMethod("track_move_down")]
public void TrackMoveDown(int idx)
@@ -264,7 +265,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_imported");
/// <summary>
- /// Set the given track as imported or not.
+ /// <para>Set the given track as imported or not.</para>
/// </summary>
[GodotMethod("track_set_imported")]
public void TrackSetImported(int idx, bool imported)
@@ -276,7 +277,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_is_imported");
/// <summary>
- /// Return true if the given track is imported. Else, return false.
+ /// <para>Return true if the given track is imported. Else, return false.</para>
/// </summary>
[GodotMethod("track_is_imported")]
public bool TrackIsImported(int idx)
@@ -288,7 +289,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_enabled");
/// <summary>
- /// Enables/disables the given track. Tracks are enabled by default.
+ /// <para>Enables/disables the given track. Tracks are enabled by default.</para>
/// </summary>
[GodotMethod("track_set_enabled")]
public void TrackSetEnabled(int idx, bool enabled)
@@ -300,7 +301,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_is_enabled");
/// <summary>
- /// Returns [code]true[/code] if the track at index [code]idx[/code] is enabled.
+ /// <para>Returns <c>true</c> if the track at index <c>idx</c> is enabled.</para>
/// </summary>
[GodotMethod("track_is_enabled")]
public bool TrackIsEnabled(int idx)
@@ -312,7 +313,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transform_track_insert_key");
/// <summary>
- /// Insert a transform key for a transform track.
+ /// <para>Insert a transform key for a transform track.</para>
/// </summary>
[GodotMethod("transform_track_insert_key")]
public int TransformTrackInsertKey(int idx, float time, Vector3 location, Quat rotation, Vector3 scale)
@@ -324,7 +325,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_insert_key");
/// <summary>
- /// Insert a generic key in a given track.
+ /// <para>Insert a generic key in a given track.</para>
/// </summary>
[GodotMethod("track_insert_key")]
public void TrackInsertKey(int idx, float time, object key, float transition = (float)1)
@@ -336,7 +337,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_remove_key");
/// <summary>
- /// Remove a key by index in a given track.
+ /// <para>Remove a key by index in a given track.</para>
/// </summary>
[GodotMethod("track_remove_key")]
public void TrackRemoveKey(int idx, int keyIdx)
@@ -348,7 +349,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_remove_key_at_position");
/// <summary>
- /// Remove a key by position (seconds) in a given track.
+ /// <para>Remove a key by position (seconds) in a given track.</para>
/// </summary>
[GodotMethod("track_remove_key_at_position")]
public void TrackRemoveKeyAtPosition(int idx, float position)
@@ -360,7 +361,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_key_value");
/// <summary>
- /// Set the value of an existing key.
+ /// <para>Set the value of an existing key.</para>
/// </summary>
[GodotMethod("track_set_key_value")]
public void TrackSetKeyValue(int idx, int key, object value)
@@ -372,7 +373,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_key_transition");
/// <summary>
- /// Set the transition curve (easing) for a specific key (see built-in math function "ease").
+ /// <para>Set the transition curve (easing) for a specific key (see built-in math function "ease").</para>
/// </summary>
[GodotMethod("track_set_key_transition")]
public void TrackSetKeyTransition(int idx, int keyIdx, float transition)
@@ -384,7 +385,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_key_transition");
/// <summary>
- /// Return the transition curve (easing) for a specific key (see built-in math function "ease").
+ /// <para>Return the transition curve (easing) for a specific key (see built-in math function "ease").</para>
/// </summary>
[GodotMethod("track_get_key_transition")]
public float TrackGetKeyTransition(int idx, int keyIdx)
@@ -396,7 +397,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_key_count");
/// <summary>
- /// Return the amount of keys in a given track.
+ /// <para>Return the amount of keys in a given track.</para>
/// </summary>
[GodotMethod("track_get_key_count")]
public int TrackGetKeyCount(int idx)
@@ -408,7 +409,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_key_value");
/// <summary>
- /// Return the value of a given key in a given track.
+ /// <para>Return the value of a given key in a given track.</para>
/// </summary>
[GodotMethod("track_get_key_value")]
public object TrackGetKeyValue(int idx, int keyIdx)
@@ -420,7 +421,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_key_time");
/// <summary>
- /// Return the time at which the key is located.
+ /// <para>Return the time at which the key is located.</para>
/// </summary>
[GodotMethod("track_get_key_time")]
public float TrackGetKeyTime(int idx, int keyIdx)
@@ -432,7 +433,7 @@
private static IntPtr method_bind_24 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_find_key");
/// <summary>
- /// Find the key index by time in a given track. Optionally, only find it if the exact time is given.
+ /// <para>Find the key index by time in a given track. Optionally, only find it if the exact time is given.</para>
/// </summary>
[GodotMethod("track_find_key")]
public int TrackFindKey(int idx, float time, bool exact = false)
@@ -444,7 +445,7 @@
private static IntPtr method_bind_25 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_interpolation_type");
/// <summary>
- /// Set the interpolation type of a given track, from the INTERPOLATION_* enum.
+ /// <para>Set the interpolation type of a given track, from the INTERPOLATION_* enum.</para>
/// </summary>
[GodotMethod("track_set_interpolation_type")]
public void TrackSetInterpolationType(int idx, Animation.InterpolationType interpolation)
@@ -456,7 +457,7 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_interpolation_type");
/// <summary>
- /// Return the interpolation type of a given track, from the INTERPOLATION_* enum.
+ /// <para>Return the interpolation type of a given track, from the INTERPOLATION_* enum.</para>
/// </summary>
[GodotMethod("track_get_interpolation_type")]
public Animation.InterpolationType TrackGetInterpolationType(int idx)
@@ -468,7 +469,7 @@
private static IntPtr method_bind_27 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_set_interpolation_loop_wrap");
/// <summary>
- /// If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop.
+ /// <para>If <c>true</c>, the track at <c>idx</c> wraps the interpolation loop.</para>
/// </summary>
[GodotMethod("track_set_interpolation_loop_wrap")]
public void TrackSetInterpolationLoopWrap(int idx, bool interpolation)
@@ -480,7 +481,7 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "track_get_interpolation_loop_wrap");
/// <summary>
- /// Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. Default value: [code]true[/code].
+ /// <para>Returns <c>true</c> if the track at <c>idx</c> wraps the interpolation loop. Default value: <c>true</c>.</para>
/// </summary>
[GodotMethod("track_get_interpolation_loop_wrap")]
public bool TrackGetInterpolationLoopWrap(int idx)
@@ -492,7 +493,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transform_track_interpolate");
/// <summary>
- /// Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]).
+ /// <para>Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (<see cref="Godot.Vector3"/>), rotation (<see cref="Godot.Quat"/>) and scale (<see cref="Godot.Vector3"/>).</para>
/// </summary>
[GodotMethod("transform_track_interpolate")]
public Godot.Collections.Array TransformTrackInterpolate(int idx, float timeSec)
@@ -504,7 +505,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "value_track_set_update_mode");
/// <summary>
- /// Set the update mode (UPDATE_*) of a value track.
+ /// <para>Set the update mode (UPDATE_*) of a value track.</para>
/// </summary>
[GodotMethod("value_track_set_update_mode")]
public void ValueTrackSetUpdateMode(int idx, Animation.UpdateMode mode)
@@ -516,7 +517,7 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "value_track_get_update_mode");
/// <summary>
- /// Return the update mode of a value track.
+ /// <para>Return the update mode of a value track.</para>
/// </summary>
[GodotMethod("value_track_get_update_mode")]
public Animation.UpdateMode ValueTrackGetUpdateMode(int idx)
@@ -528,7 +529,7 @@
private static IntPtr method_bind_32 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "value_track_get_key_indices");
/// <summary>
- /// Return all the key indices of a value track, given a position and delta time.
+ /// <para>Return all the key indices of a value track, given a position and delta time.</para>
/// </summary>
[GodotMethod("value_track_get_key_indices")]
public int[] ValueTrackGetKeyIndices(int idx, float timeSec, float delta)
@@ -540,7 +541,7 @@
private static IntPtr method_bind_33 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "method_track_get_key_indices");
/// <summary>
- /// Return all the key indices of a method track, given a position and delta time.
+ /// <para>Return all the key indices of a method track, given a position and delta time.</para>
/// </summary>
[GodotMethod("method_track_get_key_indices")]
public int[] MethodTrackGetKeyIndices(int idx, float timeSec, float delta)
@@ -552,7 +553,7 @@
private static IntPtr method_bind_34 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "method_track_get_name");
/// <summary>
- /// Return the method name of a method track.
+ /// <para>Return the method name of a method track.</para>
/// </summary>
[GodotMethod("method_track_get_name")]
public string MethodTrackGetName(int idx, int keyIdx)
@@ -564,7 +565,7 @@
private static IntPtr method_bind_35 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "method_track_get_params");
/// <summary>
- /// Return the arguments values to be called on a method track for a given key in a given track.
+ /// <para>Return the arguments values to be called on a method track for a given key in a given track.</para>
/// </summary>
[GodotMethod("method_track_get_params")]
public Godot.Collections.Array MethodTrackGetParams(int idx, int keyIdx)
@@ -577,8 +578,8 @@
/// <summary>
///
- /// &lt;param name="inHandle"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
- /// &lt;param name="outHandle"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <param name="inHandle">If the parameter is null, then the default value is new Vector2(0, 0)</param>
+ /// <param name="outHandle">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("bezier_track_insert_key")]
public int BezierTrackInsertKey(int track, float time, float value, Nullable<Vector2> inHandle = null, Nullable<Vector2> outHandle = null)
@@ -850,7 +851,7 @@
private static IntPtr method_bind_60 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear");
/// <summary>
- /// Clear the animation (clear all tracks and reset all).
+ /// <para>Clear the animation (clear all tracks and reset all).</para>
/// </summary>
[GodotMethod("clear")]
public void Clear()
@@ -862,7 +863,7 @@
private static IntPtr method_bind_61 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "copy_track");
/// <summary>
- /// Adds a new track that is a copy of the given track from [code]to_animation[/code].
+ /// <para>Adds a new track that is a copy of the given track from <c>to_animation</c>.</para>
/// </summary>
[GodotMethod("copy_track")]
public void CopyTrack(int track, Animation toAnimation)
@@ -873,3 +874,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNode.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNode.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNode.cs 2019-03-20 21:16:54.336292300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNode.cs 2019-03-23 19:57:07.640164500 +0100
@@ -2,37 +2,38 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Base resource for [AnimationTree] nodes. In general it's not used directly but you can create custom ones with custom blending formulas.
- /// Inherit this when creating nodes mainly for use in [AnimationNodeBlendTree], otherwise [AnimationRootNode] should be used instead.
+ /// <para>Base resource for <see cref="Godot.AnimationTree"/> nodes. In general it's not used directly but you can create custom ones with custom blending formulas.</para>
+ /// <para>Inherit this when creating nodes mainly for use in <see cref="Godot.AnimationNodeBlendTree"/>, otherwise <see cref="Godot.AnimationRootNode"/> should be used instead.</para>
/// </summary>
public partial class AnimationNode : Resource
{
public enum FilterAction
{
/// <summary>
- /// Do not use filtering.
+ /// <para>Do not use filtering.</para>
/// </summary>
Ignore = 0,
/// <summary>
- /// Paths matching the filter will be allowed to pass.
+ /// <para>Paths matching the filter will be allowed to pass.</para>
/// </summary>
Pass = 1,
/// <summary>
- /// Paths matching the filter will be discarded.
+ /// <para>Paths matching the filter will be discarded.</para>
/// </summary>
Stop = 2,
/// <summary>
- /// Paths matching the filter will be blended (by the blend value).
+ /// <para>Paths matching the filter will be blended (by the blend value).</para>
/// </summary>
Blend = 3
}
/// <summary>
- /// Return whether filtering is enabled.
+ /// <para>Return whether filtering is enabled.</para>
/// </summary>
public bool FilterEnabled
{
@@ -69,7 +70,7 @@
internal AnimationNode(bool memoryOwn) : base(memoryOwn) {}
/// <summary>
- /// Get the text caption for this node (used by some editors)
+ /// <para>Get the text caption for this node (used by some editors)</para>
/// </summary>
[GodotMethod("get_caption")]
public virtual string GetCaption()
@@ -78,7 +79,7 @@
}
/// <summary>
- /// Get the a child node by index (used by editors inheriting from [AnimationRootNode]).
+ /// <para>Get the a child node by index (used by editors inheriting from <see cref="Godot.AnimationRootNode"/>).</para>
/// </summary>
[GodotMethod("get_child_by_name")]
public virtual Object GetChildByName(string name)
@@ -87,7 +88,7 @@
}
/// <summary>
- /// Get all children nodes, in order as a name:node dictionary. Only useful when inheriting [AnimationRootNode].
+ /// <para>Get all children nodes, in order as a name:node dictionary. Only useful when inheriting <see cref="Godot.AnimationRootNode"/>.</para>
/// </summary>
[GodotMethod("get_child_nodes")]
public virtual Godot.Collections.Dictionary GetChildNodes()
@@ -96,7 +97,7 @@
}
/// <summary>
- /// Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
+ /// <para>Get the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.</para>
/// </summary>
[GodotMethod("get_parameter_default_value")]
public virtual object GetParameterDefaultValue(string name)
@@ -105,7 +106,7 @@
}
/// <summary>
- /// Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list].
+ /// <para>Get the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to <see cref="Godot.Object.GetPropertyList"/>.</para>
/// </summary>
[GodotMethod("get_parameter_list")]
public virtual Godot.Collections.Array GetParameterList()
@@ -114,7 +115,7 @@
}
/// <summary>
- /// Return true whether you want the blend tree editor to display filter editing on this node.
+ /// <para>Return true whether you want the blend tree editor to display filter editing on this node.</para>
/// </summary>
[GodotMethod("has_filter")]
public virtual string HasFilter()
@@ -123,10 +124,10 @@
}
/// <summary>
- /// Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute).
- /// Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions.
- /// You can also use [method get_parameter] and [method set_parameter] to modify local memory.
- /// This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called).
+ /// <para>Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute).</para>
+ /// <para>Here, call the <see cref="Godot.AnimationNode.BlendInput"/>, <see cref="Godot.AnimationNode.BlendNode"/> or <see cref="Godot.AnimationNode.BlendAnimation"/> functions.</para>
+ /// <para>You can also use <see cref="Godot.AnimationNode.GetParameter"/> and <see cref="Godot.AnimationNode.SetParameter"/> to modify local memory.</para>
+ /// <para>This function returns the time left for the current animation to finish (if unsure, just pass the value from the main blend being called).</para>
/// </summary>
[GodotMethod("process")]
public virtual void Process(float time, bool seek)
@@ -138,7 +139,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_input_count");
/// <summary>
- /// Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree].
+ /// <para>Amount of inputs in this node, only useful for nodes that go into <see cref="Godot.AnimationNodeBlendTree"/>.</para>
/// </summary>
[GodotMethod("get_input_count")]
public int GetInputCount()
@@ -150,7 +151,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_input_name");
/// <summary>
- /// Get the name of an input by index.
+ /// <para>Get the name of an input by index.</para>
/// </summary>
[GodotMethod("get_input_name")]
public string GetInputName(int input)
@@ -162,7 +163,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_input");
/// <summary>
- /// Add an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree]
+ /// <para>Add an input to the node. This is only useful for nodes created for use in an <see cref="Godot.AnimationNodeBlendTree"/></para>
/// </summary>
[GodotMethod("add_input")]
public void AddInput(string name)
@@ -174,7 +175,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_input");
/// <summary>
- /// Remove an input, call this only when inactive.
+ /// <para>Remove an input, call this only when inactive.</para>
/// </summary>
[GodotMethod("remove_input")]
public void RemoveInput(int index)
@@ -186,7 +187,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_filter_path");
/// <summary>
- /// Add/Remove a path for the filter.
+ /// <para>Add/Remove a path for the filter.</para>
/// </summary>
[GodotMethod("set_filter_path")]
public void SetFilterPath(NodePath path, bool enable)
@@ -198,7 +199,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_path_filtered");
/// <summary>
- /// Return true wether a given path is filtered.
+ /// <para>Return true wether a given path is filtered.</para>
/// </summary>
[GodotMethod("is_path_filtered")]
public bool IsPathFiltered(NodePath path)
@@ -244,7 +245,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend_animation");
/// <summary>
- /// Blend an animation by "blend" amount (name must be valid in the linked [AnimationPlayer]). A time and delta mas be passed, as well as whether seek happened.
+ /// <para>Blend an animation by "blend" amount (name must be valid in the linked <see cref="Godot.AnimationPlayer"/>). A time and delta mas be passed, as well as whether seek happened.</para>
/// </summary>
[GodotMethod("blend_animation")]
public void BlendAnimation(string animation, float time, float delta, bool seeked, float blend)
@@ -256,7 +257,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend_node");
/// <summary>
- /// Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition.
+ /// <para>Blend another animaiton node (in case this node contains children animation nodes). This function is only useful if you inherit from <see cref="Godot.AnimationRootNode"/> instead, else editors will not display your node for addition.</para>
/// </summary>
[GodotMethod("blend_node")]
public float BlendNode(string name, AnimationNode node, float time, bool seek, float blend, AnimationNode.FilterAction filter = (AnimationNode.FilterAction)0, bool optimize = true)
@@ -268,7 +269,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend_input");
/// <summary>
- /// Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed.
+ /// <para>Blend an input. This is only useful for nodes created for an <see cref="Godot.AnimationNodeBlendTree"/>. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed.</para>
/// </summary>
[GodotMethod("blend_input")]
public float BlendInput(int inputIndex, float time, bool seek, float blend, AnimationNode.FilterAction filter = (AnimationNode.FilterAction)0, bool optimize = true)
@@ -280,7 +281,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_parameter");
/// <summary>
- /// Set a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.
+ /// <para>Set a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.</para>
/// </summary>
[GodotMethod("set_parameter")]
public void SetParameter(string name, object value)
@@ -292,7 +293,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_parameter");
/// <summary>
- /// Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
+ /// <para>Get the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.</para>
/// </summary>
[GodotMethod("get_parameter")]
public object GetParameter(string name)
@@ -303,3 +304,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeAdd2.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeAdd2.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeAdd2.cs 2019-03-20 21:16:54.340291000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeAdd2.cs 2019-03-23 19:57:07.644161000 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -53,3 +54,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeAdd3.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeAdd3.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeAdd3.cs 2019-03-20 21:16:54.343290100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeAdd3.cs 2019-03-23 19:57:07.646161100 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -53,3 +54,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeAnimation.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeAnimation.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeAnimation.cs 2019-03-20 21:16:54.345289900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeAnimation.cs 2019-03-23 19:57:07.648160400 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -53,3 +54,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlend2.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlend2.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlend2.cs 2019-03-20 21:16:54.348288400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlend2.cs 2019-03-23 19:57:07.651160700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -53,3 +54,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlend3.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlend3.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlend3.cs 2019-03-20 21:16:54.350287500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlend3.cs 2019-03-23 19:57:07.653159200 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -53,3 +54,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlendSpace1D.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlendSpace1D.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlendSpace1D.cs 2019-03-20 21:16:54.362283800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlendSpace1D.cs 2019-03-23 19:57:07.662156100 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -1780,3 +1781,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlendSpace2D.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlendSpace2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlendSpace2D.cs 2019-03-20 21:16:54.378278700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlendSpace2D.cs 2019-03-23 19:57:07.674152500 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -1971,3 +1972,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlendTree.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlendTree.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeBlendTree.cs 2019-03-20 21:16:54.385278400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeBlendTree.cs 2019-03-23 19:57:07.680149700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -62,7 +63,7 @@
/// <summary>
///
- /// &lt;param name="position"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <param name="position">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("add_node")]
public void AddNode(string name, AnimationNode node, Nullable<Vector2> position = null)
@@ -188,3 +189,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeOneShot.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeOneShot.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeOneShot.cs 2019-03-20 21:16:54.389276500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeOneShot.cs 2019-03-23 19:57:07.684148200 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -254,3 +255,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeOutput.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeOutput.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeOutput.cs 2019-03-20 21:16:54.393273900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeOutput.cs 2019-03-23 19:57:07.686148000 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeStateMachine.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeStateMachine.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeStateMachine.cs 2019-03-20 21:16:54.398272600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeStateMachine.cs 2019-03-23 19:57:07.690146700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -22,7 +23,7 @@
/// <summary>
///
- /// &lt;param name="position"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <param name="position">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("add_node")]
public void AddNode(string name, AnimationNode node, Nullable<Vector2> position = null)
@@ -286,3 +287,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeStateMachinePlayback.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeStateMachinePlayback.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeStateMachinePlayback.cs 2019-03-20 21:16:54.402270900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeStateMachinePlayback.cs 2019-03-23 19:57:07.695144800 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -92,3 +93,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeStateMachineTransition.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeStateMachineTransition.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeStateMachineTransition.cs 2019-03-20 21:16:54.407269500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeStateMachineTransition.cs 2019-03-23 19:57:07.698143900 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -234,3 +235,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeTimeScale.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeTimeScale.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeTimeScale.cs 2019-03-20 21:16:54.409268400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeTimeScale.cs 2019-03-23 19:57:07.700143300 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeTimeSeek.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeTimeSeek.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeTimeSeek.cs 2019-03-20 21:16:54.411267900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeTimeSeek.cs 2019-03-23 19:57:07.702142700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationNodeTransition.cs GodotSharp_after/GodotSharp/ObjectType/AnimationNodeTransition.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationNodeTransition.cs 2019-03-20 21:16:54.419265100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationNodeTransition.cs 2019-03-23 19:57:07.709142100 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -1082,3 +1083,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationPlayer.cs GodotSharp_after/GodotSharp/ObjectType/AnimationPlayer.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationPlayer.cs 2019-03-20 21:16:54.429261600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationPlayer.cs 2019-03-23 19:57:07.718138000 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
+ /// <para>An animation player is used for general purpose playback of <see cref="Godot.Animation"/> resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.</para>
/// </summary>
public partial class AnimationPlayer : Node
{
public enum AnimationProcessMode
{
/// <summary>
- /// Process animation during the physics process. This is especially useful when animating physics bodies.
+ /// <para>Process animation during the physics process. This is especially useful when animating physics bodies.</para>
/// </summary>
Physics = 0,
/// <summary>
- /// Process animation during the idle process.
+ /// <para>Process animation during the idle process.</para>
/// </summary>
Idle = 1,
/// <summary>
- /// Do not process animation. Use the 'advance' method to process the animation manually.
+ /// <para>Do not process animation. Use the 'advance' method to process the animation manually.</para>
/// </summary>
Manual = 2
}
/// <summary>
- /// The node from which node path references will travel. Default value: [code]".."[/code].
+ /// <para>The node from which node path references will travel. Default value: <c>".."</c>.</para>
/// </summary>
public NodePath RootNode
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. Default value: [code]""[/code].
+ /// <para>The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also <see cref="Godot.AnimationPlayer.Play"/>. Default value: <c>""</c>.</para>
/// </summary>
public string CurrentAnimation
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also [member current_animation].
+ /// <para>If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also <see cref="Godot.AnimationPlayer.CurrentAnimation"/>.</para>
/// </summary>
public string AssignedAnimation
{
@@ -72,7 +73,7 @@
}
/// <summary>
- /// The name of the animation to play when the scene loads. Default value: [code]""[/code].
+ /// <para>The name of the animation to play when the scene loads. Default value: <c>""</c>.</para>
/// </summary>
public string Autoplay
{
@@ -87,7 +88,7 @@
}
/// <summary>
- /// The length (in seconds) of the currently being played animation.
+ /// <para>The length (in seconds) of the currently being played animation.</para>
/// </summary>
public float CurrentAnimationLength
{
@@ -98,7 +99,7 @@
}
/// <summary>
- /// The position (in seconds) of the currently playing animation.
+ /// <para>The position (in seconds) of the currently playing animation.</para>
/// </summary>
public float CurrentAnimationPosition
{
@@ -109,7 +110,7 @@
}
/// <summary>
- /// The process notification in which to update animations. Default value: [code]ANIMATION_PROCESS_IDLE[/code].
+ /// <para>The process notification in which to update animations. Default value: <c>ANIMATION_PROCESS_IDLE</c>.</para>
/// </summary>
public AnimationPlayer.AnimationProcessMode PlaybackProcessMode
{
@@ -124,7 +125,7 @@
}
/// <summary>
- /// The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code].
+ /// <para>The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: <c>0</c>.</para>
/// </summary>
public float PlaybackDefaultBlendTime
{
@@ -139,7 +140,7 @@
}
/// <summary>
- /// If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, updates animations in response to process-related notifications. Default value: <c>true</c>.</para>
/// </summary>
public bool PlaybackActive
{
@@ -154,7 +155,7 @@
}
/// <summary>
- /// The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: [code]1[/code].
+ /// <para>The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: <c>1</c>.</para>
/// </summary>
public float PlaybackSpeed
{
@@ -182,7 +183,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_animation");
/// <summary>
- /// Adds [code]animation[/code] to the player accessible with the key [code]name[/code].
+ /// <para>Adds <c>animation</c> to the player accessible with the key <c>name</c>.</para>
/// </summary>
[GodotMethod("add_animation")]
public Error AddAnimation(string name, Animation animation)
@@ -194,7 +195,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_animation");
/// <summary>
- /// Remove the animation with key [code]name[/code].
+ /// <para>Remove the animation with key <c>name</c>.</para>
/// </summary>
[GodotMethod("remove_animation")]
public void RemoveAnimation(string name)
@@ -206,7 +207,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "rename_animation");
/// <summary>
- /// Rename an existing animation with key [code]name[/code] to [code]newname[/code].
+ /// <para>Rename an existing animation with key <c>name</c> to <c>newname</c>.</para>
/// </summary>
[GodotMethod("rename_animation")]
public void RenameAnimation(string name, string newname)
@@ -218,7 +219,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "has_animation");
/// <summary>
- /// Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code].
+ /// <para>Returns <c>true</c> if the <c>AnimationPlayer</c> stores an <see cref="Godot.Animation"/> with key <c>name</c>.</para>
/// </summary>
[GodotMethod("has_animation")]
public bool HasAnimation(string name)
@@ -230,7 +231,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_animation");
/// <summary>
- /// Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found.
+ /// <para>Returns the <see cref="Godot.Animation"/> with key <c>name</c> or <c>null</c> if not found.</para>
/// </summary>
[GodotMethod("get_animation")]
public Animation GetAnimation(string name)
@@ -242,7 +243,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_animation_list");
/// <summary>
- /// Returns the list of stored animation names.
+ /// <para>Returns the list of stored animation names.</para>
/// </summary>
[GodotMethod("get_animation_list")]
public string[] GetAnimationList()
@@ -254,7 +255,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_set_next");
/// <summary>
- /// Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes.
+ /// <para>Triggers the <c>anim_to</c> animation when the <c>anim_from</c> animation completes.</para>
/// </summary>
[GodotMethod("animation_set_next")]
public void AnimationSetNext(string animFrom, string animTo)
@@ -266,7 +267,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_get_next");
/// <summary>
- /// Returns the name of the next animation in the queue.
+ /// <para>Returns the name of the next animation in the queue.</para>
/// </summary>
[GodotMethod("animation_get_next")]
public string AnimationGetNext(string animFrom)
@@ -278,7 +279,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_blend_time");
/// <summary>
- /// Specify a blend time (in seconds) between two animations, referenced by their names.
+ /// <para>Specify a blend time (in seconds) between two animations, referenced by their names.</para>
/// </summary>
[GodotMethod("set_blend_time")]
public void SetBlendTime(string animFrom, string animTo, float sec)
@@ -290,7 +291,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_blend_time");
/// <summary>
- /// Get the blend time (in seconds) between two animations, referenced by their names.
+ /// <para>Get the blend time (in seconds) between two animations, referenced by their names.</para>
/// </summary>
[GodotMethod("get_blend_time")]
public float GetBlendTime(string animFrom, string animTo)
@@ -320,8 +321,8 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play");
/// <summary>
- /// Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards.
- /// If the animation has been paused by [code]stop(true)[/code] it will be resumed. Calling [code]play()[/code] without arguments will also resume the animation.
+ /// <para>Play the animation with key <c>name</c>. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards.</para>
+ /// <para>If the animation has been paused by <c>stop(true)</c> it will be resumed. Calling <c>play()</c> without arguments will also resume the animation.</para>
/// </summary>
[GodotMethod("play")]
public void Play(string name = "", float customBlend = (float)-1, float customSpeed = 1f, bool fromEnd = false)
@@ -333,8 +334,8 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play_backwards");
/// <summary>
- /// Play the animation with key [code]name[/code] in reverse.
- /// If the animation has been paused by [code]stop(true)[/code] it will be resumed backwards. Calling [code]play_backwards()[/code] without arguments will also resume the animation backwards.
+ /// <para>Play the animation with key <c>name</c> in reverse.</para>
+ /// <para>If the animation has been paused by <c>stop(true)</c> it will be resumed backwards. Calling <c>play_backwards()</c> without arguments will also resume the animation backwards.</para>
/// </summary>
[GodotMethod("play_backwards")]
public void PlayBackwards(string name = "", float customBlend = (float)-1)
@@ -346,8 +347,8 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "stop");
/// <summary>
- /// Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code].
- /// If [code]reset[/code] is [code]false[/code], then calling [code]play()[/code] without arguments or [code]play("same_as_before")[/code] will resume the animation. Works the same for the [code]play_backwards()[/code] method.
+ /// <para>Stop the currently playing animation. If <c>reset</c> is <c>true</c>, the animation position is reset to <c>0</c> and the playback speed is reset to <c>1.0</c>.</para>
+ /// <para>If <c>reset</c> is <c>false</c>, then calling <c>play()</c> without arguments or <c>play("same_as_before")</c> will resume the animation. Works the same for the <c>play_backwards()</c> method.</para>
/// </summary>
[GodotMethod("stop")]
public void Stop(bool reset = true)
@@ -359,7 +360,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_playing");
/// <summary>
- /// Returns [code]true[/code] if playing an animation.
+ /// <para>Returns <c>true</c> if playing an animation.</para>
/// </summary>
[GodotMethod("is_playing")]
public bool IsPlaying()
@@ -407,7 +408,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "queue");
/// <summary>
- /// Queue an animation for playback once the current one is done.
+ /// <para>Queue an animation for playback once the current one is done.</para>
/// </summary>
[GodotMethod("queue")]
public void Queue(string name)
@@ -431,7 +432,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_queue");
/// <summary>
- /// Clears all queued, unplayed animations.
+ /// <para>Clears all queued, unplayed animations.</para>
/// </summary>
[GodotMethod("clear_queue")]
public void ClearQueue()
@@ -479,7 +480,7 @@
private static IntPtr method_bind_27 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_playing_speed");
/// <summary>
- /// Get the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method.
+ /// <para>Get the actual playing speed of current animation or 0 if not playing. This speed is the <c>playback_speed</c> property multiplied by <c>custom_speed</c> argument specified when calling the <c>play</c> method.</para>
/// </summary>
[GodotMethod("get_playing_speed")]
public float GetPlayingSpeed()
@@ -527,7 +528,7 @@
private static IntPtr method_bind_32 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "find_animation");
/// <summary>
- /// Returns the name of [code]animation[/code] or empty string if not found.
+ /// <para>Returns the name of <c>animation</c> or empty string if not found.</para>
/// </summary>
[GodotMethod("find_animation")]
public string FindAnimation(Animation animation)
@@ -539,7 +540,7 @@
private static IntPtr method_bind_33 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_caches");
/// <summary>
- /// [code]AnimationPlayer[/code] caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
+ /// <para><c>AnimationPlayer</c> caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.</para>
/// </summary>
[GodotMethod("clear_caches")]
public void ClearCaches()
@@ -587,7 +588,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "seek");
/// <summary>
- /// Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped.
+ /// <para>Seek the animation to the <c>seconds</c> point in time (in seconds). If <c>update</c> is <c>true</c>, the animation updates too, otherwise it updates at process time. Events between the current frame and <c>seconds</c> are skipped.</para>
/// </summary>
[GodotMethod("seek")]
public void Seek(float seconds, bool update = false)
@@ -599,7 +600,7 @@
private static IntPtr method_bind_39 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "advance");
/// <summary>
- /// Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
+ /// <para>Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and <c>delta</c> are handled.</para>
/// </summary>
[GodotMethod("advance")]
public void Advance(float delta)
@@ -610,3 +611,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationRootNode.cs GodotSharp_after/GodotSharp/ObjectType/AnimationRootNode.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationRootNode.cs 2019-03-20 21:16:54.433268000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationRootNode.cs 2019-03-23 19:57:07.721136600 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationTree.cs GodotSharp_after/GodotSharp/ObjectType/AnimationTree.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationTree.cs 2019-03-20 21:16:54.436259400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationTree.cs 2019-03-23 19:57:07.724135200 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -237,3 +238,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AnimationTreePlayer.cs GodotSharp_after/GodotSharp/ObjectType/AnimationTreePlayer.cs
--- GodotSharp_before/GodotSharp/ObjectType/AnimationTreePlayer.cs 2019-03-20 21:16:54.447255800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AnimationTreePlayer.cs 2019-03-23 19:57:07.737132700 +0100
@@ -2,23 +2,24 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A node graph tool for blending multiple animations bound to an [AnimationPlayer]. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose.
- /// It takes [Animation]s from an [AnimationPlayer] node and mixes them depending on the graph.
+ /// <para>A node graph tool for blending multiple animations bound to an <see cref="Godot.AnimationPlayer"/>. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose.</para>
+ /// <para>It takes <see cref="Godot.Animation"/>s from an <see cref="Godot.AnimationPlayer"/> node and mixes them depending on the graph.</para>
/// </summary>
public partial class AnimationTreePlayer : Node
{
public enum AnimationProcessMode
{
/// <summary>
- /// Process animation during the physics process. This is especially useful when animating physics bodies.
+ /// <para>Process animation during the physics process. This is especially useful when animating physics bodies.</para>
/// </summary>
Physics = 0,
/// <summary>
- /// Process animation during the idle process.
+ /// <para>Process animation during the idle process.</para>
/// </summary>
Idle = 1
}
@@ -26,49 +27,49 @@
public enum NodeType
{
/// <summary>
- /// Output node.
+ /// <para>Output node.</para>
/// </summary>
Output = 0,
/// <summary>
- /// Animation node.
+ /// <para>Animation node.</para>
/// </summary>
Animation = 1,
/// <summary>
- /// OneShot node.
+ /// <para>OneShot node.</para>
/// </summary>
Oneshot = 2,
/// <summary>
- /// Mix node.
+ /// <para>Mix node.</para>
/// </summary>
Mix = 3,
/// <summary>
- /// Blend2 node.
+ /// <para>Blend2 node.</para>
/// </summary>
Blend2 = 4,
/// <summary>
- /// Blend3 node.
+ /// <para>Blend3 node.</para>
/// </summary>
Blend3 = 5,
/// <summary>
- /// Blend4 node.
+ /// <para>Blend4 node.</para>
/// </summary>
Blend4 = 6,
/// <summary>
- /// TimeScale node.
+ /// <para>TimeScale node.</para>
/// </summary>
Timescale = 7,
/// <summary>
- /// TimeSeek node.
+ /// <para>TimeSeek node.</para>
/// </summary>
Timeseek = 8,
/// <summary>
- /// Transition node.
+ /// <para>Transition node.</para>
/// </summary>
Transition = 9
}
/// <summary>
- /// The thread in which to update animations. Default value: [code]ANIMATION_PROCESS_IDLE[/code].
+ /// <para>The thread in which to update animations. Default value: <c>ANIMATION_PROCESS_IDLE</c>.</para>
/// </summary>
public AnimationTreePlayer.AnimationProcessMode PlaybackProcessMode
{
@@ -83,8 +84,8 @@
}
/// <summary>
- /// The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes.
- /// Once set, Animation nodes can be added to the AnimationTreePlayer.
+ /// <para>The path to the <see cref="Godot.AnimationPlayer"/> from which this <c>AnimationTreePlayer</c> binds animations to animation nodes.</para>
+ /// <para>Once set, Animation nodes can be added to the AnimationTreePlayer.</para>
/// </summary>
public NodePath MasterPlayer
{
@@ -99,8 +100,8 @@
}
/// <summary>
- /// The node from which to relatively access other nodes. Default value: [code]".."[/code].
- /// It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.
+ /// <para>The node from which to relatively access other nodes. Default value: <c>".."</c>.</para>
+ /// <para>It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.</para>
/// </summary>
public NodePath BasePath
{
@@ -115,7 +116,7 @@
}
/// <summary>
- /// If [code]true[/code], the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the <c>AnimationTreePlayer</c> is able to play animations. Default value: <c>false</c>.</para>
/// </summary>
public bool Active
{
@@ -143,7 +144,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_node");
/// <summary>
- /// Adds a [code]type[/code] node to the graph with name [code]id[/code].
+ /// <para>Adds a <c>type</c> node to the graph with name <c>id</c>.</para>
/// </summary>
[GodotMethod("add_node")]
public void AddNode(AnimationTreePlayer.NodeType type, string id)
@@ -155,7 +156,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_exists");
/// <summary>
- /// Check if a node exists (by name).
+ /// <para>Check if a node exists (by name).</para>
/// </summary>
[GodotMethod("node_exists")]
public bool NodeExists(string node)
@@ -167,7 +168,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_rename");
/// <summary>
- /// Rename a node in the graph.
+ /// <para>Rename a node in the graph.</para>
/// </summary>
[GodotMethod("node_rename")]
public Error NodeRename(string node, string newName)
@@ -179,7 +180,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_get_type");
/// <summary>
- /// Get the node type, will return from NODE_* enum.
+ /// <para>Get the node type, will return from NODE_* enum.</para>
/// </summary>
[GodotMethod("node_get_type")]
public AnimationTreePlayer.NodeType NodeGetType(string id)
@@ -191,7 +192,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_get_input_count");
/// <summary>
- /// Return the input count for a given node. Different types of nodes have different amount of inputs.
+ /// <para>Return the input count for a given node. Different types of nodes have different amount of inputs.</para>
/// </summary>
[GodotMethod("node_get_input_count")]
public int NodeGetInputCount(string id)
@@ -203,7 +204,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_get_input_source");
/// <summary>
- /// Return the input source for a given node input.
+ /// <para>Return the input source for a given node input.</para>
/// </summary>
[GodotMethod("node_get_input_source")]
public string NodeGetInputSource(string id, int idx)
@@ -215,7 +216,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_node_set_animation");
/// <summary>
- /// Binds a new [Animation] from the [member master_player] to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code].
+ /// <para>Binds a new <see cref="Godot.Animation"/> from the <see cref="Godot.AnimationTreePlayer.MasterPlayer"/> to the <c>AnimationTreePlayer</c>'s animation node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("animation_node_set_animation")]
public void AnimationNodeSetAnimation(string id, Animation animation)
@@ -227,7 +228,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_node_get_animation");
/// <summary>
- /// Returns the [AnimationPlayer]'s [Animation] bound to the [code]AnimationTreePlayer[/code]'s animation node with name [code]id[/code].
+ /// <para>Returns the <see cref="Godot.AnimationPlayer"/>'s <see cref="Godot.Animation"/> bound to the <c>AnimationTreePlayer</c>'s animation node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("animation_node_get_animation")]
public Animation AnimationNodeGetAnimation(string id)
@@ -239,7 +240,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_node_set_master_animation");
/// <summary>
- /// Binds the [Animation] named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches.
+ /// <para>Binds the <see cref="Godot.Animation"/> named <c>source</c> from <see cref="Godot.AnimationTreePlayer.MasterPlayer"/> to the animation node <c>id</c>. Recalculates caches.</para>
/// </summary>
[GodotMethod("animation_node_set_master_animation")]
public void AnimationNodeSetMasterAnimation(string id, string source)
@@ -251,7 +252,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_node_get_master_animation");
/// <summary>
- /// Returns the name of the [member master_player]'s [Animation] bound to this animation node.
+ /// <para>Returns the name of the <see cref="Godot.AnimationTreePlayer.MasterPlayer"/>'s <see cref="Godot.Animation"/> bound to this animation node.</para>
/// </summary>
[GodotMethod("animation_node_get_master_animation")]
public string AnimationNodeGetMasterAnimation(string id)
@@ -275,7 +276,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "animation_node_set_filter_path");
/// <summary>
- /// If [code]enable[/code] is [code]true[/code], the animation node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate.
+ /// <para>If <c>enable</c> is <c>true</c>, the animation node with ID <c>id</c> turns off the track modifying the property at <c>path</c>. The modified node's children continue to animate.</para>
/// </summary>
[GodotMethod("animation_node_set_filter_path")]
public void AnimationNodeSetFilterPath(string id, NodePath path, bool enable)
@@ -287,7 +288,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_set_fadein_time");
/// <summary>
- /// Sets fade in time of a OneShot node given its name and value in seconds.
+ /// <para>Sets fade in time of a OneShot node given its name and value in seconds.</para>
/// </summary>
[GodotMethod("oneshot_node_set_fadein_time")]
public void OneshotNodeSetFadeinTime(string id, float timeSec)
@@ -299,7 +300,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_get_fadein_time");
/// <summary>
- /// Returns fade in time of a OneShot node given its name.
+ /// <para>Returns fade in time of a OneShot node given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_get_fadein_time")]
public float OneshotNodeGetFadeinTime(string id)
@@ -311,7 +312,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_set_fadeout_time");
/// <summary>
- /// Sets fade out time of a OneShot node given its name and value in seconds.
+ /// <para>Sets fade out time of a OneShot node given its name and value in seconds.</para>
/// </summary>
[GodotMethod("oneshot_node_set_fadeout_time")]
public void OneshotNodeSetFadeoutTime(string id, float timeSec)
@@ -323,7 +324,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_get_fadeout_time");
/// <summary>
- /// Returns fade out time of a OneShot node given its name.
+ /// <para>Returns fade out time of a OneShot node given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_get_fadeout_time")]
public float OneshotNodeGetFadeoutTime(string id)
@@ -335,7 +336,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_set_autorestart");
/// <summary>
- /// Sets autorestart property of a OneShot node given its name and value.
+ /// <para>Sets autorestart property of a OneShot node given its name and value.</para>
/// </summary>
[GodotMethod("oneshot_node_set_autorestart")]
public void OneshotNodeSetAutorestart(string id, bool enable)
@@ -347,7 +348,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_set_autorestart_delay");
/// <summary>
- /// Sets autorestart delay of a OneShot node given its name and value in seconds.
+ /// <para>Sets autorestart delay of a OneShot node given its name and value in seconds.</para>
/// </summary>
[GodotMethod("oneshot_node_set_autorestart_delay")]
public void OneshotNodeSetAutorestartDelay(string id, float delaySec)
@@ -359,7 +360,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_set_autorestart_random_delay");
/// <summary>
- /// Sets autorestart random delay of a OneShot node given its name and value in seconds.
+ /// <para>Sets autorestart random delay of a OneShot node given its name and value in seconds.</para>
/// </summary>
[GodotMethod("oneshot_node_set_autorestart_random_delay")]
public void OneshotNodeSetAutorestartRandomDelay(string id, float randSec)
@@ -371,7 +372,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_has_autorestart");
/// <summary>
- /// Returns whether a OneShot node will auto restart given its name.
+ /// <para>Returns whether a OneShot node will auto restart given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_has_autorestart")]
public bool OneshotNodeHasAutorestart(string id)
@@ -383,7 +384,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_get_autorestart_delay");
/// <summary>
- /// Returns autostart delay of a OneShot node given its name.
+ /// <para>Returns autostart delay of a OneShot node given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_get_autorestart_delay")]
public float OneshotNodeGetAutorestartDelay(string id)
@@ -395,7 +396,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_get_autorestart_random_delay");
/// <summary>
- /// Returns autostart random delay of a OneShot node given its name.
+ /// <para>Returns autostart random delay of a OneShot node given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_get_autorestart_random_delay")]
public float OneshotNodeGetAutorestartRandomDelay(string id)
@@ -407,7 +408,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_start");
/// <summary>
- /// Starts a OneShot node given its name.
+ /// <para>Starts a OneShot node given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_start")]
public void OneshotNodeStart(string id)
@@ -419,7 +420,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_stop");
/// <summary>
- /// Stops the OneShot node with name [code]id[/code].
+ /// <para>Stops the OneShot node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("oneshot_node_stop")]
public void OneshotNodeStop(string id)
@@ -431,7 +432,7 @@
private static IntPtr method_bind_24 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_is_active");
/// <summary>
- /// Returns whether a OneShot node is active given its name.
+ /// <para>Returns whether a OneShot node is active given its name.</para>
/// </summary>
[GodotMethod("oneshot_node_is_active")]
public bool OneshotNodeIsActive(string id)
@@ -443,7 +444,7 @@
private static IntPtr method_bind_25 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "oneshot_node_set_filter_path");
/// <summary>
- /// If [code]enable[/code] is [code]true[/code], the oneshot node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate.
+ /// <para>If <c>enable</c> is <c>true</c>, the oneshot node with ID <c>id</c> turns off the track modifying the property at <c>path</c>. The modified node's children continue to animate.</para>
/// </summary>
[GodotMethod("oneshot_node_set_filter_path")]
public void OneshotNodeSetFilterPath(string id, NodePath path, bool enable)
@@ -455,8 +456,8 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "mix_node_set_amount");
/// <summary>
- /// Sets mix amount of a Mix node given its name and value.
- /// A Mix node adds input b to input a by a the amount given by ratio.
+ /// <para>Sets mix amount of a Mix node given its name and value.</para>
+ /// <para>A Mix node adds input b to input a by a the amount given by ratio.</para>
/// </summary>
[GodotMethod("mix_node_set_amount")]
public void MixNodeSetAmount(string id, float ratio)
@@ -468,7 +469,7 @@
private static IntPtr method_bind_27 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "mix_node_get_amount");
/// <summary>
- /// Returns mix amount of a Mix node given its name.
+ /// <para>Returns mix amount of a Mix node given its name.</para>
/// </summary>
[GodotMethod("mix_node_get_amount")]
public float MixNodeGetAmount(string id)
@@ -480,11 +481,11 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend2_node_set_amount");
/// <summary>
- /// Sets the blend amount of a Blend2 node given its name and value.
- /// A Blend2 Node blends two animations with the amount between 0 and 1.
- /// At 0, Output is input a.
- /// Towards 1, the influence of a gets lessened, the influence of b gets raised.
- /// At 1, Output is input b.
+ /// <para>Sets the blend amount of a Blend2 node given its name and value.</para>
+ /// <para>A Blend2 Node blends two animations with the amount between 0 and 1.</para>
+ /// <para>At 0, Output is input a.</para>
+ /// <para>Towards 1, the influence of a gets lessened, the influence of b gets raised.</para>
+ /// <para>At 1, Output is input b.</para>
/// </summary>
[GodotMethod("blend2_node_set_amount")]
public void Blend2NodeSetAmount(string id, float blend)
@@ -496,7 +497,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend2_node_get_amount");
/// <summary>
- /// Returns the blend amount of a Blend2 node given its name.
+ /// <para>Returns the blend amount of a Blend2 node given its name.</para>
/// </summary>
[GodotMethod("blend2_node_get_amount")]
public float Blend2NodeGetAmount(string id)
@@ -508,7 +509,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend2_node_set_filter_path");
/// <summary>
- /// If [code]enable[/code] is [code]true[/code], the blend2 node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate.
+ /// <para>If <c>enable</c> is <c>true</c>, the blend2 node with ID <c>id</c> turns off the track modifying the property at <c>path</c>. The modified node's children continue to animate.</para>
/// </summary>
[GodotMethod("blend2_node_set_filter_path")]
public void Blend2NodeSetFilterPath(string id, NodePath path, bool enable)
@@ -520,13 +521,13 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend3_node_set_amount");
/// <summary>
- /// Sets the blend amount of a Blend3 node given its name and value.
- /// A Blend3 Node blends three animations with the amount between -1 and 1.
- /// At -1, Output is input b-.
- /// From -1 to 0, the influence of b- gets lessened, the influence of a gets raised and the influence of b+ is 0.
- /// At 0, Output is input a.
- /// From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised and the influence of b+ is 0.
- /// At 1, Output is input b+.
+ /// <para>Sets the blend amount of a Blend3 node given its name and value.</para>
+ /// <para>A Blend3 Node blends three animations with the amount between -1 and 1.</para>
+ /// <para>At -1, Output is input b-.</para>
+ /// <para>From -1 to 0, the influence of b- gets lessened, the influence of a gets raised and the influence of b+ is 0.</para>
+ /// <para>At 0, Output is input a.</para>
+ /// <para>From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised and the influence of b+ is 0.</para>
+ /// <para>At 1, Output is input b+.</para>
/// </summary>
[GodotMethod("blend3_node_set_amount")]
public void Blend3NodeSetAmount(string id, float blend)
@@ -538,7 +539,7 @@
private static IntPtr method_bind_32 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend3_node_get_amount");
/// <summary>
- /// Returns the blend amount of a Blend3 node given its name.
+ /// <para>Returns the blend amount of a Blend3 node given its name.</para>
/// </summary>
[GodotMethod("blend3_node_get_amount")]
public float Blend3NodeGetAmount(string id)
@@ -550,9 +551,9 @@
private static IntPtr method_bind_33 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend4_node_set_amount");
/// <summary>
- /// Sets the blend amount of a Blend4 node given its name and value.
- /// A Blend4 Node blends two pairs of animations.
- /// The two pairs are blended like blend2 and then added together.
+ /// <para>Sets the blend amount of a Blend4 node given its name and value.</para>
+ /// <para>A Blend4 Node blends two pairs of animations.</para>
+ /// <para>The two pairs are blended like blend2 and then added together.</para>
/// </summary>
[GodotMethod("blend4_node_set_amount")]
public void Blend4NodeSetAmount(string id, Vector2 blend)
@@ -564,7 +565,7 @@
private static IntPtr method_bind_34 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "blend4_node_get_amount");
/// <summary>
- /// Returns the blend amount of a Blend4 node given its name.
+ /// <para>Returns the blend amount of a Blend4 node given its name.</para>
/// </summary>
[GodotMethod("blend4_node_get_amount")]
public Vector2 Blend4NodeGetAmount(string id)
@@ -576,9 +577,9 @@
private static IntPtr method_bind_35 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "timescale_node_set_scale");
/// <summary>
- /// Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code].
- /// The timescale node is used to speed [Animation]s up if the scale is above 1 or slow them down if it is below 1.
- /// If applied after a blend or mix, affects all input animations to that blend or mix.
+ /// <para>Sets the time scale of the TimeScale node with name <c>id</c> to <c>scale</c>.</para>
+ /// <para>The timescale node is used to speed <see cref="Godot.Animation"/>s up if the scale is above 1 or slow them down if it is below 1.</para>
+ /// <para>If applied after a blend or mix, affects all input animations to that blend or mix.</para>
/// </summary>
[GodotMethod("timescale_node_set_scale")]
public void TimescaleNodeSetScale(string id, float scale)
@@ -590,7 +591,7 @@
private static IntPtr method_bind_36 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "timescale_node_get_scale");
/// <summary>
- /// Returns time scale value of the TimeScale node with name [code]id[/code].
+ /// <para>Returns time scale value of the TimeScale node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("timescale_node_get_scale")]
public float TimescaleNodeGetScale(string id)
@@ -602,8 +603,8 @@
private static IntPtr method_bind_37 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "timeseek_node_seek");
/// <summary>
- /// Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code]
- /// This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it.
+ /// <para>Sets the time seek value of the TimeSeek node with name <c>id</c> to <c>seconds</c></para>
+ /// <para>This functions as a seek in the <see cref="Godot.Animation"/> or the blend or mix of <see cref="Godot.Animation"/>s input in it.</para>
/// </summary>
[GodotMethod("timeseek_node_seek")]
public void TimeseekNodeSeek(string id, float seconds)
@@ -615,7 +616,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_set_input_count");
/// <summary>
- /// Resizes the number of inputs available for the transition node with name [code]id[/code].
+ /// <para>Resizes the number of inputs available for the transition node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("transition_node_set_input_count")]
public void TransitionNodeSetInputCount(string id, int count)
@@ -627,7 +628,7 @@
private static IntPtr method_bind_39 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_get_input_count");
/// <summary>
- /// Returns the number of inputs for the transition node with name [code]id[/code]. You can add inputs by rightclicking on the transition node.
+ /// <para>Returns the number of inputs for the transition node with name <c>id</c>. You can add inputs by rightclicking on the transition node.</para>
/// </summary>
[GodotMethod("transition_node_get_input_count")]
public int TransitionNodeGetInputCount(string id)
@@ -639,7 +640,7 @@
private static IntPtr method_bind_40 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_delete_input");
/// <summary>
- /// Deletes the input at [code]input_idx[/code] for the transition node with name [code]id[/code].
+ /// <para>Deletes the input at <c>input_idx</c> for the transition node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("transition_node_delete_input")]
public void TransitionNodeDeleteInput(string id, int inputIdx)
@@ -651,7 +652,7 @@
private static IntPtr method_bind_41 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_set_input_auto_advance");
/// <summary>
- /// The transition node with name [code]id[/code] advances to its next input automatically when the input at [code]input_idx[/code] completes.
+ /// <para>The transition node with name <c>id</c> advances to its next input automatically when the input at <c>input_idx</c> completes.</para>
/// </summary>
[GodotMethod("transition_node_set_input_auto_advance")]
public void TransitionNodeSetInputAutoAdvance(string id, int inputIdx, bool enable)
@@ -663,7 +664,7 @@
private static IntPtr method_bind_42 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_has_input_auto_advance");
/// <summary>
- /// Returns [code]true[/code] if the input at [code]input_idx[/code] on transition node with name [code]id[/code] is set to automatically advance to the next input upon completion.
+ /// <para>Returns <c>true</c> if the input at <c>input_idx</c> on transition node with name <c>id</c> is set to automatically advance to the next input upon completion.</para>
/// </summary>
[GodotMethod("transition_node_has_input_auto_advance")]
public bool TransitionNodeHasInputAutoAdvance(string id, int inputIdx)
@@ -675,7 +676,7 @@
private static IntPtr method_bind_43 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_set_xfade_time");
/// <summary>
- /// The transition node with name [code]id[/code] sets its cross fade time to [code]time_sec[/code].
+ /// <para>The transition node with name <c>id</c> sets its cross fade time to <c>time_sec</c>.</para>
/// </summary>
[GodotMethod("transition_node_set_xfade_time")]
public void TransitionNodeSetXfadeTime(string id, float timeSec)
@@ -687,7 +688,7 @@
private static IntPtr method_bind_44 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_get_xfade_time");
/// <summary>
- /// Returns the cross fade time for the transition node with name [code]id[/code].
+ /// <para>Returns the cross fade time for the transition node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("transition_node_get_xfade_time")]
public float TransitionNodeGetXfadeTime(string id)
@@ -699,7 +700,7 @@
private static IntPtr method_bind_45 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_set_current");
/// <summary>
- /// The transition node with name [code]id[/code] sets its current input at [code]input_idx[/code].
+ /// <para>The transition node with name <c>id</c> sets its current input at <c>input_idx</c>.</para>
/// </summary>
[GodotMethod("transition_node_set_current")]
public void TransitionNodeSetCurrent(string id, int inputIdx)
@@ -711,7 +712,7 @@
private static IntPtr method_bind_46 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "transition_node_get_current");
/// <summary>
- /// Returns the index of the currently evaluated input for the transition node with name [code]id[/code].
+ /// <para>Returns the index of the currently evaluated input for the transition node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("transition_node_get_current")]
public int TransitionNodeGetCurrent(string id)
@@ -723,7 +724,7 @@
private static IntPtr method_bind_47 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_set_position");
/// <summary>
- /// Sets position of a node in the graph given its name and position.
+ /// <para>Sets position of a node in the graph given its name and position.</para>
/// </summary>
[GodotMethod("node_set_position")]
public void NodeSetPosition(string id, Vector2 screenPosition)
@@ -735,7 +736,7 @@
private static IntPtr method_bind_48 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "node_get_position");
/// <summary>
- /// Returns position of a node in the graph given its name.
+ /// <para>Returns position of a node in the graph given its name.</para>
/// </summary>
[GodotMethod("node_get_position")]
public Vector2 NodeGetPosition(string id)
@@ -747,7 +748,7 @@
private static IntPtr method_bind_49 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_node");
/// <summary>
- /// Removes the animation node with name [code]id[/code].
+ /// <para>Removes the animation node with name <c>id</c>.</para>
/// </summary>
[GodotMethod("remove_node")]
public void RemoveNode(string id)
@@ -759,7 +760,7 @@
private static IntPtr method_bind_50 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "connect_nodes");
/// <summary>
- /// Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot.
+ /// <para>Connects node <c>id</c> to <c>dst_id</c> at the specified input slot.</para>
/// </summary>
[GodotMethod("connect_nodes")]
public Error ConnectNodes(string id, string dstId, int dstInputIdx)
@@ -771,7 +772,7 @@
private static IntPtr method_bind_51 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "are_nodes_connected");
/// <summary>
- /// Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot.
+ /// <para>Returns whether node <c>id</c> and <c>dst_id</c> are connected at the specified slot.</para>
/// </summary>
[GodotMethod("are_nodes_connected")]
public bool AreNodesConnected(string id, string dstId, int dstInputIdx)
@@ -783,7 +784,7 @@
private static IntPtr method_bind_52 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "disconnect_nodes");
/// <summary>
- /// Disconnects nodes connected to [code]id[/code] at the specified input slot.
+ /// <para>Disconnects nodes connected to <c>id</c> at the specified input slot.</para>
/// </summary>
[GodotMethod("disconnect_nodes")]
public void DisconnectNodes(string id, int dstInputIdx)
@@ -849,7 +850,7 @@
private static IntPtr method_bind_59 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_node_list");
/// <summary>
- /// Returns a [PoolStringArray] containing the name of all nodes.
+ /// <para>Returns a <see cref="string"/> containing the name of all nodes.</para>
/// </summary>
[GodotMethod("get_node_list")]
public string[] GetNodeList()
@@ -879,7 +880,7 @@
private static IntPtr method_bind_62 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "advance");
/// <summary>
- /// Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
+ /// <para>Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and <c>delta</c> are handled.</para>
/// </summary>
[GodotMethod("advance")]
public void Advance(float delta)
@@ -891,7 +892,7 @@
private static IntPtr method_bind_63 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "reset");
/// <summary>
- /// Resets this [code]AnimationTreePlayer[/code].
+ /// <para>Resets this <c>AnimationTreePlayer</c>.</para>
/// </summary>
[GodotMethod("reset")]
public void Reset()
@@ -903,7 +904,7 @@
private static IntPtr method_bind_64 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "recompute_caches");
/// <summary>
- /// Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state.
+ /// <para>Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state.</para>
/// </summary>
[GodotMethod("recompute_caches")]
public void RecomputeCaches()
@@ -914,3 +915,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Area.cs GodotSharp_after/GodotSharp/ObjectType/Area.cs
--- GodotSharp_before/GodotSharp/ObjectType/Area.cs 2019-03-20 21:16:54.457253000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Area.cs 2019-03-23 19:57:07.747128600 +0100
@@ -2,40 +2,41 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// 3D area that detects [CollisionObject] nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).
+ /// <para>3D area that detects <see cref="Godot.CollisionObject"/> nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).</para>
/// </summary>
public partial class Area : CollisionObject
{
public enum SpaceOverrideEnum
{
/// <summary>
- /// This area does not affect gravity/damping.
+ /// <para>This area does not affect gravity/damping.</para>
/// </summary>
Disabled = 0,
/// <summary>
- /// This area adds its gravity/damping values to whatever has been calculated so far (in [member priority] order).
+ /// <para>This area adds its gravity/damping values to whatever has been calculated so far (in <see cref="Godot.Area.Priority"/> order).</para>
/// </summary>
Combine = 1,
/// <summary>
- /// This area adds its gravity/damping values to whatever has been calculated so far (in [member priority] order), ignoring any lower priority areas.
+ /// <para>This area adds its gravity/damping values to whatever has been calculated so far (in <see cref="Godot.Area.Priority"/> order), ignoring any lower priority areas.</para>
/// </summary>
CombineReplace = 2,
/// <summary>
- /// This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
+ /// <para>This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.</para>
/// </summary>
Replace = 3,
/// <summary>
- /// This area replaces any gravity/damping calculated so far (in [member priority] order), but keeps calculating the rest of the areas.
+ /// <para>This area replaces any gravity/damping calculated so far (in <see cref="Godot.Area.Priority"/> order), but keeps calculating the rest of the areas.</para>
/// </summary>
ReplaceCombine = 4
}
/// <summary>
- /// Override mode for gravity and damping calculations within this area. See [enum Area.SpaceOverride] for possible values.
+ /// <para>Override mode for gravity and damping calculations within this area. See <see cref="Godot.Area.SpaceOverrideEnum"/> for possible values.</para>
/// </summary>
public Area.SpaceOverrideEnum SpaceOverride
{
@@ -50,7 +51,7 @@
}
/// <summary>
- /// If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). Also see [member space_override]. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, gravity is calculated from a point (set via <see cref="Godot.Area.GravityVec"/>). Also see <see cref="Godot.Area.SpaceOverride"/>. Default value: <c>false</c>.</para>
/// </summary>
public bool GravityPoint
{
@@ -65,7 +66,7 @@
}
/// <summary>
- /// The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
+ /// <para>The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.</para>
/// </summary>
public float GravityDistanceScale
{
@@ -80,7 +81,7 @@
}
/// <summary>
- /// The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction.
+ /// <para>The area's gravity vector (not normalized). If gravity is a point (see <see cref="Godot.Area.GravityPoint"/>), this will be the point of attraction.</para>
/// </summary>
public Vector3 GravityVec
{
@@ -95,7 +96,7 @@
}
/// <summary>
- /// The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
+ /// <para>The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.</para>
/// </summary>
public float Gravity
{
@@ -110,7 +111,7 @@
}
/// <summary>
- /// The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).
+ /// <para>The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from <c>0</c> (no damping) to <c>1</c> (full damping).</para>
/// </summary>
public float LinearDamp
{
@@ -125,7 +126,7 @@
}
/// <summary>
- /// The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).
+ /// <para>The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from <c>0</c> (no damping) to <c>1</c> (full damping).</para>
/// </summary>
public float AngularDamp
{
@@ -140,7 +141,7 @@
}
/// <summary>
- /// The area's priority. Higher priority areas are processed first. Default value: 0.
+ /// <para>The area's priority. Higher priority areas are processed first. Default value: 0.</para>
/// </summary>
public float Priority
{
@@ -155,7 +156,7 @@
}
/// <summary>
- /// If [code]true[/code], the area detects bodies or areas entering and exiting it. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the area detects bodies or areas entering and exiting it. Default value: <c>true</c>.</para>
/// </summary>
public bool Monitoring
{
@@ -170,7 +171,7 @@
}
/// <summary>
- /// If [code]true[/code], other monitoring areas can detect this area. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, other monitoring areas can detect this area. Default value: <c>true</c>.</para>
/// </summary>
public bool Monitorable
{
@@ -185,7 +186,7 @@
}
/// <summary>
- /// The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask].
+ /// <para>The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also <see cref="Godot.Area.CollisionMask"/>.</para>
/// </summary>
public int CollisionLayer
{
@@ -200,7 +201,7 @@
}
/// <summary>
- /// The physics layers this area scans to determine collision detection.
+ /// <para>The physics layers this area scans to determine collision detection.</para>
/// </summary>
public int CollisionMask
{
@@ -215,7 +216,7 @@
}
/// <summary>
- /// If [code]true[/code], the area's audio bus overrides the default audio bus. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the area's audio bus overrides the default audio bus. Default value: <c>false</c>.</para>
/// </summary>
public bool AudioBusOverride
{
@@ -230,7 +231,7 @@
}
/// <summary>
- /// The name of the area's audio bus.
+ /// <para>The name of the area's audio bus.</para>
/// </summary>
public string AudioBusName
{
@@ -245,7 +246,7 @@
}
/// <summary>
- /// If [code]true[/code], the area applies reverb to its associated audio.
+ /// <para>If <c>true</c>, the area applies reverb to its associated audio.</para>
/// </summary>
public bool ReverbBusEnable
{
@@ -260,7 +261,7 @@
}
/// <summary>
- /// The reverb bus name to use for this area's associated audio.
+ /// <para>The reverb bus name to use for this area's associated audio.</para>
/// </summary>
public string ReverbBusName
{
@@ -275,7 +276,7 @@
}
/// <summary>
- /// The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.
+ /// <para>The degree to which this area applies reverb to its associated audio. Ranges from <c>0</c> to <c>1</c> with <c>0.1</c> precision.</para>
/// </summary>
public float ReverbBusAmount
{
@@ -290,7 +291,7 @@
}
/// <summary>
- /// The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.
+ /// <para>The degree to which this area's reverb is a uniform effect. Ranges from <c>0</c> to <c>1</c> with <c>0.1</c> precision.</para>
/// </summary>
public float ReverbBusUniformity
{
@@ -498,7 +499,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_collision_mask_bit");
/// <summary>
- /// Set/clear individual bits on the collision mask. This simplifies editing which [code]Area[/code] layers this [code]Area[/code] scans.
+ /// <para>Set/clear individual bits on the collision mask. This simplifies editing which <c>Area</c> layers this <c>Area</c> scans.</para>
/// </summary>
[GodotMethod("set_collision_mask_bit")]
public void SetCollisionMaskBit(int bit, bool value)
@@ -510,7 +511,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_collision_mask_bit");
/// <summary>
- /// Returns an individual bit on the collision mask.
+ /// <para>Returns an individual bit on the collision mask.</para>
/// </summary>
[GodotMethod("get_collision_mask_bit")]
public bool GetCollisionMaskBit(int bit)
@@ -522,7 +523,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_collision_layer_bit");
/// <summary>
- /// Set/clear individual bits on the layer mask. This simplifies editing this [code]Area[/code]'s layers.
+ /// <para>Set/clear individual bits on the layer mask. This simplifies editing this <c>Area</c>'s layers.</para>
/// </summary>
[GodotMethod("set_collision_layer_bit")]
public void SetCollisionLayerBit(int bit, bool value)
@@ -534,7 +535,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_collision_layer_bit");
/// <summary>
- /// Returns an individual bit on the layer mask.
+ /// <para>Returns an individual bit on the layer mask.</para>
/// </summary>
[GodotMethod("get_collision_layer_bit")]
public bool GetCollisionLayerBit(int bit)
@@ -582,7 +583,7 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_overlapping_bodies");
/// <summary>
- /// Returns a list of intersecting [PhysicsBody]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+ /// <para>Returns a list of intersecting <see cref="Godot.PhysicsBody"/>s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.</para>
/// </summary>
[GodotMethod("get_overlapping_bodies")]
public Godot.Collections.Array GetOverlappingBodies()
@@ -594,7 +595,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_overlapping_areas");
/// <summary>
- /// Returns a list of intersecting [code]Area[/code]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+ /// <para>Returns a list of intersecting <c>Area</c>s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.</para>
/// </summary>
[GodotMethod("get_overlapping_areas")]
public Godot.Collections.Array GetOverlappingAreas()
@@ -606,7 +607,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "overlaps_body");
/// <summary>
- /// If [code]true[/code], the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+ /// <para>If <c>true</c>, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.</para>
/// </summary>
[GodotMethod("overlaps_body")]
public bool OverlapsBody(Node body)
@@ -618,7 +619,7 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "overlaps_area");
/// <summary>
- /// If [code]true[/code], the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+ /// <para>If <c>true</c>, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.</para>
/// </summary>
[GodotMethod("overlaps_area")]
public bool OverlapsArea(Node area)
@@ -737,3 +738,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Area2D.cs GodotSharp_after/GodotSharp/ObjectType/Area2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/Area2D.cs 2019-03-20 21:16:54.465249800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Area2D.cs 2019-03-23 19:57:07.755125900 +0100
@@ -2,40 +2,41 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// 2D area that detects [CollisionObject2D] nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).
+ /// <para>2D area that detects <see cref="Godot.CollisionObject2D"/> nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping).</para>
/// </summary>
public partial class Area2D : CollisionObject2D
{
public enum SpaceOverrideEnum
{
/// <summary>
- /// This area does not affect gravity/damping.
+ /// <para>This area does not affect gravity/damping.</para>
/// </summary>
Disabled = 0,
/// <summary>
- /// This area adds its gravity/damping values to whatever has been calculated so far (in [member priority] order).
+ /// <para>This area adds its gravity/damping values to whatever has been calculated so far (in <see cref="Godot.Area2D.Priority"/> order).</para>
/// </summary>
Combine = 1,
/// <summary>
- /// This area adds its gravity/damping values to whatever has been calculated so far (in [member priority] order), ignoring any lower priority areas.
+ /// <para>This area adds its gravity/damping values to whatever has been calculated so far (in <see cref="Godot.Area2D.Priority"/> order), ignoring any lower priority areas.</para>
/// </summary>
CombineReplace = 2,
/// <summary>
- /// This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
+ /// <para>This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.</para>
/// </summary>
Replace = 3,
/// <summary>
- /// This area replaces any gravity/damping calculated so far (in [member priority] order), but keeps calculating the rest of the areas.
+ /// <para>This area replaces any gravity/damping calculated so far (in <see cref="Godot.Area2D.Priority"/> order), but keeps calculating the rest of the areas.</para>
/// </summary>
ReplaceCombine = 4
}
/// <summary>
- /// Override mode for gravity and damping calculations within this area. See [enum Area2D.SpaceOverride] for possible values.
+ /// <para>Override mode for gravity and damping calculations within this area. See <see cref="Godot.Area2D.SpaceOverrideEnum"/> for possible values.</para>
/// </summary>
public Area2D.SpaceOverrideEnum SpaceOverride
{
@@ -50,7 +51,7 @@
}
/// <summary>
- /// If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). Also see [member space_override]. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, gravity is calculated from a point (set via <see cref="Godot.Area2D.GravityVec"/>). Also see <see cref="Godot.Area2D.SpaceOverride"/>. Default value: <c>false</c>.</para>
/// </summary>
public bool GravityPoint
{
@@ -65,7 +66,7 @@
}
/// <summary>
- /// The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
+ /// <para>The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.</para>
/// </summary>
public float GravityDistanceScale
{
@@ -80,7 +81,7 @@
}
/// <summary>
- /// The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction.
+ /// <para>The area's gravity vector (not normalized). If gravity is a point (see <see cref="Godot.Area2D.GravityPoint"/>), this will be the point of attraction.</para>
/// </summary>
public Vector2 GravityVec
{
@@ -95,7 +96,7 @@
}
/// <summary>
- /// The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
+ /// <para>The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.</para>
/// </summary>
public float Gravity
{
@@ -110,7 +111,7 @@
}
/// <summary>
- /// The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).
+ /// <para>The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from <c>0</c> (no damping) to <c>1</c> (full damping).</para>
/// </summary>
public float LinearDamp
{
@@ -125,7 +126,7 @@
}
/// <summary>
- /// The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).
+ /// <para>The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from <c>0</c> (no damping) to <c>1</c> (full damping).</para>
/// </summary>
public float AngularDamp
{
@@ -140,7 +141,7 @@
}
/// <summary>
- /// The area's priority. Higher priority areas are processed first. Default value: 0.
+ /// <para>The area's priority. Higher priority areas are processed first. Default value: 0.</para>
/// </summary>
public float Priority
{
@@ -155,7 +156,7 @@
}
/// <summary>
- /// If [code]true[/code], the area detects bodies or areas entering and exiting it. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the area detects bodies or areas entering and exiting it. Default value: <c>true</c>.</para>
/// </summary>
public bool Monitoring
{
@@ -170,7 +171,7 @@
}
/// <summary>
- /// If [code]true[/code], other monitoring areas can detect this area. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, other monitoring areas can detect this area. Default value: <c>true</c>.</para>
/// </summary>
public bool Monitorable
{
@@ -185,7 +186,7 @@
}
/// <summary>
- /// The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask].
+ /// <para>The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also <see cref="Godot.Area2D.CollisionMask"/>.</para>
/// </summary>
public int CollisionLayer
{
@@ -200,7 +201,7 @@
}
/// <summary>
- /// The physics layers this area scans to determine collision detection.
+ /// <para>The physics layers this area scans to determine collision detection.</para>
/// </summary>
public int CollisionMask
{
@@ -215,7 +216,7 @@
}
/// <summary>
- /// If [code]true[/code], the area's audio bus overrides the default audio bus. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the area's audio bus overrides the default audio bus. Default value: <c>false</c>.</para>
/// </summary>
public bool AudioBusOverride
{
@@ -230,7 +231,7 @@
}
/// <summary>
- /// The name of the area's audio bus.
+ /// <para>The name of the area's audio bus.</para>
/// </summary>
public string AudioBusName
{
@@ -438,7 +439,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_collision_mask_bit");
/// <summary>
- /// Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
+ /// <para>Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.</para>
/// </summary>
[GodotMethod("set_collision_mask_bit")]
public void SetCollisionMaskBit(int bit, bool value)
@@ -450,7 +451,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_collision_mask_bit");
/// <summary>
- /// Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.
+ /// <para>Return an individual bit on the collision mask. Describes whether this area will collide with others on the given layer.</para>
/// </summary>
[GodotMethod("get_collision_mask_bit")]
public bool GetCollisionMaskBit(int bit)
@@ -462,7 +463,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_collision_layer_bit");
/// <summary>
- /// Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
+ /// <para>Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.</para>
/// </summary>
[GodotMethod("set_collision_layer_bit")]
public void SetCollisionLayerBit(int bit, bool value)
@@ -474,7 +475,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_collision_layer_bit");
/// <summary>
- /// Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.
+ /// <para>Return an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer.</para>
/// </summary>
[GodotMethod("get_collision_layer_bit")]
public bool GetCollisionLayerBit(int bit)
@@ -522,7 +523,7 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_overlapping_bodies");
/// <summary>
- /// Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+ /// <para>Returns a list of intersecting <see cref="Godot.PhysicsBody2D"/>s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.</para>
/// </summary>
[GodotMethod("get_overlapping_bodies")]
public Godot.Collections.Array GetOverlappingBodies()
@@ -534,7 +535,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_overlapping_areas");
/// <summary>
- /// Returns a list of intersecting [code]Area2D[/code]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+ /// <para>Returns a list of intersecting <c>Area2D</c>s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.</para>
/// </summary>
[GodotMethod("get_overlapping_areas")]
public Godot.Collections.Array GetOverlappingAreas()
@@ -546,7 +547,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "overlaps_body");
/// <summary>
- /// If [code]true[/code], the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+ /// <para>If <c>true</c>, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.</para>
/// </summary>
[GodotMethod("overlaps_body")]
public bool OverlapsBody(Node body)
@@ -558,7 +559,7 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "overlaps_area");
/// <summary>
- /// If [code]true[/code], the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+ /// <para>If <c>true</c>, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.</para>
/// </summary>
[GodotMethod("overlaps_area")]
public bool OverlapsArea(Node area)
@@ -605,3 +606,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ArrayMesh.cs GodotSharp_after/GodotSharp/ObjectType/ArrayMesh.cs
--- GodotSharp_before/GodotSharp/ObjectType/ArrayMesh.cs 2019-03-20 21:16:54.472248300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ArrayMesh.cs 2019-03-23 19:57:07.762123600 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// The [code]ArrayMesh[/code] is used to construct a [Mesh] by specifying the attributes as arrays. The most basic example is the creation of a single triangle
- /// [codeblock]
+ /// <para>The <c>ArrayMesh</c> is used to construct a <see cref="Godot.Mesh"/> by specifying the attributes as arrays. The most basic example is the creation of a single triangle</para>
+ /// <para><code>
/// var vertices = PoolVector3Array()
/// vertices.push_back(Vector3(0, 1, 0))
/// vertices.push_back(Vector3(1, 0, 0))
@@ -21,56 +22,56 @@
/// arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arrays)
/// var m = MeshInstance.new()
/// m.mesh = arr_mesh
- /// [/codeblock]
- /// The [code]MeshInstance[/code] is ready to be added to the SceneTree to be shown.
+ /// </code></para>
+ /// <para>The <c>MeshInstance</c> is ready to be added to the SceneTree to be shown.</para>
/// </summary>
public partial class ArrayMesh : Mesh
{
/// <summary>
- /// Default value used for index_array_len when no indices are present.
+ /// <para>Default value used for index_array_len when no indices are present.</para>
/// </summary>
public const int NoIndexArray = -1;
/// <summary>
- /// Amount of weights/bone indices per vertex (always 4).
+ /// <para>Amount of weights/bone indices per vertex (always 4).</para>
/// </summary>
public const int ArrayWeightsSize = 4;
public enum ArrayFormat
{
/// <summary>
- /// Array format will include vertices (mandatory).
+ /// <para>Array format will include vertices (mandatory).</para>
/// </summary>
Vertex = 1,
/// <summary>
- /// Array format will include normals
+ /// <para>Array format will include normals</para>
/// </summary>
Normal = 2,
/// <summary>
- /// Array format will include tangents
+ /// <para>Array format will include tangents</para>
/// </summary>
Tangent = 4,
/// <summary>
- /// Array format will include a color array.
+ /// <para>Array format will include a color array.</para>
/// </summary>
Color = 8,
/// <summary>
- /// Array format will include UVs.
+ /// <para>Array format will include UVs.</para>
/// </summary>
TexUv = 16,
/// <summary>
- /// Array format will include another set of UVs.
+ /// <para>Array format will include another set of UVs.</para>
/// </summary>
TexUv2 = 32,
/// <summary>
- /// Array format will include bone indices.
+ /// <para>Array format will include bone indices.</para>
/// </summary>
Bones = 64,
/// <summary>
- /// Array format will include bone weights.
+ /// <para>Array format will include bone weights.</para>
/// </summary>
Weights = 128,
/// <summary>
- /// Index array will be used.
+ /// <para>Index array will be used.</para>
/// </summary>
Index = 256
}
@@ -78,40 +79,40 @@
public enum ArrayType
{
/// <summary>
- /// Vertex array (array of [Vector3] vertices).
+ /// <para>Vertex array (array of <see cref="Godot.Vector3"/> vertices).</para>
/// </summary>
Vertex = 0,
/// <summary>
- /// Normal array (array of [Vector3] normals).
+ /// <para>Normal array (array of <see cref="Godot.Vector3"/> normals).</para>
/// </summary>
Normal = 1,
/// <summary>
- /// Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
+ /// <para>Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.</para>
/// </summary>
Tangent = 2,
/// <summary>
- /// Vertex array (array of [Color] colors).
+ /// <para>Vertex array (array of <see cref="Godot.Color"/> colors).</para>
/// </summary>
Color = 3,
/// <summary>
- /// UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
+ /// <para>UV array (array of <see cref="Godot.Vector3"/> UVs or float array of groups of 2 floats (u,v)).</para>
/// </summary>
TexUv = 4,
/// <summary>
- /// Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)).
+ /// <para>Second UV array (array of <see cref="Godot.Vector3"/> UVs or float array of groups of 2 floats (u,v)).</para>
/// </summary>
TexUv2 = 5,
/// <summary>
- /// Array of bone indices, as a float array. Each element in groups of 4 floats.
+ /// <para>Array of bone indices, as a float array. Each element in groups of 4 floats.</para>
/// </summary>
Bones = 6,
/// <summary>
- /// Array of bone weights, as a float array. Each element in groups of 4 floats.
+ /// <para>Array of bone weights, as a float array. Each element in groups of 4 floats.</para>
/// </summary>
Weights = 7,
/// <summary>
- /// [Array] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
- /// For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.
+ /// <para><see cref="Godot.Collections.Array"/> of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i*'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.</para>
+ /// <para>For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.</para>
/// </summary>
Index = 8,
/// <summary>
@@ -136,7 +137,7 @@
}
/// <summary>
- /// An overriding bounding box for this mesh.
+ /// <para>An overriding bounding box for this mesh.</para>
/// </summary>
public AABB CustomAabb
{
@@ -176,7 +177,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_blend_shape_count");
/// <summary>
- /// Returns the number of blend shapes that the [code]ArrayMesh[/code] holds.
+ /// <para>Returns the number of blend shapes that the <c>ArrayMesh</c> holds.</para>
/// </summary>
[GodotMethod("get_blend_shape_count")]
public int GetBlendShapeCount()
@@ -188,7 +189,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_blend_shape_name");
/// <summary>
- /// Returns the name of the blend shape at this index.
+ /// <para>Returns the name of the blend shape at this index.</para>
/// </summary>
[GodotMethod("get_blend_shape_name")]
public string GetBlendShapeName(int index)
@@ -200,7 +201,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_blend_shapes");
/// <summary>
- /// Remove all blend shapes from this [code]ArrayMesh[/code].
+ /// <para>Remove all blend shapes from this <c>ArrayMesh</c>.</para>
/// </summary>
[GodotMethod("clear_blend_shapes")]
public void ClearBlendShapes()
@@ -230,12 +231,12 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_surface_from_arrays");
/// <summary>
- /// Creates a new surface.
- /// Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See [Mesh] for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface.
- /// The [code]arrays[/code] argument is an array of arrays. See [enum ArrayType] for the values used in this array. For example, [code]arrays[0][/code] is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for [code]ARRAY_INDEX[/code] if it is used.
- /// Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices.
- /// Godot uses clockwise winding order for front faces of triangle primitive modes.
- /// &lt;param name="blendShapes"&gt;If the param is null, then the default value is new Godot.Collections.Array {}&lt;/param&gt;
+ /// <para>Creates a new surface.</para>
+ /// <para>Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. See <see cref="Godot.Mesh"/> for details. (As a note, when using indices, it is recommended to only use points, lines or triangles). <see cref="Godot.Mesh.GetSurfaceCount"/> will become the <c>surf_idx</c> for this new surface.</para>
+ /// <para>The <c>arrays</c> argument is an array of arrays. See <see cref="Godot.ArrayMesh.ArrayType"/> for the values used in this array. For example, <c>arrays[0]</c> is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array or be empty, except for <c>ARRAY_INDEX</c> if it is used.</para>
+ /// <para>Adding an index array puts this function into "index mode" where the vertex and other arrays become the sources of data, and the index array defines the order of the vertices.</para>
+ /// <para>Godot uses clockwise winding order for front faces of triangle primitive modes.</para>
+ /// <param name="blendShapes">If the parameter is null, then the default value is new Godot.Collections.Array {}</param>
/// </summary>
[GodotMethod("add_surface_from_arrays")]
public void AddSurfaceFromArrays(Mesh.PrimitiveType primitive, Godot.Collections.Array arrays, Godot.Collections.Array blendShapes = null, int compressFlags = 97280)
@@ -248,7 +249,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_remove");
/// <summary>
- /// Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
+ /// <para>Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.</para>
/// </summary>
[GodotMethod("surface_remove")]
public void SurfaceRemove(int surfIdx)
@@ -272,7 +273,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_get_array_len");
/// <summary>
- /// Return the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
+ /// <para>Return the length in vertices of the vertex array in the requested surface (see <see cref="Godot.ArrayMesh.AddSurfaceFromArrays"/>).</para>
/// </summary>
[GodotMethod("surface_get_array_len")]
public int SurfaceGetArrayLen(int surfIdx)
@@ -284,7 +285,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_get_array_index_len");
/// <summary>
- /// Return the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
+ /// <para>Return the length in indices of the index array in the requested surface (see <see cref="Godot.ArrayMesh.AddSurfaceFromArrays"/>).</para>
/// </summary>
[GodotMethod("surface_get_array_index_len")]
public int SurfaceGetArrayIndexLen(int surfIdx)
@@ -296,7 +297,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_get_format");
/// <summary>
- /// Return the format mask of the requested surface (see [method add_surface_from_arrays]).
+ /// <para>Return the format mask of the requested surface (see <see cref="Godot.ArrayMesh.AddSurfaceFromArrays"/>).</para>
/// </summary>
[GodotMethod("surface_get_format")]
public int SurfaceGetFormat(int surfIdx)
@@ -308,7 +309,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_get_primitive_type");
/// <summary>
- /// Return the primitive type of the requested surface (see [method add_surface_from_arrays]).
+ /// <para>Return the primitive type of the requested surface (see <see cref="Godot.ArrayMesh.AddSurfaceFromArrays"/>).</para>
/// </summary>
[GodotMethod("surface_get_primitive_type")]
public Mesh.PrimitiveType SurfaceGetPrimitiveType(int surfIdx)
@@ -320,7 +321,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_set_material");
/// <summary>
- /// Set a [Material] for a given surface. Surface will be rendered using this material.
+ /// <para>Set a <see cref="Godot.Material"/> for a given surface. Surface will be rendered using this material.</para>
/// </summary>
[GodotMethod("surface_set_material")]
public void SurfaceSetMaterial(int surfIdx, Material material)
@@ -332,7 +333,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_find_by_name");
/// <summary>
- /// Return the index of the first surface with this name held within this [code]ArrayMesh[/code]. If none are found -1 is returned.
+ /// <para>Return the index of the first surface with this name held within this <c>ArrayMesh</c>. If none are found -1 is returned.</para>
/// </summary>
[GodotMethod("surface_find_by_name")]
public int SurfaceFindByName(string name)
@@ -344,7 +345,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_set_name");
/// <summary>
- /// Set a name for a given surface.
+ /// <para>Set a name for a given surface.</para>
/// </summary>
[GodotMethod("surface_set_name")]
public void SurfaceSetName(int surfIdx, string name)
@@ -356,7 +357,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "surface_get_name");
/// <summary>
- /// Get the name assigned to this surface.
+ /// <para>Get the name assigned to this surface.</para>
/// </summary>
[GodotMethod("surface_get_name")]
public string SurfaceGetName(int surfIdx)
@@ -368,7 +369,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "regen_normalmaps");
/// <summary>
- /// Will regenerate normal maps for the [code]ArrayMesh[/code].
+ /// <para>Will regenerate normal maps for the <c>ArrayMesh</c>.</para>
/// </summary>
[GodotMethod("regen_normalmaps")]
public void RegenNormalmaps()
@@ -380,7 +381,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "lightmap_unwrap");
/// <summary>
- /// Will perform a UV unwrap on the [code]ArrayMesh[/code] to prepare the mesh for lightmapping.
+ /// <para>Will perform a UV unwrap on the <c>ArrayMesh</c> to prepare the mesh for lightmapping.</para>
/// </summary>
[GodotMethod("lightmap_unwrap")]
public Error LightmapUnwrap(Transform transform, float texelSize)
@@ -409,3 +410,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRAnchor.cs GodotSharp_after/GodotSharp/ObjectType/ARVRAnchor.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRAnchor.cs 2019-03-20 21:16:54.222301200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRAnchor.cs 2019-03-23 19:57:07.546192900 +0100
@@ -2,18 +2,19 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// The ARVR Anchor point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them.
- /// This node is mapped to one of the anchors through its unique id. When you receive a signal that a new anchor is available, you should add this node to your scene for that anchor. You can predefine nodes and set the id and the nodes will simply remain on 0,0,0 until a plane is recognised.
- /// Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view.
+ /// <para>The ARVR Anchor point is a spatial node that maps a real world location identified by the AR platform to a position within the game world. For example, as long as plane detection in ARKit is on, ARKit will identify and update the position of planes (tables, floors, etc) and create anchors for them.</para>
+ /// <para>This node is mapped to one of the anchors through its unique id. When you receive a signal that a new anchor is available, you should add this node to your scene for that anchor. You can predefine nodes and set the id and the nodes will simply remain on 0,0,0 until a plane is recognised.</para>
+ /// <para>Keep in mind that, as long as plane detection is enabled, the size, placing and orientation of an anchor will be updated as the detection logic learns more about the real world out there especially if only part of the surface is in view.</para>
/// </summary>
public partial class ARVRAnchor : Spatial
{
/// <summary>
- /// The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of [code]1[/code], the second an id of [code]2[/code], etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them.
+ /// <para>The anchor's id. You can set this before the anchor itself exists. The first anchor gets an id of <c>1</c>, the second an id of <c>2</c>, etc. When anchors get removed, the engine can then assign the corresponding id to new anchors. The most common situation where anchors 'disappear' is when the AR server identifies that two anchors represent different parts of the same plane and merges them.</para>
/// </summary>
public int AnchorId
{
@@ -59,7 +60,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_anchor_name");
/// <summary>
- /// Returns the name given to this anchor.
+ /// <para>Returns the name given to this anchor.</para>
/// </summary>
[GodotMethod("get_anchor_name")]
public string GetAnchorName()
@@ -71,7 +72,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_is_active");
/// <summary>
- /// Returns true if the anchor is being tracked and false if no anchor with this id is currently known.
+ /// <para>Returns true if the anchor is being tracked and false if no anchor with this id is currently known.</para>
/// </summary>
[GodotMethod("get_is_active")]
public bool GetIsActive()
@@ -83,7 +84,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_size");
/// <summary>
- /// Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table.
+ /// <para>Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table.</para>
/// </summary>
[GodotMethod("get_size")]
public Vector3 GetSize()
@@ -95,7 +96,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_plane");
/// <summary>
- /// Returns a plane aligned with our anchor; handy for intersection testing.
+ /// <para>Returns a plane aligned with our anchor; handy for intersection testing.</para>
/// </summary>
[GodotMethod("get_plane")]
public Plane GetPlane()
@@ -106,3 +107,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRCamera.cs GodotSharp_after/GodotSharp/ObjectType/ARVRCamera.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRCamera.cs 2019-03-20 21:16:54.231329300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRCamera.cs 2019-03-23 19:57:07.548193000 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This is a helper spatial node for our camera; note that, if stereoscopic rendering is applicable (VR-HMD), most of the camera properties are ignored, as the HMD information overrides them. The only properties that can be trusted are the near and far planes.
- /// The position and orientation of this node is automatically updated by the ARVR Server to represent the location of the HMD if such tracking is available and can thus be used by game logic. Note that, in contrast to the ARVR Controller, the render thread has access to the most up-to-date tracking data of the HMD and the location of the ARVRCamera can lag a few milliseconds behind what is used for rendering as a result.
+ /// <para>This is a helper spatial node for our camera; note that, if stereoscopic rendering is applicable (VR-HMD), most of the camera properties are ignored, as the HMD information overrides them. The only properties that can be trusted are the near and far planes.</para>
+ /// <para>The position and orientation of this node is automatically updated by the ARVR Server to represent the location of the HMD if such tracking is available and can thus be used by game logic. Note that, in contrast to the ARVR Controller, the render thread has access to the most up-to-date tracking data of the HMD and the location of the ARVRCamera can lag a few milliseconds behind what is used for rendering as a result.</para>
/// </summary>
public partial class ARVRCamera : Camera
{
@@ -24,3 +25,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRController.cs GodotSharp_after/GodotSharp/ObjectType/ARVRController.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRController.cs 2019-03-20 21:16:54.235325700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRController.cs 2019-03-23 19:57:07.552191500 +0100
@@ -2,21 +2,22 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers.
- /// Controllers are linked by their id. You can create controller nodes before the controllers are available. Say your game always uses two controllers (one for each hand) you can predefine the controllers with id 1 and 2 and they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add ARVRController nodes to your scene.
- /// The position of the controller node is automatically updated by the ARVR Server. This makes this node ideal to add child nodes to visualise the controller.
+ /// <para>This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers.</para>
+ /// <para>Controllers are linked by their id. You can create controller nodes before the controllers are available. Say your game always uses two controllers (one for each hand) you can predefine the controllers with id 1 and 2 and they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add ARVRController nodes to your scene.</para>
+ /// <para>The position of the controller node is automatically updated by the ARVR Server. This makes this node ideal to add child nodes to visualise the controller.</para>
/// </summary>
public partial class ARVRController : Spatial
{
/// <summary>
- /// The controller's id.
- /// A controller id of 0 is unbound and will always result in an inactive node. Controller id 1 is reserved for the first controller that identifies itself as the left hand controller and id 2 is reserved for the first controller that identifies itself as the right hand controller.
- /// For any other controller that the [ARVRServer] detects, we continue with controller id 3.
- /// When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.
+ /// <para>The controller's id.</para>
+ /// <para>A controller id of 0 is unbound and will always result in an inactive node. Controller id 1 is reserved for the first controller that identifies itself as the left hand controller and id 2 is reserved for the first controller that identifies itself as the right hand controller.</para>
+ /// <para>For any other controller that the <see cref="Godot.ARVRServer"/> detects, we continue with controller id 3.</para>
+ /// <para>When a controller is turned off, its slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off.</para>
/// </summary>
public int ControllerId
{
@@ -31,7 +32,7 @@
}
/// <summary>
- /// The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code]. If changed, updates [member ARVRPositionalTracker.rumble] accordingly.
+ /// <para>The degree to which the tracker rumbles. Ranges from <c>0.0</c> to <c>1.0</c> with precision <c>.01</c>. If changed, updates <see cref="Godot.ARVRPositionalTracker.Rumble"/> accordingly.</para>
/// </summary>
public float Rumble
{
@@ -77,7 +78,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_controller_name");
/// <summary>
- /// If active, returns the name of the associated controller if provided by the AR/VR SDK used.
+ /// <para>If active, returns the name of the associated controller if provided by the AR/VR SDK used.</para>
/// </summary>
[GodotMethod("get_controller_name")]
public string GetControllerName()
@@ -89,7 +90,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_joystick_id");
/// <summary>
- /// Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.
+ /// <para>Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry.</para>
/// </summary>
[GodotMethod("get_joystick_id")]
public int GetJoystickId()
@@ -101,7 +102,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_button_pressed");
/// <summary>
- /// Returns [code]true[/code] if the button at index [code]button[/code] is pressed.
+ /// <para>Returns <c>true</c> if the button at index <c>button</c> is pressed.</para>
/// </summary>
[GodotMethod("is_button_pressed")]
public int IsButtonPressed(int button)
@@ -113,7 +114,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_joystick_axis");
/// <summary>
- /// Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.
+ /// <para>Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller.</para>
/// </summary>
[GodotMethod("get_joystick_axis")]
public float GetJoystickAxis(int axis)
@@ -125,7 +126,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_is_active");
/// <summary>
- /// Returns [code]true[/code] if the bound controller is active. ARVR systems attempt to track active controllers.
+ /// <para>Returns <c>true</c> if the bound controller is active. ARVR systems attempt to track active controllers.</para>
/// </summary>
[GodotMethod("get_is_active")]
public bool GetIsActive()
@@ -137,7 +138,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_hand");
/// <summary>
- /// Returns the hand holding this controller, if known. See TRACKER_* constants in [ARVRPositionalTracker].
+ /// <para>Returns the hand holding this controller, if known. See TRACKER_* constants in <see cref="Godot.ARVRPositionalTracker"/>.</para>
/// </summary>
[GodotMethod("get_hand")]
public ARVRPositionalTracker.TrackerHand GetHand()
@@ -166,3 +167,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRInterface.cs GodotSharp_after/GodotSharp/ObjectType/ARVRInterface.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRInterface.cs 2019-03-20 21:16:54.240324300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRInterface.cs 2019-03-23 19:57:07.557190000 +0100
@@ -2,35 +2,36 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDNative modules (note that for GDNative the subclass ARVRScriptInterface should be used). Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform.
- /// Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through ARVRServer.
+ /// <para>This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDNative modules (note that for GDNative the subclass ARVRScriptInterface should be used). Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform.</para>
+ /// <para>Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through ARVRServer.</para>
/// </summary>
public abstract partial class ARVRInterface : Reference
{
public enum Tracking_status
{
/// <summary>
- /// Tracking is behaving as expected.
+ /// <para>Tracking is behaving as expected.</para>
/// </summary>
NormalTracking = 0,
/// <summary>
- /// Tracking is hindered by excessive motion, player is moving faster then tracking can keep up.
+ /// <para>Tracking is hindered by excessive motion, player is moving faster then tracking can keep up.</para>
/// </summary>
ExcessiveMotion = 1,
/// <summary>
- /// Tracking is hindered by insufficient features, it's too dark (for camera based tracking), player is blocked, etc.
+ /// <para>Tracking is hindered by insufficient features, it's too dark (for camera based tracking), player is blocked, etc.</para>
/// </summary>
InsufficientFeatures = 2,
/// <summary>
- /// We don't know the status of the tracking or this interface does not provide feedback.
+ /// <para>We don't know the status of the tracking or this interface does not provide feedback.</para>
/// </summary>
UnknownTracking = 3,
/// <summary>
- /// Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.)
+ /// <para>Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.)</para>
/// </summary>
NotTracking = 4
}
@@ -38,15 +39,15 @@
public enum Eyes
{
/// <summary>
- /// Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported.
+ /// <para>Mono output, this is mostly used internally when retrieving positioning information for our camera node or when stereo scopic rendering is not supported.</para>
/// </summary>
Mono = 0,
/// <summary>
- /// Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information.
+ /// <para>Left eye output, this is mostly used internally when rendering the image for the left eye and obtaining positioning and projection information.</para>
/// </summary>
Left = 1,
/// <summary>
- /// Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information.
+ /// <para>Right eye output, this is mostly used internally when rendering the image for the right eye and obtaining positioning and projection information.</para>
/// </summary>
Right = 2
}
@@ -54,29 +55,29 @@
public enum Capabilities
{
/// <summary>
- /// No ARVR capabilities.
+ /// <para>No ARVR capabilities.</para>
/// </summary>
None = 0,
/// <summary>
- /// This interface can work with normal rendering output (non-HMD based AR).
+ /// <para>This interface can work with normal rendering output (non-HMD based AR).</para>
/// </summary>
Mono = 1,
/// <summary>
- /// This interface supports stereoscopic rendering.
+ /// <para>This interface supports stereoscopic rendering.</para>
/// </summary>
Stereo = 2,
/// <summary>
- /// This interface support AR (video background and real world tracking).
+ /// <para>This interface support AR (video background and real world tracking).</para>
/// </summary>
Ar = 4,
/// <summary>
- /// This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes.
+ /// <para>This interface outputs to an external device, if the main viewport is used the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of get_render_targetsize. Using a separate viewport node frees up the main viewport for other purposes.</para>
/// </summary>
External = 8
}
/// <summary>
- /// Is this our primary interface?
+ /// <para>Is this our primary interface?</para>
/// </summary>
public bool InterfaceIsPrimary
{
@@ -91,7 +92,7 @@
}
/// <summary>
- /// Has this interface been initialized?
+ /// <para>Has this interface been initialized?</para>
/// </summary>
public bool InterfaceIsInitialized
{
@@ -106,7 +107,7 @@
}
/// <summary>
- /// On an AR interface, is our anchor detection enabled?
+ /// <para>On an AR interface, is our anchor detection enabled?</para>
/// </summary>
public bool ArIsAnchorDetectionEnabled
{
@@ -130,7 +131,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_name");
/// <summary>
- /// Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).
+ /// <para>Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).</para>
/// </summary>
[GodotMethod("get_name")]
public string GetName()
@@ -142,7 +143,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_capabilities");
/// <summary>
- /// Returns a combination of flags providing information about the capabilities of this interface.
+ /// <para>Returns a combination of flags providing information about the capabilities of this interface.</para>
/// </summary>
[GodotMethod("get_capabilities")]
public int GetCapabilities()
@@ -190,11 +191,11 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "initialize");
/// <summary>
- /// Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.
- /// After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence.
- /// Note that you must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR.
- /// If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively you can add a separate viewport node to your scene and enable AR/VR on that viewport and it will be used to output to the HMD leaving you free to do anything you like in the main window such as using a separate camera as a spectator camera or render out something completely different.
- /// While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.
+ /// <para>Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.</para>
+ /// <para>After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence.</para>
+ /// <para>Note that you must enable the AR/VR mode on the main viewport for any device that uses the main output of Godot such as for mobile VR.</para>
+ /// <para>If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively you can add a separate viewport node to your scene and enable AR/VR on that viewport and it will be used to output to the HMD leaving you free to do anything you like in the main window such as using a separate camera as a spectator camera or render out something completely different.</para>
+ /// <para>While currently not used you can activate additional interfaces, you may wish to do this if you want to track controllers from other platforms. However at this point in time only one interface can render to an HMD.</para>
/// </summary>
[GodotMethod("initialize")]
public bool Initialize()
@@ -206,7 +207,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "uninitialize");
/// <summary>
- /// Turns the interface off.
+ /// <para>Turns the interface off.</para>
/// </summary>
[GodotMethod("uninitialize")]
public void Uninitialize()
@@ -218,7 +219,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_tracking_status");
/// <summary>
- /// If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
+ /// <para>If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.</para>
/// </summary>
[GodotMethod("get_tracking_status")]
public ARVRInterface.Tracking_status GetTrackingStatus()
@@ -230,7 +231,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_render_targetsize");
/// <summary>
- /// Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
+ /// <para>Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.</para>
/// </summary>
[GodotMethod("get_render_targetsize")]
public Vector2 GetRenderTargetsize()
@@ -242,7 +243,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_stereo");
/// <summary>
- /// Returns true if the current output of this interface is in stereo.
+ /// <para>Returns true if the current output of this interface is in stereo.</para>
/// </summary>
[GodotMethod("is_stereo")]
public bool IsStereo()
@@ -271,3 +272,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRInterfaceGDNative.cs GodotSharp_after/GodotSharp/ObjectType/ARVRInterfaceGDNative.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRInterfaceGDNative.cs 2019-03-20 21:16:54.243322900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRInterfaceGDNative.cs 2019-03-23 19:57:07.559197100 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This is a wrapper class for GDNative implementations of the ARVR interface. To use a GDNative ARVR interface simply instantiate this object and set your GDNative library containing the ARVR interface implementation.
+ /// <para>This is a wrapper class for GDNative implementations of the ARVR interface. To use a GDNative ARVR interface simply instantiate this object and set your GDNative library containing the ARVR interface implementation.</para>
/// </summary>
public partial class ARVRInterfaceGDNative : ARVRInterface
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVROrigin.cs GodotSharp_after/GodotSharp/ObjectType/ARVROrigin.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVROrigin.cs 2019-03-20 21:16:54.246322100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVROrigin.cs 2019-03-23 19:57:07.561190300 +0100
@@ -2,20 +2,21 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world.
- /// There should be only one of these nodes in your scene and you must have one. All the ARVRCamera, ARVRController and ARVRAnchor nodes should be direct children of this node for spatial tracking to work correctly.
- /// It is the position of this node that you update when your character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point.
- /// So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc.
+ /// <para>This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world.</para>
+ /// <para>There should be only one of these nodes in your scene and you must have one. All the ARVRCamera, ARVRController and ARVRAnchor nodes should be direct children of this node for spatial tracking to work correctly.</para>
+ /// <para>It is the position of this node that you update when your character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point.</para>
+ /// <para>So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc.</para>
/// </summary>
public partial class ARVROrigin : Spatial
{
/// <summary>
- /// Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.
- /// Note that this method is a passthrough to the [ARVRServer] itself.
+ /// <para>Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.</para>
+ /// <para>Note that this method is a passthrough to the <see cref="Godot.ARVRServer"/> itself.</para>
/// </summary>
public float WorldScale
{
@@ -60,3 +61,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRPositionalTracker.cs GodotSharp_after/GodotSharp/ObjectType/ARVRPositionalTracker.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRPositionalTracker.cs 2019-03-20 21:16:54.250320500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRPositionalTracker.cs 2019-03-23 19:57:07.565187100 +0100
@@ -2,34 +2,35 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// An instance of this object represents a device that is tracked such as a controller or anchor point. HMDs aren't represented here as they are fully handled internally.
- /// As controllers are turned on and the AR/VR interface detects them instances of this object are automatically added to this list of active tracking objects accessible through the ARVRServer
- /// The ARVRController and ARVRAnchor both consume objects of this type and should be the objects you use in game. The positional trackers are just the under the hood objects that make this all work and are mostly exposed so GDNative based interfaces can interact with them.
+ /// <para>An instance of this object represents a device that is tracked such as a controller or anchor point. HMDs aren't represented here as they are fully handled internally.</para>
+ /// <para>As controllers are turned on and the AR/VR interface detects them instances of this object are automatically added to this list of active tracking objects accessible through the ARVRServer</para>
+ /// <para>The ARVRController and ARVRAnchor both consume objects of this type and should be the objects you use in game. The positional trackers are just the under the hood objects that make this all work and are mostly exposed so GDNative based interfaces can interact with them.</para>
/// </summary>
public partial class ARVRPositionalTracker : Object
{
public enum TrackerHand
{
/// <summary>
- /// The hand this tracker is held in is unknown or not applicable.
+ /// <para>The hand this tracker is held in is unknown or not applicable.</para>
/// </summary>
HandUnknown = 0,
/// <summary>
- /// This tracker is the left hand controller.
+ /// <para>This tracker is the left hand controller.</para>
/// </summary>
LeftHand = 1,
/// <summary>
- /// This tracker is the right hand controller.
+ /// <para>This tracker is the right hand controller.</para>
/// </summary>
RightHand = 2
}
/// <summary>
- /// The degree to which the tracker rumbles. Ranges from [code]0.0[/code] to [code]1.0[/code] with precision [code].01[/code].
+ /// <para>The degree to which the tracker rumbles. Ranges from <c>0.0</c> to <c>1.0</c> with precision <c>.01</c>.</para>
/// </summary>
public float Rumble
{
@@ -57,7 +58,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_type");
/// <summary>
- /// Returns the tracker's type.
+ /// <para>Returns the tracker's type.</para>
/// </summary>
[GodotMethod("get_type")]
public ARVRServer.TrackerType GetType()
@@ -69,7 +70,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_name");
/// <summary>
- /// Returns the controller or anchor point's name if available.
+ /// <para>Returns the controller or anchor point's name if available.</para>
/// </summary>
[GodotMethod("get_name")]
public string GetName()
@@ -81,7 +82,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_joy_id");
/// <summary>
- /// If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id.
+ /// <para>If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id.</para>
/// </summary>
[GodotMethod("get_joy_id")]
public int GetJoyId()
@@ -93,7 +94,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_tracks_orientation");
/// <summary>
- /// Returns [code]true[/code] if this device tracks orientation.
+ /// <para>Returns <c>true</c> if this device tracks orientation.</para>
/// </summary>
[GodotMethod("get_tracks_orientation")]
public bool GetTracksOrientation()
@@ -105,7 +106,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_orientation");
/// <summary>
- /// Returns the controller's orientation matrix.
+ /// <para>Returns the controller's orientation matrix.</para>
/// </summary>
[GodotMethod("get_orientation")]
public Basis GetOrientation()
@@ -117,7 +118,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_tracks_position");
/// <summary>
- /// Returns [code]true[/code] if this device tracks position.
+ /// <para>Returns <c>true</c> if this device tracks position.</para>
/// </summary>
[GodotMethod("get_tracks_position")]
public bool GetTracksPosition()
@@ -129,7 +130,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_position");
/// <summary>
- /// Returns the world-space controller position.
+ /// <para>Returns the world-space controller position.</para>
/// </summary>
[GodotMethod("get_position")]
public Vector3 GetPosition()
@@ -141,7 +142,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_hand");
/// <summary>
- /// Returns the hand holding this tracker, if known. See TRACKER_* constants.
+ /// <para>Returns the hand holding this tracker, if known. See TRACKER_* constants.</para>
/// </summary>
[GodotMethod("get_hand")]
public ARVRPositionalTracker.TrackerHand GetHand()
@@ -153,7 +154,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_transform");
/// <summary>
- /// Returns the transform combining this device's orientation and position.
+ /// <para>Returns the transform combining this device's orientation and position.</para>
/// </summary>
[GodotMethod("get_transform")]
public Transform GetTransform(bool adjustByReferenceFrame)
@@ -182,3 +183,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ARVRServer.cs GodotSharp_after/GodotSharp/ObjectType/ARVRServer.cs
--- GodotSharp_before/GodotSharp/ObjectType/ARVRServer.cs 2019-03-20 21:16:54.254331400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ARVRServer.cs 2019-03-23 19:57:07.569187400 +0100
@@ -2,26 +2,27 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// The AR/VR Server is the heart of our AR/VR solution and handles all the processing.
+ /// <para>The AR/VR Server is the heart of our AR/VR solution and handles all the processing.</para>
/// </summary>
public static partial class ARVRServer
{
public enum RotationMode
{
/// <summary>
- /// Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world.
+ /// <para>Fully reset the orientation of the HMD. Regardless of what direction the user is looking to in the real world. The user will look dead ahead in the virtual world.</para>
/// </summary>
ResetFullRotation = 0,
/// <summary>
- /// Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset.
+ /// <para>Resets the orientation but keeps the tilt of the device. So if we're looking down, we keep looking down but heading will be reset.</para>
/// </summary>
ResetButKeepTilt = 1,
/// <summary>
- /// Does not reset the orientation of the HMD, only the position of the player gets centered.
+ /// <para>Does not reset the orientation of the HMD, only the position of the player gets centered.</para>
/// </summary>
DontResetRotation = 2
}
@@ -29,33 +30,33 @@
public enum TrackerType
{
/// <summary>
- /// Our tracker tracks the location of a controller.
+ /// <para>Our tracker tracks the location of a controller.</para>
/// </summary>
Controller = 1,
/// <summary>
- /// Our tracker tracks the location of a base station.
+ /// <para>Our tracker tracks the location of a base station.</para>
/// </summary>
Basestation = 2,
/// <summary>
- /// Our tracker tracks the location and size of an AR anchor.
+ /// <para>Our tracker tracks the location and size of an AR anchor.</para>
/// </summary>
Anchor = 4,
/// <summary>
- /// Used internally to filter trackers of any known type.
+ /// <para>Used internally to filter trackers of any known type.</para>
/// </summary>
AnyKnown = 127,
/// <summary>
- /// Used internally if we haven't set the tracker type yet.
+ /// <para>Used internally if we haven't set the tracker type yet.</para>
/// </summary>
Unknown = 128,
/// <summary>
- /// Used internally to select all trackers.
+ /// <para>Used internally to select all trackers.</para>
/// </summary>
Any = 255
}
/// <summary>
- /// Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.
+ /// <para>Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 meter in the real world.</para>
/// </summary>
public static float WorldScale
{
@@ -121,7 +122,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_reference_frame");
/// <summary>
- /// Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.
+ /// <para>Gets our reference frame transform, mostly used internally and exposed for GDNative build interfaces.</para>
/// </summary>
[GodotMethod("get_reference_frame")]
public static Transform GetReferenceFrame()
@@ -133,12 +134,12 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "center_on_hmd");
/// <summary>
- /// This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently.
- /// For platforms that do not offer spatial tracking our origin point (0,0,0) is the location of our HMD but you have little control over the direction the player is facing in the real world.
- /// For platforms that do offer spatial tracking our origin point depends very much on the system. For OpenVR our origin point is usually the center of the tracking space, on the ground. For other platforms its often the location of the tracking camera.
- /// This method allows you to center our tracker on the location of the HMD, it will take the current location of the HMD and use that to adjust all our tracking data in essence realigning the real world to your players current position in your game world.
- /// For this method to produce usable results tracking information should be available and this often takes a few frames after starting your game.
- /// You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism.
+ /// <para>This is a really important function to understand correctly. AR and VR platforms all handle positioning slightly differently.</para>
+ /// <para>For platforms that do not offer spatial tracking our origin point (0,0,0) is the location of our HMD but you have little control over the direction the player is facing in the real world.</para>
+ /// <para>For platforms that do offer spatial tracking our origin point depends very much on the system. For OpenVR our origin point is usually the center of the tracking space, on the ground. For other platforms its often the location of the tracking camera.</para>
+ /// <para>This method allows you to center our tracker on the location of the HMD, it will take the current location of the HMD and use that to adjust all our tracking data in essence realigning the real world to your players current position in your game world.</para>
+ /// <para>For this method to produce usable results tracking information should be available and this often takes a few frames after starting your game.</para>
+ /// <para>You should call this method after a few seconds have passed, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, and when implementing a teleport mechanism.</para>
/// </summary>
[GodotMethod("center_on_hmd")]
public static void CenterOnHmd(ARVRServer.RotationMode rotationMode, bool keepHeight)
@@ -150,7 +151,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_hmd_transform");
/// <summary>
- /// Returns the primary interface's transformation.
+ /// <para>Returns the primary interface's transformation.</para>
/// </summary>
[GodotMethod("get_hmd_transform")]
public static Transform GetHmdTransform()
@@ -162,7 +163,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_interface_count");
/// <summary>
- /// Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns true.
+ /// <para>Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns true.</para>
/// </summary>
[GodotMethod("get_interface_count")]
public static int GetInterfaceCount()
@@ -174,7 +175,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_interface");
/// <summary>
- /// Get the interface registered at a given index in our list of interfaces.
+ /// <para>Get the interface registered at a given index in our list of interfaces.</para>
/// </summary>
[GodotMethod("get_interface")]
public static ARVRInterface GetInterface(int idx)
@@ -186,7 +187,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_interfaces");
/// <summary>
- /// Returns a list of available interfaces with both id and name of the interface.
+ /// <para>Returns a list of available interfaces with both id and name of the interface.</para>
/// </summary>
[GodotMethod("get_interfaces")]
public static Godot.Collections.Array GetInterfaces()
@@ -198,7 +199,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "find_interface");
/// <summary>
- /// Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.
+ /// <para>Find an interface by its name. Say that you're making a game that uses specific capabilities of an AR/VR platform you can find the interface for that platform by name and initialize it.</para>
/// </summary>
[GodotMethod("find_interface")]
public static ARVRInterface FindInterface(string name)
@@ -210,7 +211,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_tracker_count");
/// <summary>
- /// Get the number of trackers currently registered.
+ /// <para>Get the number of trackers currently registered.</para>
/// </summary>
[GodotMethod("get_tracker_count")]
public static int GetTrackerCount()
@@ -222,7 +223,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_tracker");
/// <summary>
- /// Get the positional tracker at the given ID.
+ /// <para>Get the positional tracker at the given ID.</para>
/// </summary>
[GodotMethod("get_tracker")]
public static ARVRPositionalTracker GetTracker(int idx)
@@ -287,3 +288,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AStar.cs GodotSharp_after/GodotSharp/ObjectType/AStar.cs
--- GodotSharp_before/GodotSharp/ObjectType/AStar.cs 2019-03-20 21:16:54.261317500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AStar.cs 2019-03-23 19:57:07.575184500 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A* implementation make use of vectors as points.
- /// You must add points manually with [method AStar.add_point] and create segments manually with [method AStar.connect_points]. So you can test if there is a path between two points with the [method AStar.are_points_connected] function, get the list of existing ids in the found path with [method AStar.get_id_path], or the points list with [method AStar.get_point_path].
+ /// <para>A* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A* implementation make use of vectors as points.</para>
+ /// <para>You must add points manually with <see cref="Godot.AStar.AddPoint"/> and create segments manually with <see cref="Godot.AStar.ConnectPoints"/>. So you can test if there is a path between two points with the <see cref="Godot.AStar.ArePointsConnected"/> function, get the list of existing ids in the found path with <see cref="Godot.AStar.GetIdPath"/>, or the points list with <see cref="Godot.AStar.GetPointPath"/>.</para>
/// </summary>
public partial class AStar : Reference
{
@@ -22,7 +23,7 @@
internal AStar(bool memoryOwn) : base(memoryOwn) {}
/// <summary>
- /// Called when computing the cost between two connected points.
+ /// <para>Called when computing the cost between two connected points.</para>
/// </summary>
[GodotMethod("_compute_cost")]
public virtual float _ComputeCost(int fromId, int toId)
@@ -31,7 +32,7 @@
}
/// <summary>
- /// Called when estimating the cost between a point and the path's ending point.
+ /// <para>Called when estimating the cost between a point and the path's ending point.</para>
/// </summary>
[GodotMethod("_estimate_cost")]
public virtual float _EstimateCost(int fromId, int toId)
@@ -43,7 +44,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_available_point_id");
/// <summary>
- /// Returns the next available point id with no point associated to it.
+ /// <para>Returns the next available point id with no point associated to it.</para>
/// </summary>
[GodotMethod("get_available_point_id")]
public int GetAvailablePointId()
@@ -55,12 +56,12 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_point");
/// <summary>
- /// Adds a new point at the given position with the given identifier. The algorithm prefers points with lower [code]weight_scale[/code] to form a path. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger.
- /// [codeblock]
+ /// <para>Adds a new point at the given position with the given identifier. The algorithm prefers points with lower <c>weight_scale</c> to form a path. The <c>id</c> must be 0 or larger, and the <c>weight_scale</c> must be 1 or larger.</para>
+ /// <para><code>
/// var as = AStar.new()
/// as.add_point(1, Vector3(1, 0, 0), 4) # Adds the point (1, 0, 0) with weight_scale 4 and id 1
- /// [/codeblock]
- /// If there already exists a point for the given id, its position and weight scale are updated to the given values.
+ /// </code></para>
+ /// <para>If there already exists a point for the given id, its position and weight scale are updated to the given values.</para>
/// </summary>
[GodotMethod("add_point")]
public void AddPoint(int id, Vector3 position, float weightScale = 1f)
@@ -72,7 +73,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_position");
/// <summary>
- /// Returns the position of the point associated with the given id.
+ /// <para>Returns the position of the point associated with the given id.</para>
/// </summary>
[GodotMethod("get_point_position")]
public Vector3 GetPointPosition(int id)
@@ -84,7 +85,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_position");
/// <summary>
- /// Sets the position for the point with the given id.
+ /// <para>Sets the position for the point with the given id.</para>
/// </summary>
[GodotMethod("set_point_position")]
public void SetPointPosition(int id, Vector3 position)
@@ -96,7 +97,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_weight_scale");
/// <summary>
- /// Returns the weight scale of the point associated with the given id.
+ /// <para>Returns the weight scale of the point associated with the given id.</para>
/// </summary>
[GodotMethod("get_point_weight_scale")]
public float GetPointWeightScale(int id)
@@ -108,7 +109,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_weight_scale");
/// <summary>
- /// Sets the [code]weight_scale[/code] for the point with the given id.
+ /// <para>Sets the <c>weight_scale</c> for the point with the given id.</para>
/// </summary>
[GodotMethod("set_point_weight_scale")]
public void SetPointWeightScale(int id, float weightScale)
@@ -120,7 +121,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_point");
/// <summary>
- /// Removes the point associated with the given id from the points pool.
+ /// <para>Removes the point associated with the given id from the points pool.</para>
/// </summary>
[GodotMethod("remove_point")]
public void RemovePoint(int id)
@@ -132,7 +133,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "has_point");
/// <summary>
- /// Returns whether a point associated with the given id exists.
+ /// <para>Returns whether a point associated with the given id exists.</para>
/// </summary>
[GodotMethod("has_point")]
public bool HasPoint(int id)
@@ -144,7 +145,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_points");
/// <summary>
- /// Returns an array of all points.
+ /// <para>Returns an array of all points.</para>
/// </summary>
[GodotMethod("get_points")]
public Godot.Collections.Array GetPoints()
@@ -156,8 +157,8 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_connections");
/// <summary>
- /// Returns an array with the ids of the points that form the connect with the given point.
- /// [codeblock]
+ /// <para>Returns an array with the ids of the points that form the connect with the given point.</para>
+ /// <para><code>
/// var as = AStar.new()
/// as.add_point(1, Vector3(0, 0, 0))
/// as.add_point(2, Vector3(0, 1, 0))
@@ -168,7 +169,7 @@
/// as.connect_points(1, 3, true)
///
/// var neighbors = as.get_point_connections(1) # returns [2, 3]
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("get_point_connections")]
public int[] GetPointConnections(int id)
@@ -180,13 +181,13 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "connect_points");
/// <summary>
- /// Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction.
- /// [codeblock]
+ /// <para>Creates a segment between the given points. If <c>bidirectional</c> is <c>false</c>, only movement from <c>id</c> to <c>to_id</c> is allowed, not the reverse direction.</para>
+ /// <para><code>
/// var as = AStar.new()
/// as.add_point(1, Vector3(1, 1, 0))
/// as.add_point(2, Vector3(0, 5, 0))
/// as.connect_points(1, 2, false)
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("connect_points")]
public void ConnectPoints(int id, int toId, bool bidirectional = true)
@@ -198,7 +199,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "disconnect_points");
/// <summary>
- /// Deletes the segment between the given points.
+ /// <para>Deletes the segment between the given points.</para>
/// </summary>
[GodotMethod("disconnect_points")]
public void DisconnectPoints(int id, int toId)
@@ -210,7 +211,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "are_points_connected");
/// <summary>
- /// Returns whether there is a connection/segment between the given points.
+ /// <para>Returns whether there is a connection/segment between the given points.</para>
/// </summary>
[GodotMethod("are_points_connected")]
public bool ArePointsConnected(int id, int toId)
@@ -222,7 +223,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear");
/// <summary>
- /// Clears all the points and segments.
+ /// <para>Clears all the points and segments.</para>
/// </summary>
[GodotMethod("clear")]
public void Clear()
@@ -234,7 +235,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_closest_point");
/// <summary>
- /// Returns the id of the closest point to [code]to_position[/code]. Returns -1 if there are no points in the points pool.
+ /// <para>Returns the id of the closest point to <c>to_position</c>. Returns -1 if there are no points in the points pool.</para>
/// </summary>
[GodotMethod("get_closest_point")]
public int GetClosestPoint(Vector3 toPosition)
@@ -246,15 +247,15 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_closest_position_in_segment");
/// <summary>
- /// Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points.
- /// [codeblock]
+ /// <para>Returns the closest position to <c>to_position</c> that resides inside a segment between two connected points.</para>
+ /// <para><code>
/// var as = AStar.new()
/// as.add_point(1, Vector3(0, 0, 0))
/// as.add_point(2, Vector3(0, 5, 0))
/// as.connect_points(1, 2)
/// var res = as.get_closest_position_in_segment(Vector3(3, 3, 0)) # returns (0, 3, 0)
- /// [/codeblock]
- /// The result is in the segment that goes from [code]y = 0[/code] to [code]y = 5[/code]. It's the closest position in the segment to the given point.
+ /// </code></para>
+ /// <para>The result is in the segment that goes from <c>y = 0</c> to <c>y = 5</c>. It's the closest position in the segment to the given point.</para>
/// </summary>
[GodotMethod("get_closest_position_in_segment")]
public Vector3 GetClosestPositionInSegment(Vector3 toPosition)
@@ -266,7 +267,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_path");
/// <summary>
- /// Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
+ /// <para>Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.</para>
/// </summary>
[GodotMethod("get_point_path")]
public Vector3[] GetPointPath(int fromId, int toId)
@@ -278,8 +279,8 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_id_path");
/// <summary>
- /// Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
- /// [codeblock]
+ /// <para>Returns an array with the ids of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.</para>
+ /// <para><code>
/// var as = AStar.new()
/// as.add_point(1, Vector3(0, 0, 0))
/// as.add_point(2, Vector3(0, 1, 0), 1) # default weight is 1
@@ -293,8 +294,8 @@
/// as.connect_points(5, 4, false)
///
/// var res = as.get_id_path(1, 3) # returns [1, 2, 3]
- /// [/codeblock]
- /// If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2.
+ /// </code></para>
+ /// <para>If you change the 2nd point's weight to 3, then the result will be <c>[1, 4, 3]</c> instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2.</para>
/// </summary>
[GodotMethod("get_id_path")]
public int[] GetIdPath(int fromId, int toId)
@@ -305,3 +306,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AtlasTexture.cs GodotSharp_after/GodotSharp/ObjectType/AtlasTexture.cs
--- GodotSharp_before/GodotSharp/ObjectType/AtlasTexture.cs 2019-03-20 21:16:54.506264100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AtlasTexture.cs 2019-03-23 19:57:07.766122300 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// [Texture] resource aimed at managing big textures files that pack multiple smaller textures. Consists of a [Texture], a margin that defines the border width,
- /// and a region that defines the actual area of the AtlasTexture.
+ /// <para><see cref="Godot.Texture"/> resource aimed at managing big textures files that pack multiple smaller textures. Consists of a <see cref="Godot.Texture"/>, a margin that defines the border width,</para>
+ /// <para>and a region that defines the actual area of the AtlasTexture.</para>
/// </summary>
public partial class AtlasTexture : Texture
{
/// <summary>
- /// The texture that contains the atlas. Can be any [Texture] subtype.
+ /// <para>The texture that contains the atlas. Can be any <see cref="Godot.Texture"/> subtype.</para>
/// </summary>
public Texture Atlas
{
@@ -27,7 +28,7 @@
}
/// <summary>
- /// The AtlasTexture's used region.
+ /// <para>The AtlasTexture's used region.</para>
/// </summary>
public Rect2 Region
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.
+ /// <para>The margin around the region. The <see cref="Godot.Rect2"/>'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin.</para>
/// </summary>
public Rect2 Margin
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// If [code]true[/code], clips the area outside of the region to avoid bleeding of the surrounding texture pixels.
+ /// <para>If <c>true</c>, clips the area outside of the region to avoid bleeding of the surrounding texture pixels.</para>
/// </summary>
public bool FilterClip
{
@@ -156,3 +157,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioBusLayout.cs GodotSharp_after/GodotSharp/ObjectType/AudioBusLayout.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioBusLayout.cs 2019-03-20 21:16:54.510264000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioBusLayout.cs 2019-03-23 19:57:07.768122600 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Stores position, muting, solo, bypass, effects, effect position, volume, and the connections between buses. See [AudioServer] for usage.
+ /// <para>Stores position, muting, solo, bypass, effects, effect position, volume, and the connections between buses. See <see cref="Godot.AudioServer"/> for usage.</para>
/// </summary>
public partial class AudioBusLayout : Resource
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffect.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffect.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffect.cs 2019-03-20 21:16:54.511263000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffect.cs 2019-03-23 19:57:07.769120200 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on.
+ /// <para>Base resource for audio bus. Applies an audio effect on the bus that the resource is applied on.</para>
/// </summary>
public abstract partial class AudioEffect : Resource
{
@@ -19,3 +20,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectAmplify.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectAmplify.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectAmplify.cs 2019-03-20 21:16:54.514262200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectAmplify.cs 2019-03-23 19:57:07.772119700 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Increases or decreases the volume being routed through the audio bus.
+ /// <para>Increases or decreases the volume being routed through the audio bus.</para>
/// </summary>
public partial class AudioEffectAmplify : AudioEffect
{
/// <summary>
- /// Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: [code]0[/code].
+ /// <para>Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: <c>0</c>.</para>
/// </summary>
public float VolumeDb
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectBandLimitFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectBandLimitFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectBandLimitFilter.cs 2019-03-20 21:16:54.516261300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectBandLimitFilter.cs 2019-03-23 19:57:07.774119000 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Limits the frequencies in a range around the [member AudioEffectFilter.cutoff_hz] and allows frequencies outside of this range to pass.
+ /// <para>Limits the frequencies in a range around the <see cref="Godot.AudioEffectFilter.CutoffHz"/> and allows frequencies outside of this range to pass.</para>
/// </summary>
public partial class AudioEffectBandLimitFilter : AudioEffectFilter
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectBandPassFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectBandPassFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectBandPassFilter.cs 2019-03-20 21:16:54.519261000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectBandPassFilter.cs 2019-03-23 19:57:07.777118300 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Attenuates the frequencies inside of a range around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this band.
+ /// <para>Attenuates the frequencies inside of a range around the <see cref="Godot.AudioEffectFilter.CutoffHz"/> and cuts frequencies outside of this band.</para>
/// </summary>
public partial class AudioEffectBandPassFilter : AudioEffectFilter
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectChorus.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectChorus.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectChorus.cs 2019-03-20 21:16:54.525258700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectChorus.cs 2019-03-23 19:57:07.783116300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.
+ /// <para>Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.</para>
/// </summary>
public partial class AudioEffectChorus : AudioEffect
{
/// <summary>
- /// The amount of voices in the effect.
+ /// <para>The amount of voices in the effect.</para>
/// </summary>
public int VoiceCount
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The effect's raw signal.
+ /// <para>The effect's raw signal.</para>
/// </summary>
public float Dry
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The effect's processed signal.
+ /// <para>The effect's processed signal.</para>
/// </summary>
public float Wet
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// The voice's signal delay.
+ /// <para>The voice's signal delay.</para>
/// </summary>
public float Voice__1__delayMs
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// The voice's filter rate.
+ /// <para>The voice's filter rate.</para>
/// </summary>
public float Voice__1__rateHz
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// The voice filter's depth.
+ /// <para>The voice filter's depth.</para>
/// </summary>
public float Voice__1__depthMs
{
@@ -101,7 +102,7 @@
}
/// <summary>
- /// The voice's volume.
+ /// <para>The voice's volume.</para>
/// </summary>
public float Voice__1__levelDb
{
@@ -116,7 +117,7 @@
}
/// <summary>
- /// The voice's cutoff frequency.
+ /// <para>The voice's cutoff frequency.</para>
/// </summary>
public float Voice__1__cutoffHz
{
@@ -131,7 +132,7 @@
}
/// <summary>
- /// The voice's pan level.
+ /// <para>The voice's pan level.</para>
/// </summary>
public float Voice__1__pan
{
@@ -146,7 +147,7 @@
}
/// <summary>
- /// The voice's signal delay.
+ /// <para>The voice's signal delay.</para>
/// </summary>
public float Voice__2__delayMs
{
@@ -161,7 +162,7 @@
}
/// <summary>
- /// The voice's filter rate.
+ /// <para>The voice's filter rate.</para>
/// </summary>
public float Voice__2__rateHz
{
@@ -176,7 +177,7 @@
}
/// <summary>
- /// The voice filter's depth.
+ /// <para>The voice filter's depth.</para>
/// </summary>
public float Voice__2__depthMs
{
@@ -191,7 +192,7 @@
}
/// <summary>
- /// The voice's volume.
+ /// <para>The voice's volume.</para>
/// </summary>
public float Voice__2__levelDb
{
@@ -206,7 +207,7 @@
}
/// <summary>
- /// The voice's cutoff frequency.
+ /// <para>The voice's cutoff frequency.</para>
/// </summary>
public float Voice__2__cutoffHz
{
@@ -221,7 +222,7 @@
}
/// <summary>
- /// The voice's pan level.
+ /// <para>The voice's pan level.</para>
/// </summary>
public float Voice__2__pan
{
@@ -236,7 +237,7 @@
}
/// <summary>
- /// The voice's signal delay.
+ /// <para>The voice's signal delay.</para>
/// </summary>
public float Voice__3__delayMs
{
@@ -251,7 +252,7 @@
}
/// <summary>
- /// The voice's filter rate.
+ /// <para>The voice's filter rate.</para>
/// </summary>
public float Voice__3__rateHz
{
@@ -266,7 +267,7 @@
}
/// <summary>
- /// The voice filter's depth.
+ /// <para>The voice filter's depth.</para>
/// </summary>
public float Voice__3__depthMs
{
@@ -281,7 +282,7 @@
}
/// <summary>
- /// The voice's volume.
+ /// <para>The voice's volume.</para>
/// </summary>
public float Voice__3__levelDb
{
@@ -296,7 +297,7 @@
}
/// <summary>
- /// The voice's cutoff frequency.
+ /// <para>The voice's cutoff frequency.</para>
/// </summary>
public float Voice__3__cutoffHz
{
@@ -311,7 +312,7 @@
}
/// <summary>
- /// The voice's pan level.
+ /// <para>The voice's pan level.</para>
/// </summary>
public float Voice__3__pan
{
@@ -326,7 +327,7 @@
}
/// <summary>
- /// The voice's signal delay.
+ /// <para>The voice's signal delay.</para>
/// </summary>
public float Voice__4__delayMs
{
@@ -341,7 +342,7 @@
}
/// <summary>
- /// The voice's filter rate.
+ /// <para>The voice's filter rate.</para>
/// </summary>
public float Voice__4__rateHz
{
@@ -356,7 +357,7 @@
}
/// <summary>
- /// The voice filter's depth.
+ /// <para>The voice filter's depth.</para>
/// </summary>
public float Voice__4__depthMs
{
@@ -371,7 +372,7 @@
}
/// <summary>
- /// The voice's volume.
+ /// <para>The voice's volume.</para>
/// </summary>
public float Voice__4__levelDb
{
@@ -386,7 +387,7 @@
}
/// <summary>
- /// The voice's cutoff frequency.
+ /// <para>The voice's cutoff frequency.</para>
/// </summary>
public float Voice__4__cutoffHz
{
@@ -401,7 +402,7 @@
}
/// <summary>
- /// The voice's pan level.
+ /// <para>The voice's pan level.</para>
/// </summary>
public float Voice__4__pan
{
@@ -590,3 +591,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectCompressor.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectCompressor.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectCompressor.cs 2019-03-20 21:16:54.531257100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectCompressor.cs 2019-03-23 19:57:07.788116000 +0100
@@ -2,21 +2,22 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB).
- /// Compressor has many uses in the mix:
- /// - In the Master bus to compress the whole output (Although a [AudioEffectLimiter] is probably better)
- /// - In voice channels to ensure they sound as balanced as possible.
- /// - Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard.
- /// - Accentuates transients by using a wider attack, making effects sound more punchy.
+ /// <para>Dynamic range compressor reduces the level of the sound when the amplitude goes over a certain threshold in Decibels. One of the main uses of a compressor is to increase the dynamic range by clipping as little as possible (when sound goes over 0dB).</para>
+ /// <para>Compressor has many uses in the mix:</para>
+ /// <para>- In the Master bus to compress the whole output (Although a <see cref="Godot.AudioEffectLimiter"/> is probably better)</para>
+ /// <para>- In voice channels to ensure they sound as balanced as possible.</para>
+ /// <para>- Sidechained. Sidechained, which can reduce the sound level sidechained with another audio bus for threshold detection.. This technique is very common in video game mixing to download the level of Music/SFX while voices are being heard.</para>
+ /// <para>- Accentuates transients by using a wider attack, making effects sound more punchy.</para>
/// </summary>
public partial class AudioEffectCompressor : AudioEffect
{
/// <summary>
- /// The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: [code]0[/code].
+ /// <para>The level above which compression is applied to the audio. Value can range from -60 to 0. Default value: <c>0</c>.</para>
/// </summary>
public float Threshold
{
@@ -31,7 +32,7 @@
}
/// <summary>
- /// Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: [code]4[/code].
+ /// <para>Amount of compression applied to the audio once it passes the threshold level. The higher the ratio the more the loud parts of the audio will be compressed. Value can range from 1 to 48. Default value: <c>4</c>.</para>
/// </summary>
public float Ratio
{
@@ -46,7 +47,7 @@
}
/// <summary>
- /// Gain applied to the output signal.
+ /// <para>Gain applied to the output signal.</para>
/// </summary>
public float Gain
{
@@ -61,7 +62,7 @@
}
/// <summary>
- /// Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: [code]20ms[/code].
+ /// <para>Compressor's reaction time when the signal exceeds the threshold. Value can range from 20 to 2000. Default value: <c>20ms</c>.</para>
/// </summary>
public float AttackUs
{
@@ -76,7 +77,7 @@
}
/// <summary>
- /// Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: [code]250ms[/code].
+ /// <para>Compressor's delay time to stop reducing the signal after the signal level falls below the threshold. Value can range from 20 to 2000. Default value: <c>250ms</c>.</para>
/// </summary>
public float ReleaseMs
{
@@ -91,7 +92,7 @@
}
/// <summary>
- /// Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: [code]1[/code].
+ /// <para>Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet). Default value: <c>1</c>.</para>
/// </summary>
public float Mix
{
@@ -106,7 +107,7 @@
}
/// <summary>
- /// Reduce the sound level using another audio bus for threshold detection.
+ /// <para>Reduce the sound level using another audio bus for threshold detection.</para>
/// </summary>
public string Sidechain
{
@@ -259,3 +260,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectDelay.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectDelay.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectDelay.cs 2019-03-20 21:16:54.536255800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectDelay.cs 2019-03-23 19:57:07.794114100 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.
+ /// <para>Plays input signal back after a period of time. The delayed signal may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo effect to a pronounced blending of previous sounds with new sounds.</para>
/// </summary>
public partial class AudioEffectDelay : AudioEffect
{
/// <summary>
- /// Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: [code]1[/code].
+ /// <para>Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1. Default value: <c>1</c>.</para>
/// </summary>
public float Dry
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// If [code]true[/code], [code]tap1[/code] will be enabled. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, <c>tap1</c> will be enabled. Default value: <c>true</c>.</para>
/// </summary>
public bool Tap1__active
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// [b]Tap1[/b] delay time in milliseconds. Default value: [code]250ms[/code].
+ /// <para>Tap1 delay time in milliseconds. Default value: <c>250ms</c>.</para>
/// </summary>
public float Tap1__delayMs
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code].
+ /// <para>Sound level for <c>tap1</c>. Default value: <c>-6 dB</c>.</para>
/// </summary>
public float Tap1__levelDb
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// Pan position for [code]tap1[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]0.2[/code].
+ /// <para>Pan position for <c>tap1</c>. Value can range from -1 (fully left) to 1 (fully right). Default value: <c>0.2</c>.</para>
/// </summary>
public float Tap1__pan
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// If [code]true[/code], [code]tap2[/code] will be enabled. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, <c>tap2</c> will be enabled. Default value: <c>true</c>.</para>
/// </summary>
public bool Tap2__active
{
@@ -101,7 +102,7 @@
}
/// <summary>
- /// [b]Tap2[/b] delay time in milliseconds. Default value: [code]500ms[/code].
+ /// <para>Tap2 delay time in milliseconds. Default value: <c>500ms</c>.</para>
/// </summary>
public float Tap2__delayMs
{
@@ -116,7 +117,7 @@
}
/// <summary>
- /// Sound level for [code]tap2[/code]. Default value: [code]-12 dB[/code].
+ /// <para>Sound level for <c>tap2</c>. Default value: <c>-12 dB</c>.</para>
/// </summary>
public float Tap2__levelDb
{
@@ -131,7 +132,7 @@
}
/// <summary>
- /// Pan position for [code]tap2[/code]. Value can range from -1 (fully left) to 1 (fully right). Default value: [code]-0.4[/code].
+ /// <para>Pan position for <c>tap2</c>. Value can range from -1 (fully left) to 1 (fully right). Default value: <c>-0.4</c>.</para>
/// </summary>
public float Tap2__pan
{
@@ -146,7 +147,7 @@
}
/// <summary>
- /// If [code]true[/code], feedback is enabled. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, feedback is enabled. Default value: <c>false</c>.</para>
/// </summary>
public bool Feedback__active
{
@@ -161,7 +162,7 @@
}
/// <summary>
- /// Feedback delay time in milliseconds. Default value: [code]340[/code].
+ /// <para>Feedback delay time in milliseconds. Default value: <c>340</c>.</para>
/// </summary>
public float Feedback__delayMs
{
@@ -176,7 +177,7 @@
}
/// <summary>
- /// Sound level for [code]tap1[/code]. Default value: [code]-6 dB[/code].
+ /// <para>Sound level for <c>tap1</c>. Default value: <c>-6 dB</c>.</para>
/// </summary>
public float Feedback__levelDb
{
@@ -191,7 +192,7 @@
}
/// <summary>
- /// Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: [code]16000[/code].
+ /// <para>Low-pass filter for feedback. Frequencies below the Low Cut value are filtered out of the source signal. Default value: <c>16000</c>.</para>
/// </summary>
public float Feedback__lowpass
{
@@ -452,3 +453,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectDistortion.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectDistortion.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectDistortion.cs 2019-03-20 21:16:54.541253800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectDistortion.cs 2019-03-23 19:57:07.798112100 +0100
@@ -2,19 +2,20 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape.
- /// By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.
+ /// <para>Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape.</para>
+ /// <para>By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently.</para>
/// </summary>
public partial class AudioEffectDistortion : AudioEffect
{
public enum ModeEnum
{
/// <summary>
- /// Digital distortion effect which cuts off peaks at the top and bottom of the waveform.
+ /// <para>Digital distortion effect which cuts off peaks at the top and bottom of the waveform.</para>
/// </summary>
Clip = 0,
/// <summary>
@@ -22,21 +23,21 @@
/// </summary>
Atan = 1,
/// <summary>
- /// Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices.
+ /// <para>Low-resolution digital distortion effect. You can use it to emulate the sound of early digital audio devices.</para>
/// </summary>
Lofi = 2,
/// <summary>
- /// Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers.
+ /// <para>Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers.</para>
/// </summary>
Overdrive = 3,
/// <summary>
- /// Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.
+ /// <para>Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound.</para>
/// </summary>
Waveshape = 4
}
/// <summary>
- /// Distortion type. Default value: [code]MODE_CLIP[/code].
+ /// <para>Distortion type. Default value: <c>MODE_CLIP</c>.</para>
/// </summary>
public AudioEffectDistortion.ModeEnum Mode
{
@@ -51,7 +52,7 @@
}
/// <summary>
- /// Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: [code]0[/code].
+ /// <para>Increases or decreases the volume before the effect. Value can range from -60 to 60. Default value: <c>0</c>.</para>
/// </summary>
public float PreGain
{
@@ -66,7 +67,7 @@
}
/// <summary>
- /// High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: [code]16000[/code].
+ /// <para>High-pass filter. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000. Default value: <c>16000</c>.</para>
/// </summary>
public float KeepHfHz
{
@@ -81,7 +82,7 @@
}
/// <summary>
- /// Distortion power. Value can range from 0 to 1. Default value: [code]0[/code].
+ /// <para>Distortion power. Value can range from 0 to 1. Default value: <c>0</c>.</para>
/// </summary>
public float Drive
{
@@ -96,7 +97,7 @@
}
/// <summary>
- /// Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: [code]0[/code].
+ /// <para>Increases or decreases the volume after the effect. Value can range from -80 to 24. Default value: <c>0</c>.</para>
/// </summary>
public float PostGain
{
@@ -213,3 +214,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ.cs 2019-03-20 21:16:54.543252900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ.cs 2019-03-23 19:57:07.801110600 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged).
+ /// <para>AudioEffectEQ gives you control over frequencies. Use it to compensate for existing deficiencies in audio. AudioEffectEQ are very useful on the Master Bus to completely master a mix and give it character. They are also very useful when a game is run on a mobile device, to adjust the mix to that kind of speakers (it can be added but disabled when headphones are plugged).</para>
/// </summary>
public partial class AudioEffectEQ : AudioEffect
{
@@ -24,7 +25,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_band_gain_db");
/// <summary>
- /// Sets band's gain at the specified index, in dB.
+ /// <para>Sets band's gain at the specified index, in dB.</para>
/// </summary>
[GodotMethod("set_band_gain_db")]
public void SetBandGainDb(int bandIdx, float volumeDb)
@@ -36,7 +37,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_band_gain_db");
/// <summary>
- /// Returns the band's gain at the specified index, in dB.
+ /// <para>Returns the band's gain at the specified index, in dB.</para>
/// </summary>
[GodotMethod("get_band_gain_db")]
public float GetBandGainDb(int bandIdx)
@@ -48,7 +49,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_band_count");
/// <summary>
- /// Returns the number of bands of the equalizer.
+ /// <para>Returns the number of bands of the equalizer.</para>
/// </summary>
[GodotMethod("get_band_count")]
public int GetBandCount()
@@ -59,3 +60,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ10.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ10.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ10.cs 2019-03-20 21:16:54.546251800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ10.cs 2019-03-23 19:57:07.803110300 +0100
@@ -2,22 +2,23 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Frequency bands :
- /// Band 1 : 31 Hz
- /// Band 2 : 62 Hz
- /// Band 3 : 125 Hz
- /// Band 4 : 250 Hz
- /// Band 5 : 500 Hz
- /// Band 6 : 1000 Hz
- /// Band 7 : 2000 Hz
- /// Band 8 : 4000 Hz
- /// Band 9 : 8000 Hz
- /// Band 10 : 16000 Hz
- /// See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ21].
+ /// <para>Frequency bands :</para>
+ /// <para>Band 1 : 31 Hz</para>
+ /// <para>Band 2 : 62 Hz</para>
+ /// <para>Band 3 : 125 Hz</para>
+ /// <para>Band 4 : 250 Hz</para>
+ /// <para>Band 5 : 500 Hz</para>
+ /// <para>Band 6 : 1000 Hz</para>
+ /// <para>Band 7 : 2000 Hz</para>
+ /// <para>Band 8 : 4000 Hz</para>
+ /// <para>Band 9 : 8000 Hz</para>
+ /// <para>Band 10 : 16000 Hz</para>
+ /// <para>See also <see cref="Godot.AudioEffectEQ"/>, <see cref="Godot.AudioEffectEQ6"/>, <see cref="Godot.AudioEffectEQ21"/>.</para>
/// </summary>
public partial class AudioEffectEQ10 : AudioEffectEQ
{
@@ -34,3 +35,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ21.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ21.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ21.cs 2019-03-20 21:16:54.549251100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ21.cs 2019-03-23 19:57:07.805109400 +0100
@@ -2,33 +2,34 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Frequency bands :
- /// Band 1 : 22 Hz
- /// Band 2 : 32 Hz
- /// Band 3 : 44 Hz
- /// Band 4 : 63 Hz
- /// Band 5 : 90 Hz
- /// Band 6 : 125 Hz
- /// Band 7 : 175 Hz
- /// Band 8 : 250 Hz
- /// Band 9 : 350 Hz
- /// Band 10 : 500 Hz
- /// Band 11 : 700 Hz
- /// Band 12 : 1000 Hz
- /// Band 13 : 1400 Hz
- /// Band 14 : 2000 Hz
- /// Band 15 : 2800 Hz
- /// Band 16 : 4000 Hz
- /// Band 17 : 5600 Hz
- /// Band 18 : 8000 Hz
- /// Band 19 : 11000 Hz
- /// Band 20 : 16000 Hz
- /// Band 21 : 22000 Hz
- /// See also [AudioEffectEQ], [AudioEffectEQ6], [AudioEffectEQ10].
+ /// <para>Frequency bands :</para>
+ /// <para>Band 1 : 22 Hz</para>
+ /// <para>Band 2 : 32 Hz</para>
+ /// <para>Band 3 : 44 Hz</para>
+ /// <para>Band 4 : 63 Hz</para>
+ /// <para>Band 5 : 90 Hz</para>
+ /// <para>Band 6 : 125 Hz</para>
+ /// <para>Band 7 : 175 Hz</para>
+ /// <para>Band 8 : 250 Hz</para>
+ /// <para>Band 9 : 350 Hz</para>
+ /// <para>Band 10 : 500 Hz</para>
+ /// <para>Band 11 : 700 Hz</para>
+ /// <para>Band 12 : 1000 Hz</para>
+ /// <para>Band 13 : 1400 Hz</para>
+ /// <para>Band 14 : 2000 Hz</para>
+ /// <para>Band 15 : 2800 Hz</para>
+ /// <para>Band 16 : 4000 Hz</para>
+ /// <para>Band 17 : 5600 Hz</para>
+ /// <para>Band 18 : 8000 Hz</para>
+ /// <para>Band 19 : 11000 Hz</para>
+ /// <para>Band 20 : 16000 Hz</para>
+ /// <para>Band 21 : 22000 Hz</para>
+ /// <para>See also <see cref="Godot.AudioEffectEQ"/>, <see cref="Godot.AudioEffectEQ6"/>, <see cref="Godot.AudioEffectEQ10"/>.</para>
/// </summary>
public partial class AudioEffectEQ21 : AudioEffectEQ
{
@@ -45,3 +46,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ6.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ6.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectEQ6.cs 2019-03-20 21:16:54.551250600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectEQ6.cs 2019-03-23 19:57:07.807108300 +0100
@@ -2,18 +2,19 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Frequency bands :
- /// Band 1 : 32 Hz
- /// Band 2 : 100 Hz
- /// Band 3 : 320 Hz
- /// Band 4 : 1000 Hz
- /// Band 5 : 3200 Hz
- /// Band 6 : 10000 Hz
- /// See also [AudioEffectEQ], [AudioEffectEQ10], [AudioEffectEQ21].
+ /// <para>Frequency bands :</para>
+ /// <para>Band 1 : 32 Hz</para>
+ /// <para>Band 2 : 100 Hz</para>
+ /// <para>Band 3 : 320 Hz</para>
+ /// <para>Band 4 : 1000 Hz</para>
+ /// <para>Band 5 : 3200 Hz</para>
+ /// <para>Band 6 : 10000 Hz</para>
+ /// <para>See also <see cref="Godot.AudioEffectEQ"/>, <see cref="Godot.AudioEffectEQ10"/>, <see cref="Godot.AudioEffectEQ21"/>.</para>
/// </summary>
public partial class AudioEffectEQ6 : AudioEffectEQ
{
@@ -30,3 +31,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectFilter.cs 2019-03-20 21:16:54.554249200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectFilter.cs 2019-03-23 19:57:07.811107700 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Allows frequencies other than the [member cutoff_hz] to pass.
+ /// <para>Allows frequencies other than the <see cref="Godot.AudioEffectFilter.CutoffHz"/> to pass.</para>
/// </summary>
public partial class AudioEffectFilter : AudioEffect
{
@@ -31,7 +32,7 @@
}
/// <summary>
- /// Threshold frequency for the filter.
+ /// <para>Threshold frequency for the filter.</para>
/// </summary>
public float CutoffHz
{
@@ -46,7 +47,7 @@
}
/// <summary>
- /// Amount of boost in the overtones near the cutoff frequency.
+ /// <para>Amount of boost in the overtones near the cutoff frequency.</para>
/// </summary>
public float Resonance
{
@@ -61,7 +62,7 @@
}
/// <summary>
- /// Gain amount of the frequencies after the filter.
+ /// <para>Gain amount of the frequencies after the filter.</para>
/// </summary>
public float Gain
{
@@ -175,3 +176,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectHighPassFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectHighPassFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectHighPassFilter.cs 2019-03-20 21:16:54.557248800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectHighPassFilter.cs 2019-03-23 19:57:07.813106800 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Cuts frequencies lower than the [member AudioEffectFilter.cutoff_hz] and allows higher frequencies to pass.
+ /// <para>Cuts frequencies lower than the <see cref="Godot.AudioEffectFilter.CutoffHz"/> and allows higher frequencies to pass.</para>
/// </summary>
public partial class AudioEffectHighPassFilter : AudioEffectFilter
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectHighShelfFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectHighShelfFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectHighShelfFilter.cs 2019-03-20 21:16:54.559248000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectHighShelfFilter.cs 2019-03-23 19:57:07.816106900 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectLimiter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectLimiter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectLimiter.cs 2019-03-20 21:16:54.562246700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectLimiter.cs 2019-03-23 19:57:07.820104000 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master Bus is always recommended to reduce the effects of clipping.
- /// Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.
+ /// <para>A limiter is similar to a compressor, but it's less flexible and designed to disallow sound going over a given dB threshold. Adding one in the Master Bus is always recommended to reduce the effects of clipping.</para>
+ /// <para>Soft clipping starts to reduce the peaks a little below the threshold level and progressively increases its effect as the input level increases such that the threshold is never exceeded.</para>
/// </summary>
public partial class AudioEffectLimiter : AudioEffect
{
/// <summary>
- /// The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: [code]-0.1dB[/code].
+ /// <para>The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: <c>-0.1dB</c>.</para>
/// </summary>
public float CeilingDb
{
@@ -27,7 +28,7 @@
}
/// <summary>
- /// Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: [code]0dB[/code].
+ /// <para>Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: <c>0dB</c>.</para>
/// </summary>
public float ThresholdDb
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// Applies a gain to the limited waves. Value can range from 0 to 6. Default value: [code]2dB[/code].
+ /// <para>Applies a gain to the limited waves. Value can range from 0 to 6. Default value: <c>2dB</c>.</para>
/// </summary>
public float SoftClipDb
{
@@ -156,3 +157,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectLowPassFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectLowPassFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectLowPassFilter.cs 2019-03-20 21:16:54.565246000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectLowPassFilter.cs 2019-03-23 19:57:07.822103300 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Cuts frequencies higher than the [member AudioEffectFilter.cutoff_hz] and allows lower frequencies to pass.
+ /// <para>Cuts frequencies higher than the <see cref="Godot.AudioEffectFilter.CutoffHz"/> and allows lower frequencies to pass.</para>
/// </summary>
public partial class AudioEffectLowPassFilter : AudioEffectFilter
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectLowShelfFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectLowShelfFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectLowShelfFilter.cs 2019-03-20 21:16:54.567245300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectLowShelfFilter.cs 2019-03-23 19:57:07.824102200 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectNotchFilter.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectNotchFilter.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectNotchFilter.cs 2019-03-20 21:16:54.570243500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectNotchFilter.cs 2019-03-23 19:57:07.827102200 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Attenuates frequencies in a narrow band around the [member AudioEffectFilter.cutoff_hz] and cuts frequencies outside of this range.
+ /// <para>Attenuates frequencies in a narrow band around the <see cref="Godot.AudioEffectFilter.CutoffHz"/> and cuts frequencies outside of this range.</para>
/// </summary>
public partial class AudioEffectNotchFilter : AudioEffectFilter
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectPanner.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectPanner.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectPanner.cs 2019-03-20 21:16:54.572242900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectPanner.cs 2019-03-23 19:57:07.829101400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Determines how much of an audio signal is sent to the left and right buses.
+ /// <para>Determines how much of an audio signal is sent to the left and right buses.</para>
/// </summary>
public partial class AudioEffectPanner : AudioEffect
{
/// <summary>
- /// Pan position. Value can range from -1 (fully left) to 1 (fully right).
+ /// <para>Pan position. Value can range from -1 (fully left) to 1 (fully right).</para>
/// </summary>
public float Pan
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectPhaser.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectPhaser.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectPhaser.cs 2019-03-20 21:16:54.576242200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectPhaser.cs 2019-03-23 19:57:07.832100400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator.
+ /// <para>Combines phase-shifted signals with the original signal. The movement of the phase-shifted signals is controlled using a Low Frequency Oscillator.</para>
/// </summary>
public partial class AudioEffectPhaser : AudioEffect
{
/// <summary>
- /// Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: [code]440hz[/code].
+ /// <para>Determines the minimum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: <c>440hz</c>.</para>
/// </summary>
public float RangeMinHz
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: [code]1600hz[/code].
+ /// <para>Determines the maximum frequency affected by the LFO modulations. Value can range from 10 to 10000. Default value: <c>1600hz</c>.</para>
/// </summary>
public float RangeMaxHz
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Adjusts the rate at which the effect sweeps up and down across the frequency range.
+ /// <para>Adjusts the rate at which the effect sweeps up and down across the frequency range.</para>
/// </summary>
public float RateHz
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: [code]0.7[/code].
+ /// <para>Output percent of modified sound. Value can range from 0.1 to 0.9. Default value: <c>0.7</c>.</para>
/// </summary>
public float Feedback
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: [code]1[/code].
+ /// <para>Governs how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from 0.1 to 4. Default value: <c>1</c>.</para>
/// </summary>
public float Depth
{
@@ -188,3 +189,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectPitchShift.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectPitchShift.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectPitchShift.cs 2019-03-20 21:16:54.578241600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectPitchShift.cs 2019-03-23 19:57:07.835099100 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.
+ /// <para>Allows modulation of pitch independently of tempo. All frequencies can be increased/decreased with minimal effect on transients.</para>
/// </summary>
public partial class AudioEffectPitchShift : AudioEffect
{
/// <summary>
- /// Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).
+ /// <para>Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves).</para>
/// </summary>
public float PitchScale
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectRecord.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectRecord.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectRecord.cs 2019-03-20 21:16:54.580240700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectRecord.cs 2019-03-23 19:57:07.838098500 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -89,3 +90,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectReverb.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectReverb.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectReverb.cs 2019-03-20 21:16:54.585238600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectReverb.cs 2019-03-23 19:57:07.842097000 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.
+ /// <para>Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room.</para>
/// </summary>
public partial class AudioEffectReverb : AudioEffect
{
/// <summary>
- /// Time between the original signal and the early reflections of the reverb signal. Default value: [code]150ms[/code].
+ /// <para>Time between the original signal and the early reflections of the reverb signal. Default value: <c>150ms</c>.</para>
/// </summary>
public float PredelayMsec
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Output percent of predelay. Value can range from 0 to 1. Default value: [code]1[/code].
+ /// <para>Output percent of predelay. Value can range from 0 to 1. Default value: <c>1</c>.</para>
/// </summary>
public float PredelayFeedback
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: [code]0.8[/code].
+ /// <para>Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. Default value: <c>0.8</c>.</para>
/// </summary>
public float RoomSize
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: [code]1[/code].
+ /// <para>Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. Default value: <c>1</c>.</para>
/// </summary>
public float Damping
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: [code]1[/code].
+ /// <para>Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. Default value: <c>1</c>.</para>
/// </summary>
public float Spread
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: [code]0[/code].
+ /// <para>High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. Default value: <c>0</c>.</para>
/// </summary>
public float Hipass
{
@@ -101,7 +102,7 @@
}
/// <summary>
- /// Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: [code]1[/code].
+ /// <para>Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. Default value: <c>1</c>.</para>
/// </summary>
public float Dry
{
@@ -116,7 +117,7 @@
}
/// <summary>
- /// Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: [code]0.5[/code].
+ /// <para>Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. Default value: <c>0.5</c>.</para>
/// </summary>
public float Wet
{
@@ -287,3 +288,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioEffectStereoEnhance.cs GodotSharp_after/GodotSharp/ObjectType/AudioEffectStereoEnhance.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioEffectStereoEnhance.cs 2019-03-20 21:16:54.588238400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioEffectStereoEnhance.cs 2019-03-23 19:57:07.845095700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -119,3 +120,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioServer.cs GodotSharp_after/GodotSharp/ObjectType/AudioServer.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioServer.cs 2019-03-20 21:16:54.595235900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioServer.cs 2019-03-23 19:57:07.853093100 +0100
@@ -2,18 +2,19 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.
+ /// <para>AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.</para>
/// </summary>
public static partial class AudioServer
{
public enum SpeakerMode
{
/// <summary>
- /// Two or fewer speakers are detected.
+ /// <para>Two or fewer speakers are detected.</para>
/// </summary>
ModeStereo = 0,
/// <summary>
@@ -21,11 +22,11 @@
/// </summary>
Surround31 = 1,
/// <summary>
- /// A 5.1 channel surround setup detected.
+ /// <para>A 5.1 channel surround setup detected.</para>
/// </summary>
Surround51 = 2,
/// <summary>
- /// A 7.1 channel surround setup detected.
+ /// <para>A 7.1 channel surround setup detected.</para>
/// </summary>
Surround71 = 3
}
@@ -49,7 +50,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_count");
/// <summary>
- /// Adds and removes buses to make the number of buses match [code]amount[/code].
+ /// <para>Adds and removes buses to make the number of buses match <c>amount</c>.</para>
/// </summary>
[GodotMethod("set_bus_count")]
public static void SetBusCount(int amount)
@@ -61,7 +62,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_count");
/// <summary>
- /// Returns the number of available buses.
+ /// <para>Returns the number of available buses.</para>
/// </summary>
[GodotMethod("get_bus_count")]
public static int GetBusCount()
@@ -73,7 +74,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_bus");
/// <summary>
- /// Removes the bus at index [code]index[/code].
+ /// <para>Removes the bus at index <c>index</c>.</para>
/// </summary>
[GodotMethod("remove_bus")]
public static void RemoveBus(int index)
@@ -85,7 +86,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_bus");
/// <summary>
- /// Adds a bus at [code]at_position[/code].
+ /// <para>Adds a bus at <c>at_position</c>.</para>
/// </summary>
[GodotMethod("add_bus")]
public static void AddBus(int atPosition = -1)
@@ -97,7 +98,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "move_bus");
/// <summary>
- /// Moves the bus from index [code]index[/code] to index [code]to_index[/code].
+ /// <para>Moves the bus from index <c>index</c> to index <c>to_index</c>.</para>
/// </summary>
[GodotMethod("move_bus")]
public static void MoveBus(int index, int toIndex)
@@ -109,7 +110,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_name");
/// <summary>
- /// Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code].
+ /// <para>Sets the name of the bus at index <c>bus_idx</c> to <c>name</c>.</para>
/// </summary>
[GodotMethod("set_bus_name")]
public static void SetBusName(int busIdx, string name)
@@ -121,7 +122,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_name");
/// <summary>
- /// Returns the name of the bus with the index [code]bus_idx[/code].
+ /// <para>Returns the name of the bus with the index <c>bus_idx</c>.</para>
/// </summary>
[GodotMethod("get_bus_name")]
public static string GetBusName(int busIdx)
@@ -133,7 +134,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_index");
/// <summary>
- /// Returns the index of the bus with the name [code]bus_name[/code].
+ /// <para>Returns the index of the bus with the name <c>bus_name</c>.</para>
/// </summary>
[GodotMethod("get_bus_index")]
public static int GetBusIndex(string busName)
@@ -145,7 +146,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_channels");
/// <summary>
- /// Returns the amount of channels of the bus at index [code]bus_idx[/code].
+ /// <para>Returns the amount of channels of the bus at index <c>bus_idx</c>.</para>
/// </summary>
[GodotMethod("get_bus_channels")]
public static int GetBusChannels(int busIdx)
@@ -157,7 +158,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_volume_db");
/// <summary>
- /// Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code].
+ /// <para>Sets the volume of the bus at index <c>bus_idx</c> to <c>volume_db</c>.</para>
/// </summary>
[GodotMethod("set_bus_volume_db")]
public static void SetBusVolumeDb(int busIdx, float volumeDb)
@@ -169,7 +170,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_volume_db");
/// <summary>
- /// Returns the volume of the bus at index [code]bus_idx[/code] in dB.
+ /// <para>Returns the volume of the bus at index <c>bus_idx</c> in dB.</para>
/// </summary>
[GodotMethod("get_bus_volume_db")]
public static float GetBusVolumeDb(int busIdx)
@@ -181,7 +182,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_send");
/// <summary>
- /// Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code].
+ /// <para>Connects the output of the bus at <c>bus_idx</c> to the bus named <c>send</c>.</para>
/// </summary>
[GodotMethod("set_bus_send")]
public static void SetBusSend(int busIdx, string send)
@@ -193,7 +194,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_send");
/// <summary>
- /// Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to.
+ /// <para>Returns the name of the bus that the bus at index <c>bus_idx</c> sends to.</para>
/// </summary>
[GodotMethod("get_bus_send")]
public static string GetBusSend(int busIdx)
@@ -205,7 +206,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_solo");
/// <summary>
- /// If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode.
+ /// <para>If <c>true</c>, the bus at index <c>bus_idx</c> is in solo mode.</para>
/// </summary>
[GodotMethod("set_bus_solo")]
public static void SetBusSolo(int busIdx, bool enable)
@@ -217,7 +218,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_bus_solo");
/// <summary>
- /// If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode.
+ /// <para>If <c>true</c>, the bus at index <c>bus_idx</c> is in solo mode.</para>
/// </summary>
[GodotMethod("is_bus_solo")]
public static bool IsBusSolo(int busIdx)
@@ -229,7 +230,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_mute");
/// <summary>
- /// If [code]true[/code], the bus at index [code]bus_idx[/code] is muted.
+ /// <para>If <c>true</c>, the bus at index <c>bus_idx</c> is muted.</para>
/// </summary>
[GodotMethod("set_bus_mute")]
public static void SetBusMute(int busIdx, bool enable)
@@ -241,7 +242,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_bus_mute");
/// <summary>
- /// If [code]true[/code], the bus at index [code]bus_idx[/code] is muted.
+ /// <para>If <c>true</c>, the bus at index <c>bus_idx</c> is muted.</para>
/// </summary>
[GodotMethod("is_bus_mute")]
public static bool IsBusMute(int busIdx)
@@ -253,7 +254,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_bypass_effects");
/// <summary>
- /// If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
+ /// <para>If <c>true</c>, the bus at index <c>bus_idx</c> is bypassing effects.</para>
/// </summary>
[GodotMethod("set_bus_bypass_effects")]
public static void SetBusBypassEffects(int busIdx, bool enable)
@@ -265,7 +266,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_bus_bypassing_effects");
/// <summary>
- /// If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
+ /// <para>If <c>true</c>, the bus at index <c>bus_idx</c> is bypassing effects.</para>
/// </summary>
[GodotMethod("is_bus_bypassing_effects")]
public static bool IsBusBypassingEffects(int busIdx)
@@ -277,7 +278,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_bus_effect");
/// <summary>
- /// Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code].
+ /// <para>Adds an <see cref="Godot.AudioEffect"/> effect to the bus <c>bus_idx</c> at <c>at_position</c>.</para>
/// </summary>
[GodotMethod("add_bus_effect")]
public static void AddBusEffect(int busIdx, AudioEffect effect, int atPosition = -1)
@@ -289,7 +290,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_bus_effect");
/// <summary>
- /// Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code].
+ /// <para>Removes the effect at index <c>effect_idx</c> from the bus at index <c>bus_idx</c>.</para>
/// </summary>
[GodotMethod("remove_bus_effect")]
public static void RemoveBusEffect(int busIdx, int effectIdx)
@@ -301,7 +302,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_effect_count");
/// <summary>
- /// Returns the number of effects on the bus at [code]bus_idx[/code].
+ /// <para>Returns the number of effects on the bus at <c>bus_idx</c>.</para>
/// </summary>
[GodotMethod("get_bus_effect_count")]
public static int GetBusEffectCount(int busIdx)
@@ -313,7 +314,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_effect");
/// <summary>
- /// Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code].
+ /// <para>Returns the <see cref="Godot.AudioEffect"/> at position <c>effect_idx</c> in bus <c>bus_idx</c>.</para>
/// </summary>
[GodotMethod("get_bus_effect")]
public static AudioEffect GetBusEffect(int busIdx, int effectIdx)
@@ -325,7 +326,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "swap_bus_effects");
/// <summary>
- /// Swaps the position of two effects in bus [code]bus_idx[/code].
+ /// <para>Swaps the position of two effects in bus <c>bus_idx</c>.</para>
/// </summary>
[GodotMethod("swap_bus_effects")]
public static void SwapBusEffects(int busIdx, int effectIdx, int byEffectIdx)
@@ -337,7 +338,7 @@
private static IntPtr method_bind_24 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_effect_enabled");
/// <summary>
- /// If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled.
+ /// <para>If <c>true</c>, the effect at index <c>effect_idx</c> on the bus at index <c>bus_idx</c> is enabled.</para>
/// </summary>
[GodotMethod("set_bus_effect_enabled")]
public static void SetBusEffectEnabled(int busIdx, int effectIdx, bool enabled)
@@ -349,7 +350,7 @@
private static IntPtr method_bind_25 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_bus_effect_enabled");
/// <summary>
- /// If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled.
+ /// <para>If <c>true</c>, the effect at index <c>effect_idx</c> on the bus at index <c>bus_idx</c> is enabled.</para>
/// </summary>
[GodotMethod("is_bus_effect_enabled")]
public static bool IsBusEffectEnabled(int busIdx, int effectIdx)
@@ -361,7 +362,7 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_peak_volume_left_db");
/// <summary>
- /// Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code].
+ /// <para>Returns the peak volume of the left speaker at bus index <c>bus_idx</c> and channel index <c>channel</c>.</para>
/// </summary>
[GodotMethod("get_bus_peak_volume_left_db")]
public static float GetBusPeakVolumeLeftDb(int busIdx, int channel)
@@ -373,7 +374,7 @@
private static IntPtr method_bind_27 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bus_peak_volume_right_db");
/// <summary>
- /// Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code].
+ /// <para>Returns the peak volume of the right speaker at bus index <c>bus_idx</c> and channel index <c>channel</c>.</para>
/// </summary>
[GodotMethod("get_bus_peak_volume_right_db")]
public static float GetBusPeakVolumeRightDb(int busIdx, int channel)
@@ -385,7 +386,7 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "lock");
/// <summary>
- /// Locks the audio drivers mainloop. Remember to unlock it afterwards.
+ /// <para>Locks the audio drivers mainloop. Remember to unlock it afterwards.</para>
/// </summary>
[GodotMethod("lock")]
public static void Lock()
@@ -397,7 +398,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "unlock");
/// <summary>
- /// Unlocks the audiodriver's main loop. After locking it always unlock it.
+ /// <para>Unlocks the audiodriver's main loop. After locking it always unlock it.</para>
/// </summary>
[GodotMethod("unlock")]
public static void Unlock()
@@ -409,7 +410,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_speaker_mode");
/// <summary>
- /// Returns the speaker configuration.
+ /// <para>Returns the speaker configuration.</para>
/// </summary>
[GodotMethod("get_speaker_mode")]
public static AudioServer.SpeakerMode GetSpeakerMode()
@@ -421,7 +422,7 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_mix_rate");
/// <summary>
- /// Returns the sample rate at the output of the audioserver.
+ /// <para>Returns the sample rate at the output of the audioserver.</para>
/// </summary>
[GodotMethod("get_mix_rate")]
public static float GetMixRate()
@@ -505,7 +506,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bus_layout");
/// <summary>
- /// Overwrites the currently used [AudioBusLayout].
+ /// <para>Overwrites the currently used <see cref="Godot.AudioBusLayout"/>.</para>
/// </summary>
[GodotMethod("set_bus_layout")]
public static void SetBusLayout(AudioBusLayout busLayout)
@@ -517,7 +518,7 @@
private static IntPtr method_bind_39 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "generate_bus_layout");
/// <summary>
- /// Generates an [AudioBusLayout] using the available buses and effects.
+ /// <para>Generates an <see cref="Godot.AudioBusLayout"/> using the available buses and effects.</para>
/// </summary>
[GodotMethod("generate_bus_layout")]
public static AudioBusLayout GenerateBusLayout()
@@ -528,3 +529,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStream.cs GodotSharp_after/GodotSharp/ObjectType/AudioStream.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStream.cs 2019-03-20 21:16:54.598235100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStream.cs 2019-03-23 19:57:07.856092100 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via [AudioStreamSample]) and OGG (via [AudioStreamOGGVorbis]) file formats.
+ /// <para>Base class for audio streams. Audio streams are used for sound effects and music playback, and support WAV (via <see cref="Godot.AudioStreamSample"/>) and OGG (via <see cref="Godot.AudioStreamOGGVorbis"/>) file formats.</para>
/// </summary>
public abstract partial class AudioStream : Resource
{
@@ -20,7 +21,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_length");
/// <summary>
- /// Returns the length of the audio stream in seconds.
+ /// <para>Returns the length of the audio stream in seconds.</para>
/// </summary>
[GodotMethod("get_length")]
public float GetLength()
@@ -31,3 +32,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamMicrophone.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamMicrophone.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamMicrophone.cs 2019-03-20 21:16:54.600233400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamMicrophone.cs 2019-03-23 19:57:07.858091300 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -20,3 +21,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamOGGVorbis.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamOGGVorbis.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamOGGVorbis.cs 2019-03-20 21:16:54.604233200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamOGGVorbis.cs 2019-03-23 19:57:07.861091600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// OGG Vorbis audio stream driver.
+ /// <para>OGG Vorbis audio stream driver.</para>
/// </summary>
public partial class AudioStreamOGGVorbis : AudioStream
{
/// <summary>
- /// Contains the audio data in bytes.
+ /// <para>Contains the audio data in bytes.</para>
/// </summary>
public byte[] Data
{
@@ -122,3 +123,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayback.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayback.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayback.cs 2019-03-20 21:16:54.606232700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayback.cs 2019-03-23 19:57:07.863090700 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Can play, loop, pause a scroll through Audio. See [AudioStream] and [AudioStreamOGGVorbis] for usage.
+ /// <para>Can play, loop, pause a scroll through Audio. See <see cref="Godot.AudioStream"/> and <see cref="Godot.AudioStreamOGGVorbis"/> for usage.</para>
/// </summary>
public abstract partial class AudioStreamPlayback : Reference
{
@@ -19,3 +20,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayer.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayer.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayer.cs 2019-03-20 21:16:54.610231000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayer.cs 2019-03-23 19:57:07.868087900 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Plays background audio.
+ /// <para>Plays background audio.</para>
/// </summary>
public partial class AudioStreamPlayer : Node
{
public enum MixTargetEnum
{
/// <summary>
- /// The audio will be played only on the first channel.
+ /// <para>The audio will be played only on the first channel.</para>
/// </summary>
Stereo = 0,
/// <summary>
- /// The audio will be played on all surround channels.
+ /// <para>The audio will be played on all surround channels.</para>
/// </summary>
Surround = 1,
/// <summary>
- /// The audio will be played on the second channel, which is usually the center.
+ /// <para>The audio will be played on the second channel, which is usually the center.</para>
/// </summary>
Center = 2
}
/// <summary>
- /// The [AudioStream] object to be played.
+ /// <para>The <see cref="Godot.AudioStream"/> object to be played.</para>
/// </summary>
public AudioStream Stream
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// Volume of sound, in dB.
+ /// <para>Volume of sound, in dB.</para>
/// </summary>
public float VolumeDb
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// Changes the pitch and the tempo of the audio.
+ /// <para>Changes the pitch and the tempo of the audio.</para>
/// </summary>
public float PitchScale
{
@@ -72,7 +73,7 @@
}
/// <summary>
- /// If [code]true[/code], audio is playing.
+ /// <para>If <c>true</c>, audio is playing.</para>
/// </summary>
public bool Playing
{
@@ -87,7 +88,7 @@
}
/// <summary>
- /// If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, audio plays when added to scene tree. Default value: <c>false</c>.</para>
/// </summary>
public bool Autoplay
{
@@ -117,7 +118,7 @@
}
/// <summary>
- /// If the audio configuration has more than two speakers, this sets the target channels. See [code]MIX_TARGET_*[/code] constants.
+ /// <para>If the audio configuration has more than two speakers, this sets the target channels. See <c>MIX_TARGET_*</c> constants.</para>
/// </summary>
public AudioStreamPlayer.MixTargetEnum MixTarget
{
@@ -132,7 +133,7 @@
}
/// <summary>
- /// Bus on which this audio is playing.
+ /// <para>Bus on which this audio is playing.</para>
/// </summary>
public string Bus
{
@@ -214,7 +215,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play");
/// <summary>
- /// Plays the audio from the given position 'from_position', in seconds.
+ /// <para>Plays the audio from the given position 'from_position', in seconds.</para>
/// </summary>
[GodotMethod("play")]
public void Play(float fromPosition = 0f)
@@ -226,7 +227,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "seek");
/// <summary>
- /// Sets the position from which audio will be played, in seconds.
+ /// <para>Sets the position from which audio will be played, in seconds.</para>
/// </summary>
[GodotMethod("seek")]
public void Seek(float toPosition)
@@ -238,7 +239,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "stop");
/// <summary>
- /// Stops the audio.
+ /// <para>Stops the audio.</para>
/// </summary>
[GodotMethod("stop")]
public void Stop()
@@ -259,7 +260,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_playback_position");
/// <summary>
- /// Returns the position in the [AudioStream] in seconds.
+ /// <para>Returns the position in the <see cref="Godot.AudioStream"/> in seconds.</para>
/// </summary>
[GodotMethod("get_playback_position")]
public float GetPlaybackPosition()
@@ -350,3 +351,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayer2D.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayer2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayer2D.cs 2019-03-20 21:16:54.615229300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayer2D.cs 2019-03-23 19:57:07.873086400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Plays audio that dampens with distance from screen center.
+ /// <para>Plays audio that dampens with distance from screen center.</para>
/// </summary>
public partial class AudioStreamPlayer2D : Node2D
{
/// <summary>
- /// The [AudioStream] object to be played.
+ /// <para>The <see cref="Godot.AudioStream"/> object to be played.</para>
/// </summary>
public AudioStream Stream
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Base volume without dampening.
+ /// <para>Base volume without dampening.</para>
/// </summary>
public float VolumeDb
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Changes the pitch and the tempo of the audio.
+ /// <para>Changes the pitch and the tempo of the audio.</para>
/// </summary>
public float PitchScale
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// If [code]true[/code], audio is playing.
+ /// <para>If <c>true</c>, audio is playing.</para>
/// </summary>
public bool Playing
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, audio plays when added to scene tree. Default value: <c>false</c>.</para>
/// </summary>
public bool Autoplay
{
@@ -101,7 +102,7 @@
}
/// <summary>
- /// Maximum distance from which audio is still hearable.
+ /// <para>Maximum distance from which audio is still hearable.</para>
/// </summary>
public float MaxDistance
{
@@ -116,7 +117,7 @@
}
/// <summary>
- /// Dampens audio over distance with this as an exponent.
+ /// <para>Dampens audio over distance with this as an exponent.</para>
/// </summary>
public float Attenuation
{
@@ -131,7 +132,7 @@
}
/// <summary>
- /// Bus on which this audio is playing.
+ /// <para>Bus on which this audio is playing.</para>
/// </summary>
public string Bus
{
@@ -146,7 +147,7 @@
}
/// <summary>
- /// Areas in which this sound plays.
+ /// <para>Areas in which this sound plays.</para>
/// </summary>
public int AreaMask
{
@@ -228,7 +229,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play");
/// <summary>
- /// Plays the audio from the given position 'from_position', in seconds.
+ /// <para>Plays the audio from the given position 'from_position', in seconds.</para>
/// </summary>
[GodotMethod("play")]
public void Play(float fromPosition = 0f)
@@ -240,7 +241,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "seek");
/// <summary>
- /// Sets the position from which audio will be played, in seconds.
+ /// <para>Sets the position from which audio will be played, in seconds.</para>
/// </summary>
[GodotMethod("seek")]
public void Seek(float toPosition)
@@ -252,7 +253,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "stop");
/// <summary>
- /// Stops the audio.
+ /// <para>Stops the audio.</para>
/// </summary>
[GodotMethod("stop")]
public void Stop()
@@ -273,7 +274,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_playback_position");
/// <summary>
- /// Returns the position in the [AudioStream].
+ /// <para>Returns the position in the <see cref="Godot.AudioStream"/>.</para>
/// </summary>
[GodotMethod("get_playback_position")]
public float GetPlaybackPosition()
@@ -400,3 +401,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayer3D.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayer3D.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamPlayer3D.cs 2019-03-20 21:16:54.624226700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamPlayer3D.cs 2019-03-23 19:57:07.882084300 +0100
@@ -2,26 +2,27 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space.
+ /// <para>Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space.</para>
/// </summary>
public partial class AudioStreamPlayer3D : Spatial
{
public enum AttenuationModelEnum
{
/// <summary>
- /// Linear dampening of loudness according to distance.
+ /// <para>Linear dampening of loudness according to distance.</para>
/// </summary>
InverseDistance = 0,
/// <summary>
- /// Squared dampening of loudness according to distance.
+ /// <para>Squared dampening of loudness according to distance.</para>
/// </summary>
InverseSquareDistance = 1,
/// <summary>
- /// Logarithmic dampening of loudness according to distance.
+ /// <para>Logarithmic dampening of loudness according to distance.</para>
/// </summary>
Logarithmic = 2
}
@@ -29,11 +30,11 @@
public enum OutOfRangeModeEnum
{
/// <summary>
- /// Mix this audio in, even when it's out of range.
+ /// <para>Mix this audio in, even when it's out of range.</para>
/// </summary>
Mix = 0,
/// <summary>
- /// Pause this audio when it gets out of range.
+ /// <para>Pause this audio when it gets out of range.</para>
/// </summary>
Pause = 1
}
@@ -41,21 +42,21 @@
public enum DopplerTrackingEnum
{
/// <summary>
- /// Disables doppler tracking.
+ /// <para>Disables doppler tracking.</para>
/// </summary>
Disabled = 0,
/// <summary>
- /// Executes doppler tracking in idle step.
+ /// <para>Executes doppler tracking in idle step.</para>
/// </summary>
IdleStep = 1,
/// <summary>
- /// Executes doppler tracking in physics step.
+ /// <para>Executes doppler tracking in physics step.</para>
/// </summary>
PhysicsStep = 2
}
/// <summary>
- /// The [AudioStream] object to be played.
+ /// <para>The <see cref="Godot.AudioStream"/> object to be played.</para>
/// </summary>
public AudioStream Stream
{
@@ -70,7 +71,7 @@
}
/// <summary>
- /// Decides if audio should get quieter with distance linearly, quadratically or logarithmically.
+ /// <para>Decides if audio should get quieter with distance linearly, quadratically or logarithmically.</para>
/// </summary>
public AudioStreamPlayer3D.AttenuationModelEnum AttenuationModel
{
@@ -85,7 +86,7 @@
}
/// <summary>
- /// Base sound level unaffected by dampening, in dB.
+ /// <para>Base sound level unaffected by dampening, in dB.</para>
/// </summary>
public float UnitDb
{
@@ -100,7 +101,7 @@
}
/// <summary>
- /// Factor for the attenuation effect.
+ /// <para>Factor for the attenuation effect.</para>
/// </summary>
public float UnitSize
{
@@ -115,7 +116,7 @@
}
/// <summary>
- /// Sets the absolute maximum of the soundlevel, in dB.
+ /// <para>Sets the absolute maximum of the soundlevel, in dB.</para>
/// </summary>
public float MaxDb
{
@@ -130,7 +131,7 @@
}
/// <summary>
- /// Changes the pitch and the tempo of the audio.
+ /// <para>Changes the pitch and the tempo of the audio.</para>
/// </summary>
public float PitchScale
{
@@ -145,7 +146,7 @@
}
/// <summary>
- /// If [code]true[/code], audio is playing.
+ /// <para>If <c>true</c>, audio is playing.</para>
/// </summary>
public bool Playing
{
@@ -160,7 +161,7 @@
}
/// <summary>
- /// If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, audio plays when added to scene tree. Default value: <c>false</c>.</para>
/// </summary>
public bool Autoplay
{
@@ -190,7 +191,7 @@
}
/// <summary>
- /// Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0.
+ /// <para>Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0.</para>
/// </summary>
public float MaxDistance
{
@@ -205,7 +206,7 @@
}
/// <summary>
- /// Decides if audio should pause when source is outside of 'max_distance' range.
+ /// <para>Decides if audio should pause when source is outside of 'max_distance' range.</para>
/// </summary>
public AudioStreamPlayer3D.OutOfRangeModeEnum OutOfRangeMode
{
@@ -220,7 +221,7 @@
}
/// <summary>
- /// Bus on which this audio is playing.
+ /// <para>Bus on which this audio is playing.</para>
/// </summary>
public string Bus
{
@@ -235,7 +236,7 @@
}
/// <summary>
- /// Areas in which this sound plays.
+ /// <para>Areas in which this sound plays.</para>
/// </summary>
public int AreaMask
{
@@ -250,7 +251,7 @@
}
/// <summary>
- /// If [code]true[/code], the audio should be dampened according to the direction of the sound.
+ /// <para>If <c>true</c>, the audio should be dampened according to the direction of the sound.</para>
/// </summary>
public bool EmissionAngleEnabled
{
@@ -265,7 +266,7 @@
}
/// <summary>
- /// The angle in which the audio reaches cameras undampened.
+ /// <para>The angle in which the audio reaches cameras undampened.</para>
/// </summary>
public float EmissionAngleDegrees
{
@@ -280,7 +281,7 @@
}
/// <summary>
- /// dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB.
+ /// <para>dampens audio if camera is outside of 'emission_angle_degrees' and 'emission_angle_enabled' is set by this factor, in dB.</para>
/// </summary>
public float EmissionAngleFilterAttenuationDb
{
@@ -295,7 +296,7 @@
}
/// <summary>
- /// Dampens audio above this frequency, in Hz.
+ /// <para>Dampens audio above this frequency, in Hz.</para>
/// </summary>
public float AttenuationFilterCutoffHz
{
@@ -310,7 +311,7 @@
}
/// <summary>
- /// Amount how much the filter affects the loudness, in dB.
+ /// <para>Amount how much the filter affects the loudness, in dB.</para>
/// </summary>
public float AttenuationFilterDb
{
@@ -325,7 +326,7 @@
}
/// <summary>
- /// Decides in which step the Doppler effect should be calculated.
+ /// <para>Decides in which step the Doppler effect should be calculated.</para>
/// </summary>
public AudioStreamPlayer3D.DopplerTrackingEnum DopplerTracking
{
@@ -443,7 +444,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "play");
/// <summary>
- /// Plays the audio from the given position 'from_position', in seconds.
+ /// <para>Plays the audio from the given position 'from_position', in seconds.</para>
/// </summary>
[GodotMethod("play")]
public void Play(float fromPosition = 0f)
@@ -455,7 +456,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "seek");
/// <summary>
- /// Sets the position from which audio will be played, in seconds.
+ /// <para>Sets the position from which audio will be played, in seconds.</para>
/// </summary>
[GodotMethod("seek")]
public void Seek(float toPosition)
@@ -467,7 +468,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "stop");
/// <summary>
- /// Stops the audio.
+ /// <para>Stops the audio.</para>
/// </summary>
[GodotMethod("stop")]
public void Stop()
@@ -488,7 +489,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_playback_position");
/// <summary>
- /// Returns the position in the [AudioStream].
+ /// <para>Returns the position in the <see cref="Godot.AudioStream"/>.</para>
/// </summary>
[GodotMethod("get_playback_position")]
public float GetPlaybackPosition()
@@ -741,3 +742,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamRandomPitch.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamRandomPitch.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamRandomPitch.cs 2019-03-20 21:16:54.628225500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamRandomPitch.cs 2019-03-23 19:57:07.885083000 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Randomly varies pitch on each start.
+ /// <para>Randomly varies pitch on each start.</para>
/// </summary>
public partial class AudioStreamRandomPitch : AudioStream
{
/// <summary>
- /// The current [AudioStream].
+ /// <para>The current <see cref="Godot.AudioStream"/>.</para>
/// </summary>
public AudioStream AudioStream
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The intensity of random pitch variation.
+ /// <para>The intensity of random pitch variation.</para>
/// </summary>
public float RandomPitch
{
@@ -89,3 +90,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/AudioStreamSample.cs GodotSharp_after/GodotSharp/ObjectType/AudioStreamSample.cs
--- GodotSharp_before/GodotSharp/ObjectType/AudioStreamSample.cs 2019-03-20 21:16:54.632223800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/AudioStreamSample.cs 2019-03-23 19:57:07.889081300 +0100
@@ -2,30 +2,31 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Plays audio, can loop.
+ /// <para>Plays audio, can loop.</para>
/// </summary>
public partial class AudioStreamSample : AudioStream
{
public enum LoopModeEnum
{
/// <summary>
- /// Audio does not loop.
+ /// <para>Audio does not loop.</para>
/// </summary>
Disabled = 0,
/// <summary>
- /// Audio loops the data between loop_begin and loop_end playing forward only.
+ /// <para>Audio loops the data between loop_begin and loop_end playing forward only.</para>
/// </summary>
Forward = 1,
/// <summary>
- /// Audio loops the data between loop_begin and loop_end playing back and forth.
+ /// <para>Audio loops the data between loop_begin and loop_end playing back and forth.</para>
/// </summary>
PingPong = 2,
/// <summary>
- /// Audio loops the data between loop_begin and loop_end playing backward only.
+ /// <para>Audio loops the data between loop_begin and loop_end playing backward only.</para>
/// </summary>
Backward = 3
}
@@ -33,21 +34,21 @@
public enum FormatEnum
{
/// <summary>
- /// Audio codec 8 bit.
+ /// <para>Audio codec 8 bit.</para>
/// </summary>
Format8Bits = 0,
/// <summary>
- /// Audio codec 16 bit.
+ /// <para>Audio codec 16 bit.</para>
/// </summary>
Format16Bits = 1,
/// <summary>
- /// Audio codec IMA ADPCM.
+ /// <para>Audio codec IMA ADPCM.</para>
/// </summary>
ImaAdpcm = 2
}
/// <summary>
- /// Contains the audio data in bytes.
+ /// <para>Contains the audio data in bytes.</para>
/// </summary>
public byte[] Data
{
@@ -62,7 +63,7 @@
}
/// <summary>
- /// Audio format. See FORMAT_* constants for values.
+ /// <para>Audio format. See FORMAT_* constants for values.</para>
/// </summary>
public AudioStreamSample.FormatEnum Format
{
@@ -77,7 +78,7 @@
}
/// <summary>
- /// Loop mode. See LOOP_* constants for values.
+ /// <para>Loop mode. See LOOP_* constants for values.</para>
/// </summary>
public AudioStreamSample.LoopModeEnum LoopMode
{
@@ -92,7 +93,7 @@
}
/// <summary>
- /// Loop start in bytes.
+ /// <para>Loop start in bytes.</para>
/// </summary>
public int LoopBegin
{
@@ -107,7 +108,7 @@
}
/// <summary>
- /// Loop end in bytes.
+ /// <para>Loop end in bytes.</para>
/// </summary>
public int LoopEnd
{
@@ -122,7 +123,7 @@
}
/// <summary>
- /// The sample rate for mixing this audio.
+ /// <para>The sample rate for mixing this audio.</para>
/// </summary>
public int MixRate
{
@@ -137,7 +138,7 @@
}
/// <summary>
- /// If [code]true[/code], audio is stereo. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, audio is stereo. Default value: <c>false</c>.</para>
/// </summary>
public bool Stereo
{
@@ -291,8 +292,8 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "save_to_wav");
/// <summary>
- /// Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved.
- /// Note that a [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing.
+ /// <para>Saves the AudioStreamSample as a WAV file to <c>path</c>. Samples with IMA ADPCM format can't be saved.</para>
+ /// <para>Note that a <c>.wav</c> extension is automatically appended to <c>path</c> if it is missing.</para>
/// </summary>
[GodotMethod("save_to_wav")]
public Error SaveToWav(string path)
@@ -303,3 +304,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BackBufferCopy.cs GodotSharp_after/GodotSharp/ObjectType/BackBufferCopy.cs
--- GodotSharp_before/GodotSharp/ObjectType/BackBufferCopy.cs 2019-03-20 21:16:54.635223100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BackBufferCopy.cs 2019-03-23 19:57:07.894080100 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use [code]SCREEN_TEXTURE[/code] in the [code]texture()[/code] function to access the buffer.
+ /// <para>Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Use <c>SCREEN_TEXTURE</c> in the <c>texture()</c> function to access the buffer.</para>
/// </summary>
public partial class BackBufferCopy : Node2D
{
public enum CopyModeEnum
{
/// <summary>
- /// Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.
+ /// <para>Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers.</para>
/// </summary>
Disabled = 0,
/// <summary>
- /// BackBufferCopy buffers a rectangular region.
+ /// <para>BackBufferCopy buffers a rectangular region.</para>
/// </summary>
Rect = 1,
/// <summary>
- /// BackBufferCopy buffers the entire screen.
+ /// <para>BackBufferCopy buffers the entire screen.</para>
/// </summary>
Viewport = 2
}
/// <summary>
- /// Buffer mode. See [code]COPY_MODE_*[/code] constants.
+ /// <para>Buffer mode. See <c>COPY_MODE_*</c> constants.</para>
/// </summary>
public BackBufferCopy.CopyModeEnum CopyMode
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// The area covered by the BackBufferCopy. Only used if [code]copy_mode[/code] is [code]COPY_MODE_RECT[/code].
+ /// <para>The area covered by the BackBufferCopy. Only used if <c>copy_mode</c> is <c>COPY_MODE_RECT</c>.</para>
/// </summary>
public Rect2 Rect
{
@@ -105,3 +106,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BakedLightmap.cs GodotSharp_after/GodotSharp/ObjectType/BakedLightmap.cs
--- GodotSharp_before/GodotSharp/ObjectType/BakedLightmap.cs 2019-03-20 21:16:54.657215300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BakedLightmap.cs 2019-03-23 19:57:07.899078600 +0100
@@ -2,26 +2,27 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the [GIProbe] approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.
+ /// <para>Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the <see cref="Godot.GIProbe"/> approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.</para>
/// </summary>
public partial class BakedLightmap : VisualInstance
{
public enum BakeQualityEnum
{
/// <summary>
- /// Lowest bake quality mode. Fastest to calculate.
+ /// <para>Lowest bake quality mode. Fastest to calculate.</para>
/// </summary>
Low = 0,
/// <summary>
- /// Default bake quality mode.
+ /// <para>Default bake quality mode.</para>
/// </summary>
Medium = 1,
/// <summary>
- /// Highest bake quality mode. Takes longer to calculate.
+ /// <para>Highest bake quality mode. Takes longer to calculate.</para>
/// </summary>
High = 2
}
@@ -53,17 +54,17 @@
public enum BakeModeEnum
{
/// <summary>
- /// Less precise but faster bake mode.
+ /// <para>Less precise but faster bake mode.</para>
/// </summary>
ConeTrace = 0,
/// <summary>
- /// More precise bake mode but can take considerably longer to bake.
+ /// <para>More precise bake mode but can take considerably longer to bake.</para>
/// </summary>
RayTrace = 1
}
/// <summary>
- /// Grid subdivision size for lightmapper calculation. Default value of [code]0.25[/code] will work for most cases. Increase for better lighting on small details or if your scene is very large.
+ /// <para>Grid subdivision size for lightmapper calculation. Default value of <c>0.25</c> will work for most cases. Increase for better lighting on small details or if your scene is very large.</para>
/// </summary>
public float BakeCellSize
{
@@ -78,7 +79,7 @@
}
/// <summary>
- /// Three quality modes are available. Higher quality requires more rendering time. See [enum BakeQuality].
+ /// <para>Three quality modes are available. Higher quality requires more rendering time. See <see cref="Godot.BakedLightmap.BakeQualityEnum"/>.</para>
/// </summary>
public BakedLightmap.BakeQualityEnum BakeQuality
{
@@ -93,7 +94,7 @@
}
/// <summary>
- /// Lightmapping mode. See [enum BakeMode].
+ /// <para>Lightmapping mode. See <see cref="Godot.BakedLightmap.BakeModeEnum"/>.</para>
/// </summary>
public BakedLightmap.BakeModeEnum BakeMode
{
@@ -138,7 +139,7 @@
}
/// <summary>
- /// If [code]true[/code], lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code].
+ /// <para>If <c>true</c>, lightmap can capture light values greater than <c>1.0</c>. Turning this off will result in a smaller lightmap. Default value:<c>false</c>.</para>
/// </summary>
public bool BakeHdr
{
@@ -153,7 +154,7 @@
}
/// <summary>
- /// Size of affected area.
+ /// <para>Size of affected area.</para>
/// </summary>
public Vector3 BakeExtents
{
@@ -168,7 +169,7 @@
}
/// <summary>
- /// Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size].
+ /// <para>Grid size used for real-time capture information on dynamic objects. Cannot be larger than <see cref="Godot.BakedLightmap.BakeCellSize"/>.</para>
/// </summary>
public float CaptureCellSize
{
@@ -183,7 +184,7 @@
}
/// <summary>
- /// Location where lightmaps will be saved.
+ /// <para>Location where lightmaps will be saved.</para>
/// </summary>
public string ImagePath
{
@@ -198,7 +199,7 @@
}
/// <summary>
- /// The calculated light data.
+ /// <para>The calculated light data.</para>
/// </summary>
public BakedLightmapData LightData
{
@@ -429,3 +430,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BakedLightmapData.cs GodotSharp_after/GodotSharp/ObjectType/BakedLightmapData.cs
--- GodotSharp_before/GodotSharp/ObjectType/BakedLightmapData.cs 2019-03-20 21:16:54.661213500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BakedLightmapData.cs 2019-03-23 19:57:07.904077000 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -273,3 +274,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BaseButton.cs GodotSharp_after/GodotSharp/ObjectType/BaseButton.cs
--- GodotSharp_before/GodotSharp/ObjectType/BaseButton.cs 2019-03-20 21:16:54.666212400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BaseButton.cs 2019-03-23 19:57:07.909074500 +0100
@@ -2,22 +2,23 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// BaseButton is the abstract base class for buttons, so it shouldn't be used directly (it doesn't display anything). Other types of buttons inherit from it.
+ /// <para>BaseButton is the abstract base class for buttons, so it shouldn't be used directly (it doesn't display anything). Other types of buttons inherit from it.</para>
/// </summary>
public abstract partial class BaseButton : Control
{
public enum ActionModeEnum
{
/// <summary>
- /// Require just a press to consider the button clicked.
+ /// <para>Require just a press to consider the button clicked.</para>
/// </summary>
Press = 0,
/// <summary>
- /// Require a press and a subsequent release before considering the button clicked.
+ /// <para>Require a press and a subsequent release before considering the button clicked.</para>
/// </summary>
Release = 1
}
@@ -25,19 +26,19 @@
public enum DrawMode
{
/// <summary>
- /// The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.
+ /// <para>The normal state (i.e. not pressed, not hovered, not toggled and enabled) of buttons.</para>
/// </summary>
Normal = 0,
/// <summary>
- /// The state of buttons are pressed.
+ /// <para>The state of buttons are pressed.</para>
/// </summary>
Pressed = 1,
/// <summary>
- /// The state of buttons are hovered.
+ /// <para>The state of buttons are hovered.</para>
/// </summary>
Hover = 2,
/// <summary>
- /// The state of buttons are disabled.
+ /// <para>The state of buttons are disabled.</para>
/// </summary>
Disabled = 3,
/// <summary>
@@ -47,7 +48,7 @@
}
/// <summary>
- /// If [code]true[/code], the button is in disabled state and can't be clicked or toggled.
+ /// <para>If <c>true</c>, the button is in disabled state and can't be clicked or toggled.</para>
/// </summary>
public bool Disabled
{
@@ -62,7 +63,7 @@
}
/// <summary>
- /// If [code]true[/code], the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.
+ /// <para>If <c>true</c>, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked.</para>
/// </summary>
public bool ToggleMode
{
@@ -77,7 +78,7 @@
}
/// <summary>
- /// If [code]true[/code], the button will add information about its shortcut in the tooltip.
+ /// <para>If <c>true</c>, the button will add information about its shortcut in the tooltip.</para>
/// </summary>
public bool ShortcutInTooltip
{
@@ -92,7 +93,7 @@
}
/// <summary>
- /// If [code]true[/code], the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).
+ /// <para>If <c>true</c>, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active).</para>
/// </summary>
public bool Pressed
{
@@ -107,7 +108,7 @@
}
/// <summary>
- /// Determines when the button is considered clicked, one of the ACTION_MODE_* constants.
+ /// <para>Determines when the button is considered clicked, one of the ACTION_MODE_* constants.</para>
/// </summary>
public BaseButton.ActionModeEnum ActionMode
{
@@ -122,8 +123,8 @@
}
/// <summary>
- /// Binary mask to choose which mouse buttons this button will respond to.
- /// To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.
+ /// <para>Binary mask to choose which mouse buttons this button will respond to.</para>
+ /// <para>To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.</para>
/// </summary>
public int ButtonMask
{
@@ -138,7 +139,7 @@
}
/// <summary>
- /// Focus access mode to use when switching between enabled/disabled (see [member Control.focus_mode] and [member disabled]).
+ /// <para>Focus access mode to use when switching between enabled/disabled (see <see cref="Godot.Control.FocusMode"/> and <see cref="Godot.BaseButton.Disabled"/>).</para>
/// </summary>
public Control.FocusModeEnum EnabledFocusMode
{
@@ -153,7 +154,7 @@
}
/// <summary>
- /// [ShortCut] associated to the button.
+ /// <para><see cref="Godot.ShortCut"/> associated to the button.</para>
/// </summary>
public ShortCut Shortcut
{
@@ -168,7 +169,7 @@
}
/// <summary>
- /// [ButtonGroup] associated to the button.
+ /// <para><see cref="Godot.ButtonGroup"/> associated to the button.</para>
/// </summary>
public ButtonGroup Group
{
@@ -189,7 +190,7 @@
internal BaseButton(bool memoryOwn) : base(memoryOwn) {}
/// <summary>
- /// Called when the button is pressed.
+ /// <para>Called when the button is pressed.</para>
/// </summary>
[GodotMethod("_pressed")]
public virtual void _Pressed()
@@ -198,7 +199,7 @@
}
/// <summary>
- /// Called when the button is toggled (only if toggle_mode is active).
+ /// <para>Called when the button is toggled (only if toggle_mode is active).</para>
/// </summary>
[GodotMethod("_toggled")]
public virtual void _Toggled(bool buttonPressed)
@@ -228,7 +229,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_hovered");
/// <summary>
- /// Return true if the mouse has entered the button and has not left it yet.
+ /// <para>Return true if the mouse has entered the button and has not left it yet.</para>
/// </summary>
[GodotMethod("is_hovered")]
public bool IsHovered()
@@ -330,7 +331,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_draw_mode");
/// <summary>
- /// Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum.
+ /// <para>Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum.</para>
/// </summary>
[GodotMethod("get_draw_mode")]
public BaseButton.DrawMode GetDrawMode()
@@ -395,3 +396,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BitMap.cs GodotSharp_after/GodotSharp/ObjectType/BitMap.cs
--- GodotSharp_before/GodotSharp/ObjectType/BitMap.cs 2019-03-20 21:16:54.670211400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BitMap.cs 2019-03-23 19:57:07.913073700 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates.
+ /// <para>A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates.</para>
/// </summary>
public partial class BitMap : Resource
{
@@ -36,7 +37,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "create");
/// <summary>
- /// Creates a bitmap with the specified size, filled with false.
+ /// <para>Creates a bitmap with the specified size, filled with false.</para>
/// </summary>
[GodotMethod("create")]
public void Create(Vector2 size)
@@ -48,7 +49,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "create_from_image_alpha");
/// <summary>
- /// Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and true in other case.
+ /// <para>Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to <c>threshold</c> or less, and true in other case.</para>
/// </summary>
[GodotMethod("create_from_image_alpha")]
public void CreateFromImageAlpha(Image image, float threshold = 0.1f)
@@ -60,7 +61,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bit");
/// <summary>
- /// Sets the bitmap's element at the specified position, to the specified value.
+ /// <para>Sets the bitmap's element at the specified position, to the specified value.</para>
/// </summary>
[GodotMethod("set_bit")]
public void SetBit(Vector2 position, bool bit)
@@ -72,7 +73,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_bit");
/// <summary>
- /// Returns bitmap's value at the specified position.
+ /// <para>Returns bitmap's value at the specified position.</para>
/// </summary>
[GodotMethod("get_bit")]
public bool GetBit(Vector2 position)
@@ -84,7 +85,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_bit_rect");
/// <summary>
- /// Sets a rectangular portion of the bitmap to the specified value.
+ /// <para>Sets a rectangular portion of the bitmap to the specified value.</para>
/// </summary>
[GodotMethod("set_bit_rect")]
public void SetBitRect(Rect2 rect, bool bit)
@@ -96,7 +97,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_true_bit_count");
/// <summary>
- /// Returns the amount of bitmap elements that are set to true.
+ /// <para>Returns the amount of bitmap elements that are set to true.</para>
/// </summary>
[GodotMethod("get_true_bit_count")]
public int GetTrueBitCount()
@@ -108,7 +109,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_size");
/// <summary>
- /// Returns bitmap's dimensions.
+ /// <para>Returns bitmap's dimensions.</para>
/// </summary>
[GodotMethod("get_size")]
public Vector2 GetSize()
@@ -159,3 +160,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BitmapFont.cs GodotSharp_after/GodotSharp/ObjectType/BitmapFont.cs
--- GodotSharp_before/GodotSharp/ObjectType/BitmapFont.cs 2019-03-20 21:16:54.675209100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BitmapFont.cs 2019-03-23 19:57:07.918072400 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Renders text using [code]*.fnt[/code] fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see [DynamicFont].
+ /// <para>Renders text using <c>*.fnt</c> fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see <see cref="Godot.DynamicFont"/>.</para>
/// </summary>
public partial class BitmapFont : Font
{
@@ -47,7 +48,7 @@
}
/// <summary>
- /// Total font height (ascent plus descent) in pixels.
+ /// <para>Total font height (ascent plus descent) in pixels.</para>
/// </summary>
public float Height
{
@@ -62,7 +63,7 @@
}
/// <summary>
- /// Ascent (number of pixels above the baseline).
+ /// <para>Ascent (number of pixels above the baseline).</para>
/// </summary>
public float Ascent
{
@@ -77,7 +78,7 @@
}
/// <summary>
- /// If [code]true[/code], distance field hint is enabled.
+ /// <para>If <c>true</c>, distance field hint is enabled.</para>
/// </summary>
public bool DistanceField
{
@@ -92,7 +93,7 @@
}
/// <summary>
- /// The fallback font.
+ /// <para>The fallback font.</para>
/// </summary>
public BitmapFont Fallback
{
@@ -120,7 +121,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "create_from_fnt");
/// <summary>
- /// Creates a BitmapFont from the [code]*.fnt[/code] file at [code]path[/code].
+ /// <para>Creates a BitmapFont from the <c>*.fnt</c> file at <c>path</c>.</para>
/// </summary>
[GodotMethod("create_from_fnt")]
public Error CreateFromFnt(string path)
@@ -150,7 +151,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_kerning_pair");
/// <summary>
- /// Adds a kerning pair to the [code]BitmapFont[/code] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
+ /// <para>Adds a kerning pair to the <c>BitmapFont</c> as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.</para>
/// </summary>
[GodotMethod("add_kerning_pair")]
public void AddKerningPair(int charA, int charB, int kerning)
@@ -162,7 +163,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_kerning_pair");
/// <summary>
- /// Returns a kerning pair as a difference.
+ /// <para>Returns a kerning pair as a difference.</para>
/// </summary>
[GodotMethod("get_kerning_pair")]
public int GetKerningPair(int charA, int charB)
@@ -174,7 +175,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_texture");
/// <summary>
- /// Adds a texture to the [code]BitmapFont[/code].
+ /// <para>Adds a texture to the <c>BitmapFont</c>.</para>
/// </summary>
[GodotMethod("add_texture")]
public void AddTexture(Texture texture)
@@ -186,8 +187,8 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_char");
/// <summary>
- /// Adds a character to the font, where [code]character[/code] is the unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance.
- /// &lt;param name="align"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <para>Adds a character to the font, where <c>character</c> is the unicode value, <c>texture</c> is the texture index, <c>rect</c> is the region in the texture (in pixels!), <c>align</c> is the (optional) alignment for the character and <c>advance</c> is the (optional) advance.</para>
+ /// <param name="align">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("add_char")]
public void AddChar(int character, int texture, Rect2 rect, Nullable<Vector2> align = null, float advance = (float)-1)
@@ -200,7 +201,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_texture_count");
/// <summary>
- /// Returns the number of textures in the BitmapFont atlas.
+ /// <para>Returns the number of textures in the BitmapFont atlas.</para>
/// </summary>
[GodotMethod("get_texture_count")]
public int GetTextureCount()
@@ -212,7 +213,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_texture");
/// <summary>
- /// Returns the font atlas texture at index [code]idx[/code].
+ /// <para>Returns the font atlas texture at index <c>idx</c>.</para>
/// </summary>
[GodotMethod("get_texture")]
public Texture GetTexture(int idx)
@@ -224,7 +225,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_char_size");
/// <summary>
- /// Returns the size of a character, optionally taking kerning into account if the next character is provided.
+ /// <para>Returns the size of a character, optionally taking kerning into account if the next character is provided.</para>
/// </summary>
[GodotMethod("get_char_size")]
public Vector2 GetCharSize(int @char, int next = 0)
@@ -245,7 +246,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear");
/// <summary>
- /// Clears all the font data and settings.
+ /// <para>Clears all the font data and settings.</para>
/// </summary>
[GodotMethod("clear")]
public void Clear()
@@ -322,3 +323,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Bone2D.cs GodotSharp_after/GodotSharp/ObjectType/Bone2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/Bone2D.cs 2019-03-20 21:16:54.678208800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Bone2D.cs 2019-03-23 19:57:07.921071700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -122,3 +123,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BoneAttachment.cs GodotSharp_after/GodotSharp/ObjectType/BoneAttachment.cs
--- GodotSharp_before/GodotSharp/ObjectType/BoneAttachment.cs 2019-03-20 21:16:54.680209300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BoneAttachment.cs 2019-03-23 19:57:07.923089000 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This node must be the child of a [Skeleton] node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.
+ /// <para>This node must be the child of a <see cref="Godot.Skeleton"/> node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.</para>
/// </summary>
public partial class BoneAttachment : Spatial
{
/// <summary>
- /// The name of the attached bone.
+ /// <para>The name of the attached bone.</para>
/// </summary>
public string BoneName
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BoxContainer.cs GodotSharp_after/GodotSharp/ObjectType/BoxContainer.cs
--- GodotSharp_before/GodotSharp/ObjectType/BoxContainer.cs 2019-03-20 21:16:54.683207800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BoxContainer.cs 2019-03-23 19:57:07.926069100 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.
+ /// <para>Arranges child controls vertically or horizontally, and rearranges the controls automatically when their minimum size changes.</para>
/// </summary>
public abstract partial class BoxContainer : Container
{
public enum AlignMode
{
/// <summary>
- /// Aligns children with the beginning of the container.
+ /// <para>Aligns children with the beginning of the container.</para>
/// </summary>
Begin = 0,
/// <summary>
- /// Aligns children with the center of the container.
+ /// <para>Aligns children with the center of the container.</para>
/// </summary>
Center = 1,
/// <summary>
- /// Aligns children with the end of the container.
+ /// <para>Aligns children with the end of the container.</para>
/// </summary>
End = 2
}
/// <summary>
- /// The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END).
+ /// <para>The alignment of the container's children (must be one of ALIGN_BEGIN, ALIGN_CENTER, or ALIGN_END).</para>
/// </summary>
public BoxContainer.AlignMode Alignment
{
@@ -51,7 +52,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_spacer");
/// <summary>
- /// Adds a control to the box as a spacer. If [code]true[/code], [i]begin[/i] will insert the spacer control in front of other children.
+ /// <para>Adds a control to the box as a spacer. If <c>true</c>, begin will insert the spacer control in front of other children.</para>
/// </summary>
[GodotMethod("add_spacer")]
public void AddSpacer(bool begin)
@@ -80,3 +81,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/BoxShape.cs GodotSharp_after/GodotSharp/ObjectType/BoxShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/BoxShape.cs 2019-03-20 21:16:54.686236800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/BoxShape.cs 2019-03-23 19:57:07.928068800 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// 3D box shape that can be a child of a [PhysicsBody] or [Area].
+ /// <para>3D box shape that can be a child of a <see cref="Godot.PhysicsBody"/> or <see cref="Godot.Area"/>.</para>
/// </summary>
public partial class BoxShape : Shape
{
/// <summary>
- /// The shape's half extents.
+ /// <para>The shape's half extents.</para>
/// </summary>
public Vector3 Extents
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Button.cs GodotSharp_after/GodotSharp/ObjectType/Button.cs
--- GodotSharp_before/GodotSharp/ObjectType/Button.cs 2019-03-20 21:16:54.690205100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Button.cs 2019-03-23 19:57:07.931068100 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme].
+ /// <para>Button is the standard themed button. It can contain text and an icon, and will display them according to the current <see cref="Godot.Theme"/>.</para>
/// </summary>
public partial class Button : BaseButton
{
public enum TextAlign
{
/// <summary>
- /// Align the text to the left.
+ /// <para>Align the text to the left.</para>
/// </summary>
Left = 0,
/// <summary>
- /// Align the text to the center.
+ /// <para>Align the text to the center.</para>
/// </summary>
Center = 1,
/// <summary>
- /// Align the text to the right.
+ /// <para>Align the text to the right.</para>
/// </summary>
Right = 2
}
/// <summary>
- /// The button's text that will be displayed inside the button's area.
+ /// <para>The button's text that will be displayed inside the button's area.</para>
/// </summary>
public string Text
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// Button's icon, if text is present the icon will be placed before the text.
+ /// <para>Button's icon, if text is present the icon will be placed before the text.</para>
/// </summary>
public Texture Icon
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// Flat buttons don't display decoration.
+ /// <para>Flat buttons don't display decoration.</para>
/// </summary>
public bool Flat
{
@@ -72,7 +73,7 @@
}
/// <summary>
- /// When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.
+ /// <para>When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default.</para>
/// </summary>
public bool ClipText
{
@@ -87,7 +88,7 @@
}
/// <summary>
- /// Text alignment policy for the button's text, use one of the ALIGN_* constants.
+ /// <para>Text alignment policy for the button's text, use one of the ALIGN_* constants.</para>
/// </summary>
public Button.TextAlign Align
{
@@ -204,3 +205,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ButtonGroup.cs GodotSharp_after/GodotSharp/ObjectType/ButtonGroup.cs
--- GodotSharp_before/GodotSharp/ObjectType/ButtonGroup.cs 2019-03-20 21:16:54.693203700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ButtonGroup.cs 2019-03-23 19:57:07.934066800 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.
- /// [member BaseButton.toggle_mode] should be [code]true[/code].
+ /// <para>Group of <see cref="Godot.Button"/>. All direct and indirect children buttons become radios. Only one allows being pressed.</para>
+ /// <para><see cref="Godot.BaseButton.ToggleMode"/> should be <c>true</c>.</para>
/// </summary>
public partial class ButtonGroup : Resource
{
@@ -25,7 +26,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_pressed_button");
/// <summary>
- /// Returns the current pressed button.
+ /// <para>Returns the current pressed button.</para>
/// </summary>
[GodotMethod("get_pressed_button")]
public BaseButton GetPressedButton()
@@ -37,7 +38,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_buttons");
/// <summary>
- /// Returns an [Array] of [Button]s who have this as their [code]ButtonGroup[/code] (see [member BaseButton.group]).
+ /// <para>Returns an <see cref="Godot.Collections.Array"/> of <see cref="Godot.Button"/>s who have this as their <c>ButtonGroup</c> (see <see cref="Godot.BaseButton.Group"/>).</para>
/// </summary>
[GodotMethod("get_buttons")]
public Godot.Collections.Array GetButtons()
@@ -48,3 +49,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Camera.cs GodotSharp_after/GodotSharp/ObjectType/Camera.cs
--- GodotSharp_before/GodotSharp/ObjectType/Camera.cs 2019-03-20 21:16:54.764180600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Camera.cs 2019-03-23 19:57:08.000045700 +0100
@@ -2,22 +2,23 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed.
+ /// <para>Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest <see cref="Godot.Viewport"/> node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides 3D display capabilities to a <see cref="Godot.Viewport"/>, and, without one, a scene registered in that <see cref="Godot.Viewport"/> (or higher viewports) can't be displayed.</para>
/// </summary>
public partial class Camera : Spatial
{
public enum KeepAspectEnum
{
/// <summary>
- /// Preserves the horizontal aspect ratio.
+ /// <para>Preserves the horizontal aspect ratio.</para>
/// </summary>
Width = 0,
/// <summary>
- /// Preserves the vertical aspect ratio.
+ /// <para>Preserves the vertical aspect ratio.</para>
/// </summary>
Height = 1
}
@@ -25,11 +26,11 @@
public enum ProjectionEnum
{
/// <summary>
- /// Perspective Projection (object's size on the screen becomes smaller when far away).
+ /// <para>Perspective Projection (object's size on the screen becomes smaller when far away).</para>
/// </summary>
Perspective = 0,
/// <summary>
- /// Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
+ /// <para>Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).</para>
/// </summary>
Orthogonal = 1
}
@@ -37,21 +38,21 @@
public enum DopplerTrackingEnum
{
/// <summary>
- /// Disable Doppler effect simulation (default).
+ /// <para>Disable Doppler effect simulation (default).</para>
/// </summary>
Disabled = 0,
/// <summary>
- /// Simulate Doppler effect by tracking positions of objects that are changed in [code]_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]).
+ /// <para>Simulate Doppler effect by tracking positions of objects that are changed in <c>_process</c>. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's <c>pitch shift</c>).</para>
/// </summary>
IdleStep = 1,
/// <summary>
- /// Simulate Doppler effect by tracking positions of objects that are changed in [code]_physics_process[/code]. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's [code]pitch shift[/code]).
+ /// <para>Simulate Doppler effect by tracking positions of objects that are changed in <c>_physics_process</c>. Changes in the relative velocity of this Camera compared to those objects affect how Audio is perceived (changing the Audio's <c>pitch shift</c>).</para>
/// </summary>
PhysicsStep = 2
}
/// <summary>
- /// The axis to lock during [member fov]/[member size] adjustments. Can be either [code]KEEP_WIDTH[/code] or [code]KEEP_HEIGHT[/code].
+ /// <para>The axis to lock during <see cref="Godot.Camera.Fov"/>/<see cref="Godot.Camera.Size"/> adjustments. Can be either <c>KEEP_WIDTH</c> or <c>KEEP_HEIGHT</c>.</para>
/// </summary>
public Camera.KeepAspectEnum KeepAspect
{
@@ -66,7 +67,7 @@
}
/// <summary>
- /// The culling mask that describes which 3D render layers are rendered by this camera.
+ /// <para>The culling mask that describes which 3D render layers are rendered by this camera.</para>
/// </summary>
public int CullMask
{
@@ -81,7 +82,7 @@
}
/// <summary>
- /// The [Environment] to use for this Camera.
+ /// <para>The <see cref="Godot.Environment"/> to use for this Camera.</para>
/// </summary>
public Environment Environment
{
@@ -96,7 +97,7 @@
}
/// <summary>
- /// The horizontal (X) offset of the Camera viewport.
+ /// <para>The horizontal (X) offset of the Camera viewport.</para>
/// </summary>
public float HOffset
{
@@ -111,7 +112,7 @@
}
/// <summary>
- /// The vertical (Y) offset of the Camera viewport.
+ /// <para>The vertical (Y) offset of the Camera viewport.</para>
/// </summary>
public float VOffset
{
@@ -126,7 +127,7 @@
}
/// <summary>
- /// If not [code]DOPPLER_TRACKING_DISABLED[/code] this Camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. Default value: [code]DOPPLER_TRACKING_DISABLED[/code].
+ /// <para>If not <c>DOPPLER_TRACKING_DISABLED</c> this Camera will simulate the Doppler effect for objects changed in particular <c>_process</c> methods. Default value: <c>DOPPLER_TRACKING_DISABLED</c>.</para>
/// </summary>
public Camera.DopplerTrackingEnum DopplerTracking
{
@@ -141,7 +142,7 @@
}
/// <summary>
- /// The camera's projection mode. In [code]PROJECTION_PERSPECTIVE[/code] mode, objects' z-distance from the camera's local space scales their perceived size.
+ /// <para>The camera's projection mode. In <c>PROJECTION_PERSPECTIVE</c> mode, objects' z-distance from the camera's local space scales their perceived size.</para>
/// </summary>
public Camera.ProjectionEnum Projection
{
@@ -156,7 +157,7 @@
}
/// <summary>
- /// If [code]true[/code], the ancestor [Viewport] is currently using this Camera. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the ancestor <see cref="Godot.Viewport"/> is currently using this Camera. Default value: <c>false</c>.</para>
/// </summary>
public bool Current
{
@@ -171,7 +172,7 @@
}
/// <summary>
- /// The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle.
+ /// <para>The camera's field of view angle (in degrees). Only applicable in perspective mode. Since <see cref="Godot.Camera.KeepAspect"/> locks one axis, <c>fov</c> sets the other axis' field of view angle.</para>
/// </summary>
public float Fov
{
@@ -186,7 +187,7 @@
}
/// <summary>
- /// The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length.
+ /// <para>The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since <see cref="Godot.Camera.KeepAspect"/> locks on axis, <c>size</c> sets the other axis' size length.</para>
/// </summary>
public float Size
{
@@ -201,7 +202,7 @@
}
/// <summary>
- /// The distance to the near culling boundary for this Camera relative to its local z-axis.
+ /// <para>The distance to the near culling boundary for this Camera relative to its local z-axis.</para>
/// </summary>
public float Near
{
@@ -216,7 +217,7 @@
}
/// <summary>
- /// The distance to the far culling boundary for this Camera relative to its local z-axis.
+ /// <para>The distance to the far culling boundary for this Camera relative to its local z-axis.</para>
/// </summary>
public float Far
{
@@ -244,7 +245,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "project_ray_normal");
/// <summary>
- /// Returns a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
+ /// <para>Returns a normal vector in worldspace, that is the result of projecting a point on the <see cref="Godot.Viewport"/> rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.</para>
/// </summary>
[GodotMethod("project_ray_normal")]
public Vector3 ProjectRayNormal(Vector2 screenPoint)
@@ -256,7 +257,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "project_local_ray_normal");
/// <summary>
- /// Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.
+ /// <para>Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.</para>
/// </summary>
[GodotMethod("project_local_ray_normal")]
public Vector3 ProjectLocalRayNormal(Vector2 screenPoint)
@@ -268,7 +269,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "project_ray_origin");
/// <summary>
- /// Returns a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
+ /// <para>Returns a 3D position in worldspace, that is the result of projecting a point on the <see cref="Godot.Viewport"/> rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.</para>
/// </summary>
[GodotMethod("project_ray_origin")]
public Vector3 ProjectRayOrigin(Vector2 screenPoint)
@@ -280,7 +281,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "unproject_position");
/// <summary>
- /// Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in worldspace.
+ /// <para>Returns the 2D coordinate in the <see cref="Godot.Viewport"/> rectangle that maps to the given 3D point in worldspace.</para>
/// </summary>
[GodotMethod("unproject_position")]
public Vector2 UnprojectPosition(Vector3 worldPoint)
@@ -292,7 +293,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_position_behind");
/// <summary>
- /// Returns [code]true[/code] if the given position is behind the Camera. Note that a position which returns [code]false[/code] may still be outside the Camera's field of view.
+ /// <para>Returns <c>true</c> if the given position is behind the Camera. Note that a position which returns <c>false</c> may still be outside the Camera's field of view.</para>
/// </summary>
[GodotMethod("is_position_behind")]
public bool IsPositionBehind(Vector3 worldPoint)
@@ -304,7 +305,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "project_position");
/// <summary>
- /// Returns the 3D point in worldspace that maps to the given 2D coordinate in the [Viewport] rectangle.
+ /// <para>Returns the 3D point in worldspace that maps to the given 2D coordinate in the <see cref="Godot.Viewport"/> rectangle.</para>
/// </summary>
[GodotMethod("project_position")]
public Vector3 ProjectPosition(Vector2 screenPoint)
@@ -316,7 +317,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_perspective");
/// <summary>
- /// Sets the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units.
+ /// <para>Sets the camera projection to perspective mode, by specifying a FOV Y angle in degrees (FOV means Field of View), and the near and far clip planes in worldspace units.</para>
/// </summary>
[GodotMethod("set_perspective")]
public void SetPerspective(float fov, float zNear, float zFar)
@@ -328,7 +329,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_orthogonal");
/// <summary>
- /// Sets the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
+ /// <para>Sets the camera projection to orthogonal mode, by specifying a width and the near and far clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)</para>
/// </summary>
[GodotMethod("set_orthogonal")]
public void SetOrthogonal(float size, float zNear, float zFar)
@@ -340,7 +341,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_current");
/// <summary>
- /// Makes this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
+ /// <para>Makes this camera the current Camera for the <see cref="Godot.Viewport"/> (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.</para>
/// </summary>
[GodotMethod("make_current")]
public void MakeCurrent()
@@ -352,7 +353,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_current");
/// <summary>
- /// If this is the current Camera, remove it from being current. If [code]enable_next[/code] is true, request to make the next Camera current, if any.
+ /// <para>If this is the current Camera, remove it from being current. If <c>enable_next</c> is true, request to make the next Camera current, if any.</para>
/// </summary>
[GodotMethod("clear_current")]
public void ClearCurrent(bool enableNext = true)
@@ -382,7 +383,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_camera_transform");
/// <summary>
- /// Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform.
+ /// <para>Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the <see cref="Godot.Node"/> transform.</para>
/// </summary>
[GodotMethod("get_camera_transform")]
public Transform GetCameraTransform()
@@ -627,3 +628,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Camera2D.cs GodotSharp_after/GodotSharp/ObjectType/Camera2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/Camera2D.cs 2019-03-20 21:16:54.774177100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Camera2D.cs 2019-03-23 19:57:08.009042600 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes.
- /// This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport].
+ /// <para>Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of <see cref="Godot.CanvasItem"/> based nodes.</para>
+ /// <para>This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from <see cref="Godot.Node2D"/> and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in <see cref="Godot.Viewport"/>.</para>
/// </summary>
public partial class Camera2D : Node2D
{
@@ -26,17 +27,17 @@
public enum AnchorModeEnum
{
/// <summary>
- /// The camera's position is fixed so that the top-left corner is always at the origin.
+ /// <para>The camera's position is fixed so that the top-left corner is always at the origin.</para>
/// </summary>
FixedTopLeft = 0,
/// <summary>
- /// The camera's position takes into account vertical/horizontal offsets and the screen size.
+ /// <para>The camera's position takes into account vertical/horizontal offsets and the screen size.</para>
/// </summary>
DragCenter = 1
}
/// <summary>
- /// The camera's offset, useful for looking around or camera shake animations.
+ /// <para>The camera's offset, useful for looking around or camera shake animations.</para>
/// </summary>
public Vector2 Offset
{
@@ -51,7 +52,7 @@
}
/// <summary>
- /// The Camera2D's anchor point. See [code]ANCHOR_MODE_*[/code] constants.
+ /// <para>The Camera2D's anchor point. See <c>ANCHOR_MODE_*</c> constants.</para>
/// </summary>
public Camera2D.AnchorModeEnum AnchorMode
{
@@ -66,7 +67,7 @@
}
/// <summary>
- /// If [code]true[/code], the camera rotates with the target. Default value: [code]false[/code]
+ /// <para>If <c>true</c>, the camera rotates with the target. Default value: <c>false</c></para>
/// </summary>
public bool Rotating
{
@@ -81,7 +82,7 @@
}
/// <summary>
- /// If [code]true[/code], the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera [code]current[/code] will disable this one.
+ /// <para>If <c>true</c>, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera <c>current</c> will disable this one.</para>
/// </summary>
public bool Current
{
@@ -96,7 +97,7 @@
}
/// <summary>
- /// The camera's zoom relative to the viewport. Values larger than [code]Vector2(1, 1)[/code] zoom out and smaller values zoom in. For an example, use [code]Vector2(0.5, 0.5)[/code] for a 2x zoom in, and [code]Vector2(4, 4)[/code] for a 4x zoom out.
+ /// <para>The camera's zoom relative to the viewport. Values larger than <c>Vector2(1, 1)</c> zoom out and smaller values zoom in. For an example, use <c>Vector2(0.5, 0.5)</c> for a 2x zoom in, and <c>Vector2(4, 4)</c> for a 4x zoom out.</para>
/// </summary>
public Vector2 Zoom
{
@@ -111,7 +112,7 @@
}
/// <summary>
- /// The custom [Viewport] node attached to the [code]Camera2D[/code]. If null or not a [Viewport], uses the default viewport instead.
+ /// <para>The custom <see cref="Godot.Viewport"/> node attached to the <c>Camera2D</c>. If null or not a <see cref="Godot.Viewport"/>, uses the default viewport instead.</para>
/// </summary>
public Node CustomViewport
{
@@ -141,7 +142,7 @@
}
/// <summary>
- /// Left scroll limit in pixels. The camera stops moving when reaching this value.
+ /// <para>Left scroll limit in pixels. The camera stops moving when reaching this value.</para>
/// </summary>
public int LimitLeft
{
@@ -156,7 +157,7 @@
}
/// <summary>
- /// Top scroll limit in pixels. The camera stops moving when reaching this value.
+ /// <para>Top scroll limit in pixels. The camera stops moving when reaching this value.</para>
/// </summary>
public int LimitTop
{
@@ -171,7 +172,7 @@
}
/// <summary>
- /// Right scroll limit in pixels. The camera stops moving when reaching this value.
+ /// <para>Right scroll limit in pixels. The camera stops moving when reaching this value.</para>
/// </summary>
public int LimitRight
{
@@ -186,7 +187,7 @@
}
/// <summary>
- /// Bottom scroll limit in pixels. The camera stops moving when reaching this value.
+ /// <para>Bottom scroll limit in pixels. The camera stops moving when reaching this value.</para>
/// </summary>
public int LimitBottom
{
@@ -201,7 +202,7 @@
}
/// <summary>
- /// If [code]true[/code], the camera smoothly stops when reaches its limits. Default value: [code]false[/code]
+ /// <para>If <c>true</c>, the camera smoothly stops when reaches its limits. Default value: <c>false</c></para>
/// </summary>
public bool LimitSmoothed
{
@@ -216,7 +217,7 @@
}
/// <summary>
- /// If [code]true[/code], the camera only moves when reaching the horizontal drag margins. If [code]false[/code], the camera moves horizontally regardless of margins. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the camera only moves when reaching the horizontal drag margins. If <c>false</c>, the camera moves horizontally regardless of margins. Default value: <c>true</c>.</para>
/// </summary>
public bool DragMarginHEnabled
{
@@ -231,7 +232,7 @@
}
/// <summary>
- /// If [code]true[/code], the camera only moves when reaching the vertical drag margins. If [code]false[/code], the camera moves vertically regardless of margins. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the camera only moves when reaching the vertical drag margins. If <c>false</c>, the camera moves vertically regardless of margins. Default value: <c>true</c>.</para>
/// </summary>
public bool DragMarginVEnabled
{
@@ -246,7 +247,7 @@
}
/// <summary>
- /// If [code]true[/code], the camera smoothly moves towards the target at [member smoothing_speed]. Default value: [code]false[/code]
+ /// <para>If <c>true</c>, the camera smoothly moves towards the target at <see cref="Godot.Camera2D.SmoothingSpeed"/>. Default value: <c>false</c></para>
/// </summary>
public bool SmoothingEnabled
{
@@ -261,7 +262,7 @@
}
/// <summary>
- /// Speed in pixels per second of the camera's smoothing effect when [member smoothing_enabled] is [code]true[/code]
+ /// <para>Speed in pixels per second of the camera's smoothing effect when <see cref="Godot.Camera2D.SmoothingEnabled"/> is <c>true</c></para>
/// </summary>
public float SmoothingSpeed
{
@@ -276,7 +277,7 @@
}
/// <summary>
- /// The vertical offset of the camera, relative to the drag margins. Default value: [code]0[/code]
+ /// <para>The vertical offset of the camera, relative to the drag margins. Default value: <c>0</c></para>
/// </summary>
public float OffsetV
{
@@ -291,7 +292,7 @@
}
/// <summary>
- /// The horizontal offset of the camera, relative to the drag margins. Default value: [code]0[/code]
+ /// <para>The horizontal offset of the camera, relative to the drag margins. Default value: <c>0</c></para>
/// </summary>
public float OffsetH
{
@@ -306,7 +307,7 @@
}
/// <summary>
- /// Left margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
+ /// <para>Left margin needed to drag the camera. A value of <c>1</c> makes the camera move only when reaching the edge of the screen.</para>
/// </summary>
public float DragMarginLeft
{
@@ -321,7 +322,7 @@
}
/// <summary>
- /// Top margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
+ /// <para>Top margin needed to drag the camera. A value of <c>1</c> makes the camera move only when reaching the edge of the screen.</para>
/// </summary>
public float DragMarginTop
{
@@ -336,7 +337,7 @@
}
/// <summary>
- /// Right margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
+ /// <para>Right margin needed to drag the camera. A value of <c>1</c> makes the camera move only when reaching the edge of the screen.</para>
/// </summary>
public float DragMarginRight
{
@@ -351,7 +352,7 @@
}
/// <summary>
- /// Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen.
+ /// <para>Bottom margin needed to drag the camera. A value of <c>1</c> makes the camera move only when reaching the edge of the screen.</para>
/// </summary>
public float DragMarginBottom
{
@@ -366,7 +367,7 @@
}
/// <summary>
- /// If [code]true[/code], draws the camera's screen rectangle in the editor. Default value: [code]false[/code]
+ /// <para>If <c>true</c>, draws the camera's screen rectangle in the editor. Default value: <c>false</c></para>
/// </summary>
public bool EditorDrawScreen
{
@@ -381,7 +382,7 @@
}
/// <summary>
- /// If [code]true[/code], draws the camera's limits rectangle in the editor. Default value: [code]true[/code]
+ /// <para>If <c>true</c>, draws the camera's limits rectangle in the editor. Default value: <c>true</c></para>
/// </summary>
public bool EditorDrawLimits
{
@@ -396,7 +397,7 @@
}
/// <summary>
- /// If [code]true[/code], draws the camera's drag margin rectangle in the editor. Default value: [code]false[/code]
+ /// <para>If <c>true</c>, draws the camera's drag margin rectangle in the editor. Default value: <c>false</c></para>
/// </summary>
public bool EditorDrawDragMargin
{
@@ -478,7 +479,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_current");
/// <summary>
- /// Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
+ /// <para>Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.</para>
/// </summary>
[GodotMethod("make_current")]
public void MakeCurrent()
@@ -490,7 +491,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_current");
/// <summary>
- /// Removes any [code]Camera2D[/code] from the ancestor [Viewport]'s internal currently-assigned camera.
+ /// <para>Removes any <c>Camera2D</c> from the ancestor <see cref="Godot.Viewport"/>'s internal currently-assigned camera.</para>
/// </summary>
[GodotMethod("clear_current")]
public void ClearCurrent()
@@ -663,7 +664,7 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_camera_position");
/// <summary>
- /// Return the camera position.
+ /// <para>Return the camera position.</para>
/// </summary>
[GodotMethod("get_camera_position")]
public Vector2 GetCameraPosition()
@@ -675,7 +676,7 @@
private static IntPtr method_bind_27 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_camera_screen_center");
/// <summary>
- /// Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin.
+ /// <para>Returns the location of the <c>Camera2D</c>'s screen-center, relative to the origin.</para>
/// </summary>
[GodotMethod("get_camera_screen_center")]
public Vector2 GetCameraScreenCenter()
@@ -759,7 +760,7 @@
private static IntPtr method_bind_36 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "force_update_scroll");
/// <summary>
- /// Force the camera to update scroll immediately.
+ /// <para>Force the camera to update scroll immediately.</para>
/// </summary>
[GodotMethod("force_update_scroll")]
public void ForceUpdateScroll()
@@ -771,8 +772,8 @@
private static IntPtr method_bind_37 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "reset_smoothing");
/// <summary>
- /// Set the camera's position immediately to its current smoothing destination.
- /// This has no effect if smoothing is disabled.
+ /// <para>Set the camera's position immediately to its current smoothing destination.</para>
+ /// <para>This has no effect if smoothing is disabled.</para>
/// </summary>
[GodotMethod("reset_smoothing")]
public void ResetSmoothing()
@@ -784,7 +785,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "align");
/// <summary>
- /// Align the camera to the tracked node
+ /// <para>Align the camera to the tracked node</para>
/// </summary>
[GodotMethod("align")]
public void Align()
@@ -849,3 +850,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CanvasItem.cs GodotSharp_after/GodotSharp/ObjectType/CanvasItem.cs
--- GodotSharp_before/GodotSharp/ObjectType/CanvasItem.cs 2019-03-20 21:16:54.786172700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CanvasItem.cs 2019-03-23 19:57:08.023038700 +0100
@@ -2,69 +2,70 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related.
- /// Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though.
- /// Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though).
- /// Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode.
- /// Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.
+ /// <para>Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by <see cref="Godot.Control"/>, for anything GUI related, and by <see cref="Godot.Node2D"/> for anything 2D engine related.</para>
+ /// <para>Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though.</para>
+ /// <para>Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though).</para>
+ /// <para>Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode.</para>
+ /// <para>Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed.</para>
/// </summary>
public abstract partial class CanvasItem : Node
{
/// <summary>
- /// Canvas item transform has changed. Notification is only received if enabled by [method set_notify_transform] or [method set_notify_local_transform].
+ /// <para>Canvas item transform has changed. Notification is only received if enabled by <see cref="Godot.CanvasItem.SetNotifyTransform"/> or <see cref="Godot.CanvasItem.SetNotifyLocalTransform"/>.</para>
/// </summary>
public const int NotificationTransformChanged = 29;
/// <summary>
- /// CanvasItem is requested to draw.
+ /// <para>CanvasItem is requested to draw.</para>
/// </summary>
public const int NotificationDraw = 30;
/// <summary>
- /// Canvas item visibility has changed.
+ /// <para>Canvas item visibility has changed.</para>
/// </summary>
public const int NotificationVisibilityChanged = 31;
/// <summary>
- /// Canvas item has entered the canvas.
+ /// <para>Canvas item has entered the canvas.</para>
/// </summary>
public const int NotificationEnterCanvas = 32;
/// <summary>
- /// Canvas item has exited the canvas.
+ /// <para>Canvas item has exited the canvas.</para>
/// </summary>
public const int NotificationExitCanvas = 33;
public enum BlendMode
{
/// <summary>
- /// Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
+ /// <para>Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.</para>
/// </summary>
Mix = 0,
/// <summary>
- /// Additive blending mode.
+ /// <para>Additive blending mode.</para>
/// </summary>
Add = 1,
/// <summary>
- /// Subtractive blending mode.
+ /// <para>Subtractive blending mode.</para>
/// </summary>
Sub = 2,
/// <summary>
- /// Multiplicative blending mode.
+ /// <para>Multiplicative blending mode.</para>
/// </summary>
Mul = 3,
/// <summary>
- /// Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
+ /// <para>Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.</para>
/// </summary>
PremultAlpha = 4,
/// <summary>
- /// Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied.
+ /// <para>Disable blending mode. Colors including alpha are written as is. Only applicable for render targets with a transparent background. No lighting will be applied.</para>
/// </summary>
Disabled = 5
}
/// <summary>
- /// If [code]true[/code], this [code]CanvasItem[/code] is drawn. Default value: [code]true[/code]. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple popup*() functions instead.
+ /// <para>If <c>true</c>, this <c>CanvasItem</c> is drawn. Default value: <c>true</c>. For controls that inherit <see cref="Godot.Popup"/>, the correct way to make them visible is to call one of the multiple popup*() functions instead.</para>
/// </summary>
public bool Visible
{
@@ -79,7 +80,7 @@
}
/// <summary>
- /// The color applied to textures on this [code]CanvasItem[/code]. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white").
+ /// <para>The color applied to textures on this <c>CanvasItem</c>. Default value: <c>Color(1, 1, 1, 1)</c> (opaque "white").</para>
/// </summary>
public Color Modulate
{
@@ -94,7 +95,7 @@
}
/// <summary>
- /// The color applied to textures on this [code]CanvasItem[/code]. This is not inherited by children [code]CanvasItem[/code]s. Default value: [code]Color(1, 1, 1, 1)[/code] (opaque "white")..
+ /// <para>The color applied to textures on this <c>CanvasItem</c>. This is not inherited by children <c>CanvasItem</c>s. Default value: <c>Color(1, 1, 1, 1)</c> (opaque "white")..</para>
/// </summary>
public Color SelfModulate
{
@@ -109,7 +110,7 @@
}
/// <summary>
- /// If [code]true[/code], the object draws behind its parent. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the object draws behind its parent. Default value: <c>false</c>.</para>
/// </summary>
public bool ShowBehindParent
{
@@ -124,7 +125,7 @@
}
/// <summary>
- /// If [code]true[/code], the object draws on top of its parent. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the object draws on top of its parent. Default value: <c>true</c>.</para>
/// </summary>
public bool ShowOnTop
{
@@ -139,7 +140,7 @@
}
/// <summary>
- /// The rendering layers in which this [code]CanvasItem[/code] responds to [Light2D] nodes. Default value: [code]1[/code].
+ /// <para>The rendering layers in which this <c>CanvasItem</c> responds to <see cref="Godot.Light2D"/> nodes. Default value: <c>1</c>.</para>
/// </summary>
public int LightMask
{
@@ -154,7 +155,7 @@
}
/// <summary>
- /// The material applied to textures on this [code]CanvasItem[/code]. Default value: [code]null[/code].
+ /// <para>The material applied to textures on this <c>CanvasItem</c>. Default value: <c>null</c>.</para>
/// </summary>
public Material Material
{
@@ -169,7 +170,7 @@
}
/// <summary>
- /// If [code]true[/code], the parent [code]CanvasItem[/code]'s [member material] property is used as this one's material. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the parent <c>CanvasItem</c>'s <see cref="Godot.CanvasItem.Material"/> property is used as this one's material. Default value: <c>false</c>.</para>
/// </summary>
public bool UseParentMaterial
{
@@ -190,7 +191,7 @@
internal CanvasItem(bool memoryOwn) : base(memoryOwn) {}
/// <summary>
- /// Called (if exists) to draw the canvas item.
+ /// <para>Called (if exists) to draw the canvas item.</para>
/// </summary>
[GodotMethod("_draw")]
public virtual void _Draw()
@@ -202,7 +203,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_canvas_item");
/// <summary>
- /// Return the canvas item RID used by [VisualServer] for this item.
+ /// <para>Return the canvas item RID used by <see cref="Godot.VisualServer"/> for this item.</para>
/// </summary>
[GodotMethod("get_canvas_item")]
public RID GetCanvasItem()
@@ -232,7 +233,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_visible_in_tree");
/// <summary>
- /// Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and its inherited visibility is also [code]true[/code].
+ /// <para>Returns <c>true</c> if the node is present in the <see cref="Godot.SceneTree"/>, its <see cref="Godot.CanvasItem.Visible"/> property is <c>true</c> and its inherited visibility is also <c>true</c>.</para>
/// </summary>
[GodotMethod("is_visible_in_tree")]
public bool IsVisibleInTree()
@@ -244,7 +245,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "show");
/// <summary>
- /// Show the CanvasItem currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple popup*() functions instead.
+ /// <para>Show the CanvasItem currently hidden. For controls that inherit <see cref="Godot.Popup"/>, the correct way to make them visible is to call one of the multiple popup*() functions instead.</para>
/// </summary>
[GodotMethod("show")]
public void Show()
@@ -256,7 +257,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "hide");
/// <summary>
- /// Hide the CanvasItem currently visible.
+ /// <para>Hide the CanvasItem currently visible.</para>
/// </summary>
[GodotMethod("hide")]
public void Hide()
@@ -268,7 +269,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "update");
/// <summary>
- /// Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw.
+ /// <para>Queue the CanvasItem for update. <c>NOTIFICATION_DRAW</c> will be called on idle time to request redraw.</para>
/// </summary>
[GodotMethod("update")]
public void Update()
@@ -280,7 +281,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_as_toplevel");
/// <summary>
- /// Sets as top level. This means that it will not inherit transform from parent canvas items.
+ /// <para>Sets as top level. This means that it will not inherit transform from parent canvas items.</para>
/// </summary>
[GodotMethod("set_as_toplevel")]
public void SetAsToplevel(bool enable)
@@ -292,7 +293,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_set_as_toplevel");
/// <summary>
- /// Return if set as toplevel. See [method set_as_toplevel].
+ /// <para>Return if set as toplevel. See <see cref="Godot.CanvasItem.SetAsToplevel"/>.</para>
/// </summary>
[GodotMethod("is_set_as_toplevel")]
public bool IsSetAsToplevel()
@@ -392,7 +393,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_line");
/// <summary>
- /// Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.
+ /// <para>Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased.</para>
/// </summary>
[GodotMethod("draw_line")]
public void DrawLine(Vector2 from, Vector2 to, Color color, float width = 1f, bool antialiased = false)
@@ -404,7 +405,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_polyline");
/// <summary>
- /// Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
+ /// <para>Draws interconnected line segments with a uniform <c>color</c> and <c>width</c> and optional antialiasing.</para>
/// </summary>
[GodotMethod("draw_polyline")]
public void DrawPolyline(Vector2[] points, Color color, float width = 1f, bool antialiased = false)
@@ -416,7 +417,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_polyline_colors");
/// <summary>
- /// Draws interconnected line segments with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
+ /// <para>Draws interconnected line segments with a uniform <c>width</c>, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between <c>points</c> and <c>colors</c>.</para>
/// </summary>
[GodotMethod("draw_polyline_colors")]
public void DrawPolylineColors(Vector2[] points, Color[] colors, float width = 1f, bool antialiased = false)
@@ -428,7 +429,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_multiline");
/// <summary>
- /// Draws multiple, parallel lines with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing.
+ /// <para>Draws multiple, parallel lines with a uniform <c>color</c> and <c>width</c> and optional antialiasing.</para>
/// </summary>
[GodotMethod("draw_multiline")]
public void DrawMultiline(Vector2[] points, Color color, float width = 1f, bool antialiased = false)
@@ -440,7 +441,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_multiline_colors");
/// <summary>
- /// Draws multiple, parallel lines with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
+ /// <para>Draws multiple, parallel lines with a uniform <c>width</c>, segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between <c>points</c> and <c>colors</c>.</para>
/// </summary>
[GodotMethod("draw_multiline_colors")]
public void DrawMultilineColors(Vector2[] points, Color[] colors, float width = 1f, bool antialiased = false)
@@ -452,7 +453,7 @@
private static IntPtr method_bind_24 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_rect");
/// <summary>
- /// Draws a colored rectangle.
+ /// <para>Draws a colored rectangle.</para>
/// </summary>
[GodotMethod("draw_rect")]
public void DrawRect(Rect2 rect, Color color, bool filled = true)
@@ -464,7 +465,7 @@
private static IntPtr method_bind_25 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_circle");
/// <summary>
- /// Draws a colored circle.
+ /// <para>Draws a colored circle.</para>
/// </summary>
[GodotMethod("draw_circle")]
public void DrawCircle(Vector2 position, float radius, Color color)
@@ -476,8 +477,8 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_texture");
/// <summary>
- /// Draws a texture at a given position.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draws a texture at a given position.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw_texture")]
public void DrawTexture(Texture texture, Vector2 position, Nullable<Color> modulate = null, Texture normalMap = null)
@@ -490,8 +491,8 @@
private static IntPtr method_bind_27 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_texture_rect");
/// <summary>
- /// Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draws a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw_texture_rect")]
public void DrawTextureRect(Texture texture, Rect2 rect, bool tile, Nullable<Color> modulate = null, bool transpose = false, Texture normalMap = null)
@@ -504,8 +505,8 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_texture_rect_region");
/// <summary>
- /// Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draws a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw_texture_rect_region")]
public void DrawTextureRectRegion(Texture texture, Rect2 rect, Rect2 srcRect, Nullable<Color> modulate = null, bool transpose = false, Texture normalMap = null, bool clipUv = true)
@@ -518,7 +519,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_style_box");
/// <summary>
- /// Draws a styled rectangle.
+ /// <para>Draws a styled rectangle.</para>
/// </summary>
[GodotMethod("draw_style_box")]
public void DrawStyleBox(StyleBox styleBox, Rect2 rect)
@@ -530,7 +531,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_primitive");
/// <summary>
- /// Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
+ /// <para>Draws a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.</para>
/// </summary>
[GodotMethod("draw_primitive")]
public void DrawPrimitive(Vector2[] points, Color[] colors, Vector2[] uvs, Texture texture = null, float width = 1f, Texture normalMap = null)
@@ -542,8 +543,8 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_polygon");
/// <summary>
- /// Draws a polygon of any amount of points, convex or concave.
- /// &lt;param name="uvs"&gt;If the param is null, then the default value is new Vector2[] {}&lt;/param&gt;
+ /// <para>Draws a polygon of any amount of points, convex or concave.</para>
+ /// <param name="uvs">If the parameter is null, then the default value is new Vector2[] {}</param>
/// </summary>
[GodotMethod("draw_polygon")]
public void DrawPolygon(Vector2[] points, Color[] colors, Vector2[] uvs = null, Texture texture = null, Texture normalMap = null, bool antialiased = false)
@@ -556,8 +557,8 @@
private static IntPtr method_bind_32 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_colored_polygon");
/// <summary>
- /// Draws a colored polygon of any amount of points, convex or concave.
- /// &lt;param name="uvs"&gt;If the param is null, then the default value is new Vector2[] {}&lt;/param&gt;
+ /// <para>Draws a colored polygon of any amount of points, convex or concave.</para>
+ /// <param name="uvs">If the parameter is null, then the default value is new Vector2[] {}</param>
/// </summary>
[GodotMethod("draw_colored_polygon")]
public void DrawColoredPolygon(Vector2[] points, Color color, Vector2[] uvs = null, Texture texture = null, Texture normalMap = null, bool antialiased = false)
@@ -570,8 +571,8 @@
private static IntPtr method_bind_33 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_string");
/// <summary>
- /// Draws a string using a custom font.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draws a string using a custom font.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw_string")]
public void DrawString(Font font, Vector2 position, string text, Nullable<Color> modulate = null, int clipW = -1)
@@ -584,8 +585,8 @@
private static IntPtr method_bind_34 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_char");
/// <summary>
- /// Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draws a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw_char")]
public float DrawChar(Font font, Vector2 position, string @char, string next, Nullable<Color> modulate = null)
@@ -622,7 +623,7 @@
private static IntPtr method_bind_37 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_set_transform");
/// <summary>
- /// Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
+ /// <para>Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.</para>
/// </summary>
[GodotMethod("draw_set_transform")]
public void DrawSetTransform(Vector2 position, float rotation, Vector2 scale)
@@ -634,7 +635,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_set_transform_matrix");
/// <summary>
- /// Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
+ /// <para>Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.</para>
/// </summary>
[GodotMethod("draw_set_transform_matrix")]
public void DrawSetTransformMatrix(Transform2D xform)
@@ -646,7 +647,7 @@
private static IntPtr method_bind_39 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_transform");
/// <summary>
- /// Get the transform matrix of this item.
+ /// <para>Get the transform matrix of this item.</para>
/// </summary>
[GodotMethod("get_transform")]
public Transform2D GetTransform()
@@ -658,7 +659,7 @@
private static IntPtr method_bind_40 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_global_transform");
/// <summary>
- /// Get the global transform matrix of this item.
+ /// <para>Get the global transform matrix of this item.</para>
/// </summary>
[GodotMethod("get_global_transform")]
public Transform2D GetGlobalTransform()
@@ -670,7 +671,7 @@
private static IntPtr method_bind_41 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_global_transform_with_canvas");
/// <summary>
- /// Get the global transform matrix of this item in relation to the canvas.
+ /// <para>Get the global transform matrix of this item in relation to the canvas.</para>
/// </summary>
[GodotMethod("get_global_transform_with_canvas")]
public Transform2D GetGlobalTransformWithCanvas()
@@ -682,7 +683,7 @@
private static IntPtr method_bind_42 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_viewport_transform");
/// <summary>
- /// Get this item's transform in relation to the viewport.
+ /// <para>Get this item's transform in relation to the viewport.</para>
/// </summary>
[GodotMethod("get_viewport_transform")]
public Transform2D GetViewportTransform()
@@ -694,7 +695,7 @@
private static IntPtr method_bind_43 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_viewport_rect");
/// <summary>
- /// Get the viewport's boundaries as a [Rect2].
+ /// <para>Get the viewport's boundaries as a <see cref="Godot.Rect2"/>.</para>
/// </summary>
[GodotMethod("get_viewport_rect")]
public Rect2 GetViewportRect()
@@ -706,7 +707,7 @@
private static IntPtr method_bind_44 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_canvas_transform");
/// <summary>
- /// Get the transform matrix of this item's canvas.
+ /// <para>Get the transform matrix of this item's canvas.</para>
/// </summary>
[GodotMethod("get_canvas_transform")]
public Transform2D GetCanvasTransform()
@@ -718,7 +719,7 @@
private static IntPtr method_bind_45 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_local_mouse_position");
/// <summary>
- /// Get the mouse position relative to this item's position.
+ /// <para>Get the mouse position relative to this item's position.</para>
/// </summary>
[GodotMethod("get_local_mouse_position")]
public Vector2 GetLocalMousePosition()
@@ -730,7 +731,7 @@
private static IntPtr method_bind_46 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_global_mouse_position");
/// <summary>
- /// Get the global position of the mouse.
+ /// <para>Get the global position of the mouse.</para>
/// </summary>
[GodotMethod("get_global_mouse_position")]
public Vector2 GetGlobalMousePosition()
@@ -742,7 +743,7 @@
private static IntPtr method_bind_47 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_canvas");
/// <summary>
- /// Return the [RID] of the [World2D] canvas where this item is in.
+ /// <para>Return the <see cref="Godot.RID"/> of the <see cref="Godot.World2D"/> canvas where this item is in.</para>
/// </summary>
[GodotMethod("get_canvas")]
public RID GetCanvas()
@@ -754,7 +755,7 @@
private static IntPtr method_bind_48 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_world_2d");
/// <summary>
- /// Get the [World2D] where this item is in.
+ /// <para>Get the <see cref="Godot.World2D"/> where this item is in.</para>
/// </summary>
[GodotMethod("get_world_2d")]
public World2D GetWorld2d()
@@ -802,7 +803,7 @@
private static IntPtr method_bind_53 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_notify_local_transform");
/// <summary>
- /// If [code]enable[/code] is [code]true[/code], children will be updated with local transform data.
+ /// <para>If <c>enable</c> is <c>true</c>, children will be updated with local transform data.</para>
/// </summary>
[GodotMethod("set_notify_local_transform")]
public void SetNotifyLocalTransform(bool enable)
@@ -814,7 +815,7 @@
private static IntPtr method_bind_54 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_local_transform_notification_enabled");
/// <summary>
- /// Returns [code]true[/code] if local transform notifications are communicated to children.
+ /// <para>Returns <c>true</c> if local transform notifications are communicated to children.</para>
/// </summary>
[GodotMethod("is_local_transform_notification_enabled")]
public bool IsLocalTransformNotificationEnabled()
@@ -826,7 +827,7 @@
private static IntPtr method_bind_55 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_notify_transform");
/// <summary>
- /// If [code]enable[/code] is [code]true[/code], children will be updated with global transform data.
+ /// <para>If <c>enable</c> is <c>true</c>, children will be updated with global transform data.</para>
/// </summary>
[GodotMethod("set_notify_transform")]
public void SetNotifyTransform(bool enable)
@@ -838,7 +839,7 @@
private static IntPtr method_bind_56 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_transform_notification_enabled");
/// <summary>
- /// Returns [code]true[/code] if global transform notifications are communicated to children.
+ /// <para>Returns <c>true</c> if global transform notifications are communicated to children.</para>
/// </summary>
[GodotMethod("is_transform_notification_enabled")]
public bool IsTransformNotificationEnabled()
@@ -862,7 +863,7 @@
private static IntPtr method_bind_58 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_canvas_position_local");
/// <summary>
- /// Assigns [code]screen_point[/code] as this node's new local transform.
+ /// <para>Assigns <c>screen_point</c> as this node's new local transform.</para>
/// </summary>
[GodotMethod("make_canvas_position_local")]
public Vector2 MakeCanvasPositionLocal(Vector2 screenPoint)
@@ -874,7 +875,7 @@
private static IntPtr method_bind_59 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_input_local");
/// <summary>
- /// Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space.
+ /// <para>Transformations issued by <c>event</c>'s inputs are applied in local space instead of global space.</para>
/// </summary>
[GodotMethod("make_input_local")]
public InputEvent MakeInputLocal(InputEvent @event)
@@ -885,3 +886,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CanvasItemMaterial.cs GodotSharp_after/GodotSharp/ObjectType/CanvasItemMaterial.cs
--- GodotSharp_before/GodotSharp/ObjectType/CanvasItemMaterial.cs 2019-03-20 21:16:54.792171400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CanvasItemMaterial.cs 2019-03-23 19:57:08.028036500 +0100
@@ -2,26 +2,27 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// [code]CanvasItemMaterial[/code]s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a [ShaderMaterial] to more fully customize a material's interactions with a [CanvasItem].
+ /// <para><c>CanvasItemMaterial</c>s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a <see cref="Godot.ShaderMaterial"/> to more fully customize a material's interactions with a <see cref="Godot.CanvasItem"/>.</para>
/// </summary>
public partial class CanvasItemMaterial : Material
{
public enum LightModeEnum
{
/// <summary>
- /// Render the material using both light and non-light sensitive material properties.
+ /// <para>Render the material using both light and non-light sensitive material properties.</para>
/// </summary>
Normal = 0,
/// <summary>
- /// Render the material as if there were no light.
+ /// <para>Render the material as if there were no light.</para>
/// </summary>
Unshaded = 1,
/// <summary>
- /// Render the material as if there were only light.
+ /// <para>Render the material as if there were only light.</para>
/// </summary>
LightOnly = 2
}
@@ -29,29 +30,29 @@
public enum BlendModeEnum
{
/// <summary>
- /// Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
+ /// <para>Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.</para>
/// </summary>
Mix = 0,
/// <summary>
- /// Additive blending mode.
+ /// <para>Additive blending mode.</para>
/// </summary>
Add = 1,
/// <summary>
- /// Subtractive blending mode.
+ /// <para>Subtractive blending mode.</para>
/// </summary>
Sub = 2,
/// <summary>
- /// Multiplicative blending mode.
+ /// <para>Multiplicative blending mode.</para>
/// </summary>
Mul = 3,
/// <summary>
- /// Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
+ /// <para>Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.</para>
/// </summary>
PremultAlpha = 4
}
/// <summary>
- /// The manner in which a material's rendering is applied to underlying textures.
+ /// <para>The manner in which a material's rendering is applied to underlying textures.</para>
/// </summary>
public CanvasItemMaterial.BlendModeEnum BlendMode
{
@@ -66,7 +67,7 @@
}
/// <summary>
- /// The manner in which material reacts to lighting.
+ /// <para>The manner in which material reacts to lighting.</para>
/// </summary>
public CanvasItemMaterial.LightModeEnum LightMode
{
@@ -261,3 +262,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CanvasLayer.cs GodotSharp_after/GodotSharp/ObjectType/CanvasLayer.cs
--- GodotSharp_before/GodotSharp/ObjectType/CanvasLayer.cs 2019-03-20 21:16:54.796170300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CanvasLayer.cs 2019-03-23 19:57:08.032035400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Canvas drawing layer. [CanvasItem] nodes that are direct or indirect children of a [code]CanvasLayer[/code] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [code]CanvasLayer[/code] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below).
+ /// <para>Canvas drawing layer. <see cref="Godot.CanvasItem"/> nodes that are direct or indirect children of a <c>CanvasLayer</c> will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a <c>CanvasLayer</c> with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below).</para>
/// </summary>
public partial class CanvasLayer : Node
{
/// <summary>
- /// Layer index for draw order. Lower values are drawn first. Default value: [code]1[/code].
+ /// <para>Layer index for draw order. Lower values are drawn first. Default value: <c>1</c>.</para>
/// </summary>
public int Layer
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The layer's base offset.
+ /// <para>The layer's base offset.</para>
/// </summary>
public Vector2 Offset
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The layer's rotation in degrees.
+ /// <para>The layer's rotation in degrees.</para>
/// </summary>
public float RotationDegrees
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// The layer's rotation in radians.
+ /// <para>The layer's rotation in radians.</para>
/// </summary>
public float Rotation
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// The layer's scale.
+ /// <para>The layer's scale.</para>
/// </summary>
public Vector2 Scale
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// The layer's transform.
+ /// <para>The layer's transform.</para>
/// </summary>
public Transform2D Transform
{
@@ -101,7 +102,7 @@
}
/// <summary>
- /// The custom [Viewport] node assigned to the [code]CanvasLayer[/code]. If null, uses the default viewport instead.
+ /// <para>The custom <see cref="Godot.Viewport"/> node assigned to the <c>CanvasLayer</c>. If null, uses the default viewport instead.</para>
/// </summary>
public Node CustomViewport
{
@@ -255,7 +256,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_canvas");
/// <summary>
- /// Returns the RID of the canvas used by this layer.
+ /// <para>Returns the RID of the canvas used by this layer.</para>
/// </summary>
[GodotMethod("get_canvas")]
public RID GetCanvas()
@@ -266,3 +267,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CanvasModulate.cs GodotSharp_after/GodotSharp/ObjectType/CanvasModulate.cs
--- GodotSharp_before/GodotSharp/ObjectType/CanvasModulate.cs 2019-03-20 21:16:54.800168000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CanvasModulate.cs 2019-03-23 19:57:08.035034700 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// [code]CanvasModulate[/code] tints the canvas elements using its assigned [code]color[/code].
+ /// <para><c>CanvasModulate</c> tints the canvas elements using its assigned <c>color</c>.</para>
/// </summary>
public partial class CanvasModulate : Node2D
{
/// <summary>
- /// The tint color to apply.
+ /// <para>The tint color to apply.</para>
/// </summary>
public Color Color
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CapsuleMesh.cs GodotSharp_after/GodotSharp/ObjectType/CapsuleMesh.cs
--- GodotSharp_before/GodotSharp/ObjectType/CapsuleMesh.cs 2019-03-20 21:16:54.803167400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CapsuleMesh.cs 2019-03-23 19:57:08.038033700 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Class representing a capsule-shaped [PrimitiveMesh].
+ /// <para>Class representing a capsule-shaped <see cref="Godot.PrimitiveMesh"/>.</para>
/// </summary>
public partial class CapsuleMesh : PrimitiveMesh
{
/// <summary>
- /// Radius of the capsule mesh. Defaults to 1.0.
+ /// <para>Radius of the capsule mesh. Defaults to 1.0.</para>
/// </summary>
public float Radius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Height of the capsule mesh from the center point. Defaults to 1.0.
+ /// <para>Height of the capsule mesh from the center point. Defaults to 1.0.</para>
/// </summary>
public float MidHeight
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Number of radial segments on the capsule mesh. Defaults to 64.
+ /// <para>Number of radial segments on the capsule mesh. Defaults to 64.</para>
/// </summary>
public int RadialSegments
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Number of rings along the height of the capsule. Defaults to 8.
+ /// <para>Number of rings along the height of the capsule. Defaults to 8.</para>
/// </summary>
public int Rings
{
@@ -155,3 +156,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CapsuleShape.cs GodotSharp_after/GodotSharp/ObjectType/CapsuleShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/CapsuleShape.cs 2019-03-20 21:16:54.806165800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CapsuleShape.cs 2019-03-23 19:57:08.040032900 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Capsule shape for collisions.
+ /// <para>Capsule shape for collisions.</para>
/// </summary>
public partial class CapsuleShape : Shape
{
/// <summary>
- /// The capsule's radius.
+ /// <para>The capsule's radius.</para>
/// </summary>
public float Radius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The capsule's height.
+ /// <para>The capsule's height.</para>
/// </summary>
public float Height
{
@@ -89,3 +90,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CapsuleShape2D.cs GodotSharp_after/GodotSharp/ObjectType/CapsuleShape2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/CapsuleShape2D.cs 2019-03-20 21:16:54.810165000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CapsuleShape2D.cs 2019-03-23 19:57:08.043031300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Capsule shape for 2D collisions.
+ /// <para>Capsule shape for 2D collisions.</para>
/// </summary>
public partial class CapsuleShape2D : Shape2D
{
/// <summary>
- /// The capsule's radius.
+ /// <para>The capsule's radius.</para>
/// </summary>
public float Radius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The capsule's height.
+ /// <para>The capsule's height.</para>
/// </summary>
public float Height
{
@@ -89,3 +90,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CenterContainer.cs GodotSharp_after/GodotSharp/ObjectType/CenterContainer.cs
--- GodotSharp_before/GodotSharp/ObjectType/CenterContainer.cs 2019-03-20 21:16:54.812164700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CenterContainer.cs 2019-03-23 19:57:08.045031400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.
+ /// <para>CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center.</para>
/// </summary>
public partial class CenterContainer : Container
{
/// <summary>
- /// If [code]true[/code], centers children relative to the [code]CenterContainer[/code]'s top left corner. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, centers children relative to the <c>CenterContainer</c>'s top left corner. Default value: <c>false</c>.</para>
/// </summary>
public bool UseTopLeft
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CheckBox.cs GodotSharp_after/GodotSharp/ObjectType/CheckBox.cs
--- GodotSharp_before/GodotSharp/ObjectType/CheckBox.cs 2019-03-20 21:16:54.814164000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CheckBox.cs 2019-03-23 19:57:08.047030100 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'.
+ /// <para>A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'.</para>
/// </summary>
public partial class CheckBox : Button
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CheckButton.cs GodotSharp_after/GodotSharp/ObjectType/CheckButton.cs
--- GodotSharp_before/GodotSharp/ObjectType/CheckButton.cs 2019-03-20 21:16:54.832175500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CheckButton.cs 2019-03-23 19:57:08.049029200 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// CheckButton is a toggle button displayed as a check field.
+ /// <para>CheckButton is a toggle button displayed as a check field.</para>
/// </summary>
public partial class CheckButton : Button
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CircleShape2D.cs GodotSharp_after/GodotSharp/ObjectType/CircleShape2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/CircleShape2D.cs 2019-03-20 21:16:54.836157100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CircleShape2D.cs 2019-03-23 19:57:08.051028600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
+ /// <para>Circular shape for 2D collisions. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.</para>
/// </summary>
public partial class CircleShape2D : Shape2D
{
/// <summary>
- /// The circle's radius.
+ /// <para>The circle's radius.</para>
/// </summary>
public float Radius
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ClassDB.cs GodotSharp_after/GodotSharp/ObjectType/ClassDB.cs
--- GodotSharp_before/GodotSharp/ObjectType/ClassDB.cs 2019-03-20 21:16:57.372834400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ClassDB.cs 2019-03-23 19:57:09.895547800 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Provides access to metadata stored for every available class.
+ /// <para>Provides access to metadata stored for every available class.</para>
/// </summary>
public static partial class ClassDB
{
@@ -29,7 +30,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_class_list");
/// <summary>
- /// Returns the names of all the classes available.
+ /// <para>Returns the names of all the classes available.</para>
/// </summary>
[GodotMethod("get_class_list")]
public static string[] GetClassList()
@@ -41,7 +42,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_inheriters_from_class");
/// <summary>
- /// Returns the names of all the classes that directly or indirectly inherit from 'class'.
+ /// <para>Returns the names of all the classes that directly or indirectly inherit from 'class'.</para>
/// </summary>
[GodotMethod("get_inheriters_from_class")]
public static string[] GetInheritersFromClass(string @class)
@@ -53,7 +54,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_parent_class");
/// <summary>
- /// Returns the parent class of 'class'.
+ /// <para>Returns the parent class of 'class'.</para>
/// </summary>
[GodotMethod("get_parent_class")]
public static string GetParentClass(string @class)
@@ -65,7 +66,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_exists");
/// <summary>
- /// Returns whether the specified 'class' is available or not.
+ /// <para>Returns whether the specified 'class' is available or not.</para>
/// </summary>
[GodotMethod("class_exists")]
public static bool ClassExists(string @class)
@@ -77,7 +78,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_parent_class");
/// <summary>
- /// Returns whether 'inherits' is an ancestor of 'class' or not.
+ /// <para>Returns whether 'inherits' is an ancestor of 'class' or not.</para>
/// </summary>
[GodotMethod("is_parent_class")]
public static bool IsParentClass(string @class, string inherits)
@@ -89,7 +90,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "can_instance");
/// <summary>
- /// Returns true if you can instance objects from the specified 'class', false in other case.
+ /// <para>Returns true if you can instance objects from the specified 'class', false in other case.</para>
/// </summary>
[GodotMethod("can_instance")]
public static bool CanInstance(string @class)
@@ -101,7 +102,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "instance");
/// <summary>
- /// Creates an instance of 'class'.
+ /// <para>Creates an instance of 'class'.</para>
/// </summary>
[GodotMethod("instance")]
public static object Instance(string @class)
@@ -113,7 +114,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_has_signal");
/// <summary>
- /// Return whether 'class' or its ancestry has a signal called 'signal' or not.
+ /// <para>Return whether 'class' or its ancestry has a signal called 'signal' or not.</para>
/// </summary>
[GodotMethod("class_has_signal")]
public static bool ClassHasSignal(string @class, string signal)
@@ -125,7 +126,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_signal");
/// <summary>
- /// Returns the 'signal' data of 'class' or its ancestry. The returned value is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
+ /// <para>Returns the 'signal' data of 'class' or its ancestry. The returned value is a <see cref="Godot.Collections.Dictionary"/> with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).</para>
/// </summary>
[GodotMethod("class_get_signal")]
public static Godot.Collections.Dictionary ClassGetSignal(string @class, string signal)
@@ -137,7 +138,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_signal_list");
/// <summary>
- /// Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] as described in [method class_get_signal].
+ /// <para>Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a <see cref="Godot.Collections.Dictionary"/> as described in <see cref="Godot.ClassDB.ClassGetSignal"/>.</para>
/// </summary>
[GodotMethod("class_get_signal_list")]
public static Godot.Collections.Array ClassGetSignalList(string @class, bool noInheritance = false)
@@ -149,7 +150,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_property_list");
/// <summary>
- /// Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false.
+ /// <para>Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false.</para>
/// </summary>
[GodotMethod("class_get_property_list")]
public static Godot.Collections.Array ClassGetPropertyList(string @class, bool noInheritance = false)
@@ -161,7 +162,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_property");
/// <summary>
- /// Returns the value of 'property' of 'class' or its ancestry.
+ /// <para>Returns the value of 'property' of 'class' or its ancestry.</para>
/// </summary>
[GodotMethod("class_get_property")]
public static object ClassGetProperty(Object @object, string property)
@@ -173,7 +174,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_set_property");
/// <summary>
- /// Sets 'property' value of 'class' to 'value'.
+ /// <para>Sets 'property' value of 'class' to 'value'.</para>
/// </summary>
[GodotMethod("class_set_property")]
public static Error ClassSetProperty(Object @object, string property, object value)
@@ -185,7 +186,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_has_method");
/// <summary>
- /// Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not.
+ /// <para>Return whether 'class' (or its ancestry if 'no_inheritance' is false) has a method called 'method' or not.</para>
/// </summary>
[GodotMethod("class_has_method")]
public static bool ClassHasMethod(string @class, string method, bool noInheritance = false)
@@ -197,7 +198,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_method_list");
/// <summary>
- /// Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a [Dictionary] with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).
+ /// <para>Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a <see cref="Godot.Collections.Dictionary"/> with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage).</para>
/// </summary>
[GodotMethod("class_get_method_list")]
public static Godot.Collections.Array ClassGetMethodList(string @class, bool noInheritance = false)
@@ -209,7 +210,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_integer_constant_list");
/// <summary>
- /// Returns an array with the names all the integer constants of 'class' or its ancestry.
+ /// <para>Returns an array with the names all the integer constants of 'class' or its ancestry.</para>
/// </summary>
[GodotMethod("class_get_integer_constant_list")]
public static string[] ClassGetIntegerConstantList(string @class, bool noInheritance = false)
@@ -221,7 +222,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_has_integer_constant");
/// <summary>
- /// Return whether 'class' or its ancestry has an integer constant called 'name' or not.
+ /// <para>Return whether 'class' or its ancestry has an integer constant called 'name' or not.</para>
/// </summary>
[GodotMethod("class_has_integer_constant")]
public static bool ClassHasIntegerConstant(string @class, string name)
@@ -233,7 +234,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_integer_constant");
/// <summary>
- /// Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found.
+ /// <para>Returns the value of the integer constant 'name' of 'class' or its ancestry. Always returns 0 when the constant could not be found.</para>
/// </summary>
[GodotMethod("class_get_integer_constant")]
public static int ClassGetIntegerConstant(string @class, string name)
@@ -245,7 +246,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "class_get_category");
/// <summary>
- /// Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
+ /// <para>Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.</para>
/// </summary>
[GodotMethod("class_get_category")]
public static string ClassGetCategory(string @class)
@@ -257,7 +258,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_class_enabled");
/// <summary>
- /// Returns whether this class is enabled or not.
+ /// <para>Returns whether this class is enabled or not.</para>
/// </summary>
[GodotMethod("is_class_enabled")]
public static bool IsClassEnabled(string @class)
@@ -268,3 +269,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ClippedCamera.cs GodotSharp_after/GodotSharp/ObjectType/ClippedCamera.cs
--- GodotSharp_before/GodotSharp/ObjectType/ClippedCamera.cs 2019-03-20 21:16:54.840155200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ClippedCamera.cs 2019-03-23 19:57:08.056026400 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -281,3 +282,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CollisionObject.cs GodotSharp_after/GodotSharp/ObjectType/CollisionObject.cs
--- GodotSharp_before/GodotSharp/ObjectType/CollisionObject.cs 2019-03-20 21:16:54.845154000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CollisionObject.cs 2019-03-23 19:57:08.063026700 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// CollisionObject is the base class for physics objects. It can hold any number of collision [Shape]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods.
+ /// <para>CollisionObject is the base class for physics objects. It can hold any number of collision <see cref="Godot.Shape"/>s. Each shape must be assigned to a shape owner. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the <c>shape_owner_*</c> methods.</para>
/// </summary>
public abstract partial class CollisionObject : Spatial
{
/// <summary>
- /// If [code]true[/code], the [CollisionObject]'s shapes will respond to [RayCast]s. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the <see cref="Godot.CollisionObject"/>'s shapes will respond to <see cref="Godot.RayCast"/>s. Default value: <c>true</c>.</para>
/// </summary>
public bool InputRayPickable
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// If [code]true[/code], the [code]CollisionObject[/code] will continue to receive input events as the mouse is dragged across its shapes. Default value: [code]false[/code].
+ /// <para>If <c>true</c>, the <c>CollisionObject</c> will continue to receive input events as the mouse is dragged across its shapes. Default value: <c>false</c>.</para>
/// </summary>
public bool InputCaptureOnDrag
{
@@ -47,7 +48,7 @@
internal CollisionObject(bool memoryOwn) : base(memoryOwn) {}
/// <summary>
- /// Accepts unhandled [InputEvent]s. [code]click_position[/code] is the clicked location in world space and [code]click_normal[/code] is the normal vector extending from the clicked surface of the [Shape] at [code]shape_idx[/code]. Connect to the [code]input_event[/code] signal to easily pick up these events.
+ /// <para>Accepts unhandled <see cref="Godot.InputEvent"/>s. <c>click_position</c> is the clicked location in world space and <c>click_normal</c> is the normal vector extending from the clicked surface of the <see cref="Godot.Shape"/> at <c>shape_idx</c>. Connect to the <c>input_event</c> signal to easily pick up these events.</para>
/// </summary>
[GodotMethod("_input_event")]
public virtual void _InputEvent(Object camera, InputEvent @event, Vector3 clickPosition, Vector3 clickNormal, int shapeIdx)
@@ -95,7 +96,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_rid");
/// <summary>
- /// Returns the object's [RID].
+ /// <para>Returns the object's <see cref="Godot.RID"/>.</para>
/// </summary>
[GodotMethod("get_rid")]
public RID GetRid()
@@ -107,7 +108,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "create_shape_owner");
/// <summary>
- /// Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
+ /// <para>Creates a new shape owner for the given object. Returns <c>owner_id</c> of the new owner for future reference.</para>
/// </summary>
[GodotMethod("create_shape_owner")]
public int CreateShapeOwner(Object owner)
@@ -119,7 +120,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_shape_owner");
/// <summary>
- /// Removes the given shape owner.
+ /// <para>Removes the given shape owner.</para>
/// </summary>
[GodotMethod("remove_shape_owner")]
public void RemoveShapeOwner(int ownerId)
@@ -131,7 +132,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_shape_owners");
/// <summary>
- /// Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
+ /// <para>Returns an <see cref="Godot.Collections.Array"/> of <c>owner_id</c> identifiers. You can use these ids in other methods that take <c>owner_id</c> as an argument.</para>
/// </summary>
[GodotMethod("get_shape_owners")]
public Godot.Collections.Array GetShapeOwners()
@@ -143,7 +144,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_set_transform");
/// <summary>
- /// Sets the [Transform] of the given shape owner.
+ /// <para>Sets the <see cref="Godot.Transform"/> of the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_set_transform")]
public void ShapeOwnerSetTransform(int ownerId, Transform transform)
@@ -155,7 +156,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_transform");
/// <summary>
- /// Returns the shape owner's [Transform].
+ /// <para>Returns the shape owner's <see cref="Godot.Transform"/>.</para>
/// </summary>
[GodotMethod("shape_owner_get_transform")]
public Transform ShapeOwnerGetTransform(int ownerId)
@@ -167,7 +168,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_owner");
/// <summary>
- /// Returns the parent object of the given shape owner.
+ /// <para>Returns the parent object of the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_get_owner")]
public Object ShapeOwnerGetOwner(int ownerId)
@@ -179,7 +180,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_set_disabled");
/// <summary>
- /// If [code]true[/code], disables the given shape owner.
+ /// <para>If <c>true</c>, disables the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_set_disabled")]
public void ShapeOwnerSetDisabled(int ownerId, bool disabled)
@@ -191,7 +192,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_shape_owner_disabled");
/// <summary>
- /// If [code]true[/code], the shape owner and its shapes are disabled.
+ /// <para>If <c>true</c>, the shape owner and its shapes are disabled.</para>
/// </summary>
[GodotMethod("is_shape_owner_disabled")]
public bool IsShapeOwnerDisabled(int ownerId)
@@ -203,7 +204,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_add_shape");
/// <summary>
- /// Adds a [Shape] to the shape owner.
+ /// <para>Adds a <see cref="Godot.Shape"/> to the shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_add_shape")]
public void ShapeOwnerAddShape(int ownerId, Shape shape)
@@ -215,7 +216,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_shape_count");
/// <summary>
- /// Returns the number of shapes the given shape owner contains.
+ /// <para>Returns the number of shapes the given shape owner contains.</para>
/// </summary>
[GodotMethod("shape_owner_get_shape_count")]
public int ShapeOwnerGetShapeCount(int ownerId)
@@ -227,7 +228,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_shape");
/// <summary>
- /// Returns the [Shape] with the given id from the given shape owner.
+ /// <para>Returns the <see cref="Godot.Shape"/> with the given id from the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_get_shape")]
public Shape ShapeOwnerGetShape(int ownerId, int shapeId)
@@ -239,7 +240,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_shape_index");
/// <summary>
- /// Returns the child index of the [Shape] with the given id from the given shape owner.
+ /// <para>Returns the child index of the <see cref="Godot.Shape"/> with the given id from the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_get_shape_index")]
public int ShapeOwnerGetShapeIndex(int ownerId, int shapeId)
@@ -251,7 +252,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_remove_shape");
/// <summary>
- /// Removes a shape from the given shape owner.
+ /// <para>Removes a shape from the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_remove_shape")]
public void ShapeOwnerRemoveShape(int ownerId, int shapeId)
@@ -263,7 +264,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_clear_shapes");
/// <summary>
- /// Removes all shapes from the shape owner.
+ /// <para>Removes all shapes from the shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_clear_shapes")]
public void ShapeOwnerClearShapes(int ownerId)
@@ -275,7 +276,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_find_owner");
/// <summary>
- /// Returns the [code]owner_id[/code] of the given shape.
+ /// <para>Returns the <c>owner_id</c> of the given shape.</para>
/// </summary>
[GodotMethod("shape_find_owner")]
public int ShapeFindOwner(int shapeIndex)
@@ -286,3 +287,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CollisionObject2D.cs GodotSharp_after/GodotSharp/ObjectType/CollisionObject2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/CollisionObject2D.cs 2019-03-20 21:16:54.851151500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CollisionObject2D.cs 2019-03-23 19:57:08.069023300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision [Shape2D]s. Each shape must be assigned to a [i]shape owner[/i]. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the [code]shape_owner_*[/code] methods.
+ /// <para>CollisionObject2D is the base class for 2D physics objects. It can hold any number of 2D collision <see cref="Godot.Shape2D"/>s. Each shape must be assigned to a shape owner. The CollisionObject2D can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the <c>shape_owner_*</c> methods.</para>
/// </summary>
public abstract partial class CollisionObject2D : Node2D
{
/// <summary>
- /// If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events.
+ /// <para>If <c>true</c>, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events.</para>
/// </summary>
public bool InputPickable
{
@@ -32,7 +33,7 @@
internal CollisionObject2D(bool memoryOwn) : base(memoryOwn) {}
/// <summary>
- /// Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events.
+ /// <para>Accepts unhandled <see cref="Godot.InputEvent"/>s. <c>shape_idx</c> is the child index of the clicked <see cref="Godot.Shape2D"/>. Connect to the <c>input_event</c> signal to easily pick up these events.</para>
/// </summary>
[GodotMethod("_input_event")]
public virtual void _InputEvent(Object viewport, InputEvent @event, int shapeIdx)
@@ -44,7 +45,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_rid");
/// <summary>
- /// Returns the object's [RID].
+ /// <para>Returns the object's <see cref="Godot.RID"/>.</para>
/// </summary>
[GodotMethod("get_rid")]
public RID GetRid()
@@ -74,7 +75,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "create_shape_owner");
/// <summary>
- /// Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
+ /// <para>Creates a new shape owner for the given object. Returns <c>owner_id</c> of the new owner for future reference.</para>
/// </summary>
[GodotMethod("create_shape_owner")]
public int CreateShapeOwner(Object owner)
@@ -86,7 +87,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_shape_owner");
/// <summary>
- /// Removes the given shape owner.
+ /// <para>Removes the given shape owner.</para>
/// </summary>
[GodotMethod("remove_shape_owner")]
public void RemoveShapeOwner(int ownerId)
@@ -98,7 +99,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_shape_owners");
/// <summary>
- /// Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
+ /// <para>Returns an <see cref="Godot.Collections.Array"/> of <c>owner_id</c> identifiers. You can use these ids in other methods that take <c>owner_id</c> as an argument.</para>
/// </summary>
[GodotMethod("get_shape_owners")]
public Godot.Collections.Array GetShapeOwners()
@@ -110,7 +111,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_set_transform");
/// <summary>
- /// Sets the [Transform2D] of the given shape owner.
+ /// <para>Sets the <see cref="Godot.Transform2D"/> of the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_set_transform")]
public void ShapeOwnerSetTransform(int ownerId, Transform2D transform)
@@ -122,7 +123,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_transform");
/// <summary>
- /// Returns the shape owner's [Transform2D].
+ /// <para>Returns the shape owner's <see cref="Godot.Transform2D"/>.</para>
/// </summary>
[GodotMethod("shape_owner_get_transform")]
public Transform2D ShapeOwnerGetTransform(int ownerId)
@@ -134,7 +135,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_owner");
/// <summary>
- /// Returns the parent object of the given shape owner.
+ /// <para>Returns the parent object of the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_get_owner")]
public Object ShapeOwnerGetOwner(int ownerId)
@@ -146,7 +147,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_set_disabled");
/// <summary>
- /// If [code]true[/code], disables the given shape owner.
+ /// <para>If <c>true</c>, disables the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_set_disabled")]
public void ShapeOwnerSetDisabled(int ownerId, bool disabled)
@@ -158,7 +159,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_shape_owner_disabled");
/// <summary>
- /// If [code]true[/code], the shape owner and its shapes are disabled.
+ /// <para>If <c>true</c>, the shape owner and its shapes are disabled.</para>
/// </summary>
[GodotMethod("is_shape_owner_disabled")]
public bool IsShapeOwnerDisabled(int ownerId)
@@ -170,7 +171,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_set_one_way_collision");
/// <summary>
- /// If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s.
+ /// <para>If <c>enable</c> is <c>true</c>, collisions for the shape owner originating from this <c>CollisionObject2D</c> will not be reported to collided with <c>CollisionObject2D</c>s.</para>
/// </summary>
[GodotMethod("shape_owner_set_one_way_collision")]
public void ShapeOwnerSetOneWayCollision(int ownerId, bool enable)
@@ -182,7 +183,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_shape_owner_one_way_collision_enabled");
/// <summary>
- /// Returns [code]true[/code] if collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s.
+ /// <para>Returns <c>true</c> if collisions for the shape owner originating from this <c>CollisionObject2D</c> will not be reported to collided with <c>CollisionObject2D</c>s.</para>
/// </summary>
[GodotMethod("is_shape_owner_one_way_collision_enabled")]
public bool IsShapeOwnerOneWayCollisionEnabled(int ownerId)
@@ -218,7 +219,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_add_shape");
/// <summary>
- /// Adds a [Shape2D] to the shape owner.
+ /// <para>Adds a <see cref="Godot.Shape2D"/> to the shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_add_shape")]
public void ShapeOwnerAddShape(int ownerId, Shape2D shape)
@@ -230,7 +231,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_shape_count");
/// <summary>
- /// Returns the number of shapes the given shape owner contains.
+ /// <para>Returns the number of shapes the given shape owner contains.</para>
/// </summary>
[GodotMethod("shape_owner_get_shape_count")]
public int ShapeOwnerGetShapeCount(int ownerId)
@@ -242,7 +243,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_shape");
/// <summary>
- /// Returns the [Shape2D] with the given id from the given shape owner.
+ /// <para>Returns the <see cref="Godot.Shape2D"/> with the given id from the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_get_shape")]
public Shape2D ShapeOwnerGetShape(int ownerId, int shapeId)
@@ -254,7 +255,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_get_shape_index");
/// <summary>
- /// Returns the child index of the [Shape2D] with the given id from the given shape owner.
+ /// <para>Returns the child index of the <see cref="Godot.Shape2D"/> with the given id from the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_get_shape_index")]
public int ShapeOwnerGetShapeIndex(int ownerId, int shapeId)
@@ -266,7 +267,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_remove_shape");
/// <summary>
- /// Removes a shape from the given shape owner.
+ /// <para>Removes a shape from the given shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_remove_shape")]
public void ShapeOwnerRemoveShape(int ownerId, int shapeId)
@@ -278,7 +279,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_owner_clear_shapes");
/// <summary>
- /// Removes all shapes from the shape owner.
+ /// <para>Removes all shapes from the shape owner.</para>
/// </summary>
[GodotMethod("shape_owner_clear_shapes")]
public void ShapeOwnerClearShapes(int ownerId)
@@ -290,7 +291,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "shape_find_owner");
/// <summary>
- /// Returns the [code]owner_id[/code] of the given shape.
+ /// <para>Returns the <c>owner_id</c> of the given shape.</para>
/// </summary>
[GodotMethod("shape_find_owner")]
public int ShapeFindOwner(int shapeIndex)
@@ -301,3 +302,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CollisionPolygon.cs GodotSharp_after/GodotSharp/ObjectType/CollisionPolygon.cs
--- GodotSharp_before/GodotSharp/ObjectType/CollisionPolygon.cs 2019-03-20 21:16:54.856150000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CollisionPolygon.cs 2019-03-23 19:57:08.072022300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect.
+ /// <para>Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a <see cref="Godot.Shape"/> for gameplay. Properties modified during gameplay will have no effect.</para>
/// </summary>
public partial class CollisionPolygon : Spatial
{
/// <summary>
- /// Length that the resulting collision extends in either direction perpendicular to its polygon.
+ /// <para>Length that the resulting collision extends in either direction perpendicular to its polygon.</para>
/// </summary>
public float Depth
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// If true, no collision will be produced.
+ /// <para>If true, no collision will be produced.</para>
/// </summary>
public bool Disabled
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Array of vertices which define the polygon. Note that the returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the [code]polygon[/code] member.
+ /// <para>Array of vertices which define the polygon. Note that the returned value is a copy of the original. Methods which mutate the size or properties of the return value will not impact the original polygon. To change properties of the polygon, assign it to a temporary variable and make changes before reassigning the <c>polygon</c> member.</para>
/// </summary>
public Vector2[] Polygon
{
@@ -122,3 +123,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CollisionPolygon2D.cs GodotSharp_after/GodotSharp/ObjectType/CollisionPolygon2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/CollisionPolygon2D.cs 2019-03-20 21:16:54.860148300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CollisionPolygon2D.cs 2019-03-23 19:57:08.075021400 +0100
@@ -2,28 +2,29 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygon can be drawn in the editor or specified by a list of vertices.
+ /// <para>Provides a 2D collision polygon to a <see cref="Godot.CollisionObject2D"/> parent. Polygon can be drawn in the editor or specified by a list of vertices.</para>
/// </summary>
public partial class CollisionPolygon2D : Node2D
{
public enum BuildModeEnum
{
/// <summary>
- /// Collisions will include the polygon and its contained area.
+ /// <para>Collisions will include the polygon and its contained area.</para>
/// </summary>
Solids = 0,
/// <summary>
- /// Collisions will only include the polygon edges.
+ /// <para>Collisions will only include the polygon edges.</para>
/// </summary>
Segments = 1
}
/// <summary>
- /// Collision build mode. Use one of the [code]BUILD_*[/code] constants. Default value: [code]BUILD_SOLIDS[/code].
+ /// <para>Collision build mode. Use one of the <c>BUILD_*</c> constants. Default value: <c>BUILD_SOLIDS</c>.</para>
/// </summary>
public CollisionPolygon2D.BuildModeEnum BuildMode
{
@@ -38,7 +39,7 @@
}
/// <summary>
- /// The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the PoolVector2Array, not a reference.
+ /// <para>The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the PoolVector2Array, not a reference.</para>
/// </summary>
public Vector2[] Polygon
{
@@ -53,7 +54,7 @@
}
/// <summary>
- /// If [code]true[/code], no collisions will be detected.
+ /// <para>If <c>true</c>, no collisions will be detected.</para>
/// </summary>
public bool Disabled
{
@@ -68,7 +69,7 @@
}
/// <summary>
- /// If [code]true[/code], only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.
+ /// <para>If <c>true</c>, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects.</para>
/// </summary>
public bool OneWayCollision
{
@@ -200,3 +201,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CollisionShape.cs GodotSharp_after/GodotSharp/ObjectType/CollisionShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/CollisionShape.cs 2019-03-20 21:16:54.864148000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CollisionShape.cs 2019-03-23 19:57:08.078019800 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] to create a solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method CollisionObject.shape_owner_get_shape] to get the actual shape.
+ /// <para>Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an <see cref="Godot.Area"/> to give it a detection shape, or add it to a <see cref="Godot.PhysicsBody"/> to create a solid object. IMPORTANT: this is an Editor-only helper to create shapes, use <see cref="Godot.CollisionObject.ShapeOwnerGetShape"/> to get the actual shape.</para>
/// </summary>
public partial class CollisionShape : Spatial
{
/// <summary>
- /// The actual shape owned by this collision shape.
+ /// <para>The actual shape owned by this collision shape.</para>
/// </summary>
public Shape Shape
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// A disabled collision shape has no effect in the world.
+ /// <para>A disabled collision shape has no effect in the world.</para>
/// </summary>
public bool Disabled
{
@@ -54,7 +55,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "resource_changed");
/// <summary>
- /// If this method exists within a script it will be called whenever the shape resource has been modified.
+ /// <para>If this method exists within a script it will be called whenever the shape resource has been modified.</para>
/// </summary>
[GodotMethod("resource_changed")]
public void ResourceChanged(Resource resource)
@@ -102,7 +103,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_convex_from_brothers");
/// <summary>
- /// Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry.
+ /// <para>Sets the collision shape's shape to the addition of all its convexed <see cref="Godot.MeshInstance"/> siblings geometry.</para>
/// </summary>
[GodotMethod("make_convex_from_brothers")]
public void MakeConvexFromBrothers()
@@ -113,3 +114,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CollisionShape2D.cs GodotSharp_after/GodotSharp/ObjectType/CollisionShape2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/CollisionShape2D.cs 2019-03-20 21:16:54.867147700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CollisionShape2D.cs 2019-03-23 19:57:08.082018600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to create a solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method CollisionObject2D.shape_owner_get_shape] to get the actual shape.
+ /// <para>Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an <see cref="Godot.Area2D"/> to give it a detection shape, or add it to a <see cref="Godot.PhysicsBody2D"/> to create a solid object. IMPORTANT: this is an Editor-only helper to create shapes, use <see cref="Godot.CollisionObject2D.ShapeOwnerGetShape"/> to get the actual shape.</para>
/// </summary>
public partial class CollisionShape2D : Node2D
{
/// <summary>
- /// The actual shape owned by this collision shape.
+ /// <para>The actual shape owned by this collision shape.</para>
/// </summary>
public Shape2D Shape
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// A disabled collision shape has no effect in the world.
+ /// <para>A disabled collision shape has no effect in the world.</para>
/// </summary>
public bool Disabled
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Sets whether this collision shape should only detect collision on one side (top or bottom).
+ /// <para>Sets whether this collision shape should only detect collision on one side (top or bottom).</para>
/// </summary>
public bool OneWayCollision
{
@@ -155,3 +156,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ColorPicker.cs GodotSharp_after/GodotSharp/ObjectType/ColorPicker.cs
--- GodotSharp_before/GodotSharp/ObjectType/ColorPicker.cs 2019-03-20 21:16:54.871145300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ColorPicker.cs 2019-03-23 19:57:08.085017200 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// [Control] node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace.
+ /// <para><see cref="Godot.Control"/> node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace.</para>
/// </summary>
public partial class ColorPicker : BoxContainer
{
/// <summary>
- /// The currently selected color.
+ /// <para>The currently selected color.</para>
/// </summary>
public Color Color
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// If [code]true[/code], shows an alpha channel slider (transparency).
+ /// <para>If <c>true</c>, shows an alpha channel slider (transparency).</para>
/// </summary>
public bool EditAlpha
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
+ /// <para>If <c>true</c>, allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).</para>
/// </summary>
public bool RawMode
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).
+ /// <para>If <c>true</c>, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).</para>
/// </summary>
public bool DeferredMode
{
@@ -156,7 +157,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_preset");
/// <summary>
- /// Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for [i]this[/i] color picker.
+ /// <para>Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for this color picker.</para>
/// </summary>
[GodotMethod("add_preset")]
public void AddPreset(Color color)
@@ -168,7 +169,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "erase_preset");
/// <summary>
- /// Remove the given color from the list of color presets of this color picker.
+ /// <para>Remove the given color from the list of color presets of this color picker.</para>
/// </summary>
[GodotMethod("erase_preset")]
public void ErasePreset(Color color)
@@ -180,7 +181,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_presets");
/// <summary>
- /// Return the list of colors in the presets of the color picker.
+ /// <para>Return the list of colors in the presets of the color picker.</para>
/// </summary>
[GodotMethod("get_presets")]
public Color[] GetPresets()
@@ -191,3 +192,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ColorPickerButton.cs GodotSharp_after/GodotSharp/ObjectType/ColorPickerButton.cs
--- GodotSharp_before/GodotSharp/ObjectType/ColorPickerButton.cs 2019-03-20 21:16:54.874143700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ColorPickerButton.cs 2019-03-23 19:57:08.088016600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Encapsulates a [ColorPicker] making it accessible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility.
+ /// <para>Encapsulates a <see cref="Godot.ColorPicker"/> making it accessible by pressing a button. Pressing the button will toggle the <see cref="Godot.ColorPicker"/> visibility.</para>
/// </summary>
public partial class ColorPickerButton : Button
{
/// <summary>
- /// The currently selected color.
+ /// <para>The currently selected color.</para>
/// </summary>
public Color Color
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// If [code]true[/code], the alpha channel in the displayed [ColorPicker] will be visible. Default value: [code]true[/code].
+ /// <para>If <c>true</c>, the alpha channel in the displayed <see cref="Godot.ColorPicker"/> will be visible. Default value: <c>true</c>.</para>
/// </summary>
public bool EditAlpha
{
@@ -72,7 +73,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_picker");
/// <summary>
- /// Returns the [ColorPicker] that this node toggles.
+ /// <para>Returns the <see cref="Godot.ColorPicker"/> that this node toggles.</para>
/// </summary>
[GodotMethod("get_picker")]
public ColorPicker GetPicker()
@@ -84,7 +85,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_popup");
/// <summary>
- /// Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden.
+ /// <para>Returns the control's <see cref="Godot.PopupPanel"/> which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden.</para>
/// </summary>
[GodotMethod("get_popup")]
public PopupPanel GetPopup()
@@ -113,3 +114,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ColorRect.cs GodotSharp_after/GodotSharp/ObjectType/ColorRect.cs
--- GodotSharp_before/GodotSharp/ObjectType/ColorRect.cs 2019-03-20 21:16:54.876142600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ColorRect.cs 2019-03-23 19:57:08.090016100 +0100
@@ -2,19 +2,20 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Displays a colored rectangle.
+ /// <para>Displays a colored rectangle.</para>
/// </summary>
public partial class ColorRect : Control
{
/// <summary>
- /// The fill color.
- /// [codeblock]
+ /// <para>The fill color.</para>
+ /// <para><code>
/// $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red.
- /// [/codeblock]
+ /// </code></para>
/// </summary>
public Color Color
{
@@ -59,3 +60,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConcavePolygonShape.cs GodotSharp_after/GodotSharp/ObjectType/ConcavePolygonShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConcavePolygonShape.cs 2019-03-20 21:16:54.879141700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConcavePolygonShape.cs 2019-03-23 19:57:08.093014700 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles.
+ /// <para>Concave polygon shape resource, which can be set into a <see cref="Godot.PhysicsBody"/> or area. This shape is created by feeding a list of triangles.</para>
/// </summary>
public partial class ConcavePolygonShape : Shape
{
@@ -36,7 +37,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_faces");
/// <summary>
- /// Set the faces (an array of triangles).
+ /// <para>Set the faces (an array of triangles).</para>
/// </summary>
[GodotMethod("set_faces")]
public void SetFaces(Vector3[] faces)
@@ -48,7 +49,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_faces");
/// <summary>
- /// Return the faces (an array of triangles).
+ /// <para>Return the faces (an array of triangles).</para>
/// </summary>
[GodotMethod("get_faces")]
public Vector3[] GetFaces()
@@ -59,3 +60,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConcavePolygonShape2D.cs GodotSharp_after/GodotSharp/ObjectType/ConcavePolygonShape2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConcavePolygonShape2D.cs 2019-03-20 21:16:54.882141200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConcavePolygonShape2D.cs 2019-03-23 19:57:08.096014000 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.
- /// The main difference between a [ConvexPolygonShape2D] and a [code]ConcavePolygonShape2D[/code] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
+ /// <para>Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for <see cref="Godot.RigidBody2D"/> nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.</para>
+ /// <para>The main difference between a <see cref="Godot.ConvexPolygonShape2D"/> and a <c>ConcavePolygonShape2D</c> is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.</para>
/// </summary>
public partial class ConcavePolygonShape2D : Shape2D
{
/// <summary>
- /// The array of points that make up the [code]ConcavePolygonShape2D[/code]'s line segments.
+ /// <para>The array of points that make up the <c>ConcavePolygonShape2D</c>'s line segments.</para>
/// </summary>
public Vector2[] Segments
{
@@ -57,3 +58,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConeTwistJoint.cs GodotSharp_after/GodotSharp/ObjectType/ConeTwistJoint.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConeTwistJoint.cs 2019-03-20 21:16:54.886140200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConeTwistJoint.cs 2019-03-23 19:57:08.100013000 +0100
@@ -2,54 +2,55 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint].
- /// The twist axis is initiated as the x-axis of the [Joint].
- /// Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies.
+ /// <para>The joint can rotate the bodies across an axis defined by the local x-axes of the <see cref="Godot.Joint"/>.</para>
+ /// <para>The twist axis is initiated as the x-axis of the <see cref="Godot.Joint"/>.</para>
+ /// <para>Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies.</para>
/// </summary>
public partial class ConeTwistJoint : Joint
{
public enum Param
{
/// <summary>
- /// Swing is rotation from side to side, around the axis perpendicular to the twist axis.
- /// The swing span defines, how much rotation will not get corrected allong the swing axis.
- /// Could be defined as looseness in the [code]ConeTwistJoint[/code].
- /// If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code].
+ /// <para>Swing is rotation from side to side, around the axis perpendicular to the twist axis.</para>
+ /// <para>The swing span defines, how much rotation will not get corrected allong the swing axis.</para>
+ /// <para>Could be defined as looseness in the <c>ConeTwistJoint</c>.</para>
+ /// <para>If below 0.05, this behaviour is locked. Default value: <c>PI/4</c>.</para>
/// </summary>
SwingSpan = 0,
/// <summary>
- /// Twist is the rotation around the twist axis, this value defined how far the joint can twist.
- /// Twist is locked if below 0.05.
+ /// <para>Twist is the rotation around the twist axis, this value defined how far the joint can twist.</para>
+ /// <para>Twist is locked if below 0.05.</para>
/// </summary>
TwistSpan = 1,
/// <summary>
- /// The speed with which the swing or twist will take place.
- /// The higher, the faster.
+ /// <para>The speed with which the swing or twist will take place.</para>
+ /// <para>The higher, the faster.</para>
/// </summary>
Bias = 2,
/// <summary>
- /// The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
+ /// <para>The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.</para>
/// </summary>
Softness = 3,
/// <summary>
- /// Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
+ /// <para>Defines, how fast the swing- and twist-speed-difference on both sides gets synced.</para>
/// </summary>
Relaxation = 4,
/// <summary>
- /// End flag of PARAM_* constants, used internally.
+ /// <para>End flag of PARAM_* constants, used internally.</para>
/// </summary>
Max = 5
}
/// <summary>
- /// Swing is rotation from side to side, around the axis perpendicular to the twist axis.
- /// The swing span defines, how much rotation will not get corrected allong the swing axis.
- /// Could be defined as looseness in the [code]ConeTwistJoint[/code].
- /// If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code].
+ /// <para>Swing is rotation from side to side, around the axis perpendicular to the twist axis.</para>
+ /// <para>The swing span defines, how much rotation will not get corrected allong the swing axis.</para>
+ /// <para>Could be defined as looseness in the <c>ConeTwistJoint</c>.</para>
+ /// <para>If below 0.05, this behaviour is locked. Default value: <c>PI/4</c>.</para>
/// </summary>
public float SwingSpan
{
@@ -64,8 +65,8 @@
}
/// <summary>
- /// Twist is the rotation around the twist axis, this value defined how far the joint can twist.
- /// Twist is locked if below 0.05.
+ /// <para>Twist is the rotation around the twist axis, this value defined how far the joint can twist.</para>
+ /// <para>Twist is locked if below 0.05.</para>
/// </summary>
public float TwistSpan
{
@@ -80,8 +81,8 @@
}
/// <summary>
- /// The speed with which the swing or twist will take place.
- /// The higher, the faster.
+ /// <para>The speed with which the swing or twist will take place.</para>
+ /// <para>The higher, the faster.</para>
/// </summary>
public float Bias
{
@@ -96,7 +97,7 @@
}
/// <summary>
- /// The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
+ /// <para>The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.</para>
/// </summary>
public float Softness
{
@@ -111,7 +112,7 @@
}
/// <summary>
- /// Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
+ /// <para>Defines, how fast the swing- and twist-speed-difference on both sides gets synced.</para>
/// </summary>
public float Relaxation
{
@@ -188,3 +189,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConfigFile.cs GodotSharp_after/GodotSharp/ObjectType/ConfigFile.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConfigFile.cs 2019-03-20 21:16:54.891139000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConfigFile.cs 2019-03-23 19:57:08.104011200 +0100
@@ -2,20 +2,21 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This helper class can be used to store [Variant] values on the filesystem using INI-style formatting. The stored values are identified by a section and a key:
- /// [codeblock]
+ /// <para>This helper class can be used to store <c>Variant</c> values on the filesystem using INI-style formatting. The stored values are identified by a section and a key:</para>
+ /// <para><code>
/// [section]
/// some_key=42
/// string_example="Hello World!"
/// a_vector=Vector3( 1, 0, 2 )
- /// [/codeblock]
- /// The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem.
- /// The following example shows how to parse an INI-style file from the system, read its contents and store new values in it:
- /// [codeblock]
+ /// </code></para>
+ /// <para>The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem.</para>
+ /// <para>The following example shows how to parse an INI-style file from the system, read its contents and store new values in it:</para>
+ /// <para><code>
/// var config = ConfigFile.new()
/// var err = config.load("user://settings.cfg")
/// if err == OK: # if not, something went wrong with the file loading
@@ -26,8 +27,8 @@
/// config.set_value("audio", "mute", false)
/// # Save the changes by overwriting the previous file
/// config.save("user://settings.cfg")
- /// [/codeblock]
- /// Keep in mind that section and property names can't contain spaces. Anything after a space will be ignored on save and on load.
+ /// </code></para>
+ /// <para>Keep in mind that section and property names can't contain spaces. Anything after a space will be ignored on save and on load.</para>
/// </summary>
public partial class ConfigFile : Reference
{
@@ -45,7 +46,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_value");
/// <summary>
- /// Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
+ /// <para>Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a <c>null</c> value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.</para>
/// </summary>
[GodotMethod("set_value")]
public void SetValue(string section, string key, object value)
@@ -57,7 +58,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_value");
/// <summary>
- /// Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [code]default[/code] argument, or [code]null[/code] if it is omitted.
+ /// <para>Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional <c>default</c> argument, or <c>null</c> if it is omitted.</para>
/// </summary>
[GodotMethod("get_value")]
public object GetValue(string section, string key, object @default = null)
@@ -69,7 +70,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "has_section");
/// <summary>
- /// Returns [code]true[/code] if the specified section exists.
+ /// <para>Returns <c>true</c> if the specified section exists.</para>
/// </summary>
[GodotMethod("has_section")]
public bool HasSection(string section)
@@ -81,7 +82,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "has_section_key");
/// <summary>
- /// Returns [code]true[/code] if the specified section-key pair exists.
+ /// <para>Returns <c>true</c> if the specified section-key pair exists.</para>
/// </summary>
[GodotMethod("has_section_key")]
public bool HasSectionKey(string section, string key)
@@ -93,7 +94,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_sections");
/// <summary>
- /// Returns an array of all defined section identifiers.
+ /// <para>Returns an array of all defined section identifiers.</para>
/// </summary>
[GodotMethod("get_sections")]
public string[] GetSections()
@@ -105,7 +106,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_section_keys");
/// <summary>
- /// Returns an array of all defined key identifiers in the specified section.
+ /// <para>Returns an array of all defined key identifiers in the specified section.</para>
/// </summary>
[GodotMethod("get_section_keys")]
public string[] GetSectionKeys(string section)
@@ -117,7 +118,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "erase_section");
/// <summary>
- /// Deletes the specified section along with all the key-value pairs inside.
+ /// <para>Deletes the specified section along with all the key-value pairs inside.</para>
/// </summary>
[GodotMethod("erase_section")]
public void EraseSection(string section)
@@ -129,7 +130,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "load");
/// <summary>
- /// Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [code]OK[/code].
+ /// <para>Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the <c>OK</c>, <c>FAILED</c> or <c>ERR_*</c> constants listed in <c>@GlobalScope</c>. If the load was successful, the return value is <c>OK</c>.</para>
/// </summary>
[GodotMethod("load")]
public Error Load(string path)
@@ -141,7 +142,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "save");
/// <summary>
- /// Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [code]OK[/code].
+ /// <para>Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the <c>OK</c>, <c>FAILED</c> or <c>ERR_*</c> constants listed in <c>@GlobalScope</c>. If the load was successful, the return value is <c>OK</c>.</para>
/// </summary>
[GodotMethod("save")]
public Error Save(string path)
@@ -152,3 +153,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConfirmationDialog.cs GodotSharp_after/GodotSharp/ObjectType/ConfirmationDialog.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConfirmationDialog.cs 2019-03-20 21:16:54.894138400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConfirmationDialog.cs 2019-03-23 19:57:08.106010800 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order).
+ /// <para>Dialog for confirmation of actions. This dialog inherits from <see cref="Godot.AcceptDialog"/>, but has by default an OK and Cancel button (in host OS order).</para>
/// </summary>
public partial class ConfirmationDialog : AcceptDialog
{
@@ -24,7 +25,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_cancel");
/// <summary>
- /// Return the cancel button.
+ /// <para>Return the cancel button.</para>
/// </summary>
[GodotMethod("get_cancel")]
public Button GetCancel()
@@ -35,3 +36,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Container.cs GodotSharp_after/GodotSharp/ObjectType/Container.cs
--- GodotSharp_before/GodotSharp/ObjectType/Container.cs 2019-03-20 21:16:54.897136200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Container.cs 2019-03-23 19:57:08.108010000 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Base node for containers. A [code]Container[/code] contains other controls and automatically arranges them in a certain way.
- /// A Control can inherit this to create custom container classes.
+ /// <para>Base node for containers. A <c>Container</c> contains other controls and automatically arranges them in a certain way.</para>
+ /// <para>A Control can inherit this to create custom container classes.</para>
/// </summary>
public partial class Container : Control
{
/// <summary>
- /// Notification for when sorting the children, it must be obeyed immediately.
+ /// <para>Notification for when sorting the children, it must be obeyed immediately.</para>
/// </summary>
public const int NotificationSortChildren = 50;
@@ -30,7 +31,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "queue_sort");
/// <summary>
- /// Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
+ /// <para>Queue resort of the contained children. This is called automatically anyway, but can be called upon request.</para>
/// </summary>
[GodotMethod("queue_sort")]
public void QueueSort()
@@ -42,7 +43,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "fit_child_in_rect");
/// <summary>
- /// Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
+ /// <para>Fit a child control in a given rect. This is mainly a helper for creating custom container classes.</para>
/// </summary>
[GodotMethod("fit_child_in_rect")]
public void FitChildInRect(Control child, Rect2 rect)
@@ -53,3 +54,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Control.cs GodotSharp_after/GodotSharp/ObjectType/Control.cs
--- GodotSharp_before/GodotSharp/ObjectType/Control.cs 2019-03-20 21:16:54.918130000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Control.cs 2019-03-23 19:57:08.135000900 +0100
@@ -2,65 +2,66 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Base class for all User Interface or [i]UI[/i] related nodes. [code]Control[/code] features a bounding rectangle that defines its extents, an anchor position relative to its parent and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change.
- /// For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from [code]Control[/code] and [Container] nodes.
- /// [b]User Interface nodes and input[/b]
- /// Godot sends input events to the scene's root node first, by calling [method Node._input]. [method Node._input] forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls [method MainLoop._input_event]. Call [method accept_event] so no other node receives the event. Once you accepted an input, it becomes handled so [method Node._unhandled_input] will not process it.
- /// Only one [code]Control[/code] node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call [method grab_focus]. [code]Control[/code] nodes lose focus when another node grabs it, or if you hide the node in focus.
- /// Set [member mouse_filter] to [constant MOUSE_FILTER_IGNORE] to tell a [code]Control[/code] node to ignore mouse or touch events. You'll need it if you place an icon on top of a button.
- /// [Theme] resources change the Control's appearance. If you change the [Theme] on a [code]Control[/code] node, it affects all of its children. To override some of the theme's parameters, call one of the [code]add_*_override[/code] methods, like [method add_font_override]. You can override the theme with the inspector.
+ /// <para>Base class for all User Interface or UI related nodes. <c>Control</c> features a bounding rectangle that defines its extents, an anchor position relative to its parent and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change.</para>
+ /// <para>For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from <c>Control</c> and <see cref="Godot.Container"/> nodes.</para>
+ /// <para>User Interface nodes and input</para>
+ /// <para>Godot sends input events to the scene's root node first, by calling <see cref="Godot.Node._Input"/>. <see cref="Godot.Node._Input"/> forwards the event down the node tree to the nodes under the mouse cursor, or on keyboard focus. To do so, it calls <see cref="Godot.MainLoop._InputEvent"/>. Call <see cref="Godot.Control.AcceptEvent"/> so no other node receives the event. Once you accepted an input, it becomes handled so <see cref="Godot.Node._UnhandledInput"/> will not process it.</para>
+ /// <para>Only one <c>Control</c> node can be in keyboard focus. Only the node in focus will receive keyboard events. To get the focus, call <see cref="Godot.Control.GrabFocus"/>. <c>Control</c> nodes lose focus when another node grabs it, or if you hide the node in focus.</para>
+ /// <para>Set <see cref="Godot.Control.MouseFilter"/> to [constant MOUSE_FILTER_IGNORE] to tell a <c>Control</c> node to ignore mouse or touch events. You'll need it if you place an icon on top of a button.</para>
+ /// <para><see cref="Godot.Theme"/> resources change the Control's appearance. If you change the <see cref="Godot.Theme"/> on a <c>Control</c> node, it affects all of its children. To override some of the theme's parameters, call one of the <c>add_*_override</c> methods, like <see cref="Godot.Control.AddFontOverride"/>. You can override the theme with the inspector.</para>
/// </summary>
public partial class Control : CanvasItem
{
/// <summary>
- /// Sent when the node changes size. Use [member rect_size] to get the new size.
+ /// <para>Sent when the node changes size. Use <see cref="Godot.Control.RectSize"/> to get the new size.</para>
/// </summary>
public const int NotificationResized = 40;
/// <summary>
- /// Sent when the mouse pointer enters the node.
+ /// <para>Sent when the mouse pointer enters the node.</para>
/// </summary>
public const int NotificationMouseEnter = 41;
/// <summary>
- /// Sent when the mouse pointer exits the node.
+ /// <para>Sent when the mouse pointer exits the node.</para>
/// </summary>
public const int NotificationMouseExit = 42;
/// <summary>
- /// Sent when the node grabs focus.
+ /// <para>Sent when the node grabs focus.</para>
/// </summary>
public const int NotificationFocusEnter = 43;
/// <summary>
- /// Sent when the node loses focus.
+ /// <para>Sent when the node loses focus.</para>
/// </summary>
public const int NotificationFocusExit = 44;
/// <summary>
- /// Sent when the node's [member theme] changes, right before Godot redraws the control. Happens when you call one of the [code]add_*_override[/code] methods.
+ /// <para>Sent when the node's <see cref="Godot.Control.Theme"/> changes, right before Godot redraws the control. Happens when you call one of the <c>add_*_override</c> methods.</para>
/// </summary>
public const int NotificationThemeChanged = 45;
/// <summary>
- /// Sent when an open modal dialog closes. See [method show_modal].
+ /// <para>Sent when an open modal dialog closes. See <see cref="Godot.Control.ShowModal"/>.</para>
/// </summary>
public const int NotificationModalClose = 46;
/// <summary>
- /// Sent when this node is inside a [ScrollContainer] which has begun being scrolled.
+ /// <para>Sent when this node is inside a <see cref="Godot.ScrollContainer"/> which has begun being scrolled.</para>
/// </summary>
public const int NotificationScrollBegin = 47;
/// <summary>
- /// Sent when this node is inside a [ScrollContainer] which has stopped being scrolled.
+ /// <para>Sent when this node is inside a <see cref="Godot.ScrollContainer"/> which has stopped being scrolled.</para>
/// </summary>
public const int NotificationScrollEnd = 48;
public enum Anchor
{
/// <summary>
- /// Snaps one of the 4 anchor's sides to the origin of the node's [code]Rect[/code], in the top left. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset].
+ /// <para>Snaps one of the 4 anchor's sides to the origin of the node's <c>Rect</c>, in the top left. Use it with one of the <c>anchor_*</c> member variables, like <see cref="Godot.Control.AnchorLeft"/>. To change all 4 anchors at once, use <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
Begin = 0,
/// <summary>
- /// Snaps one of the 4 anchor's sides to the end of the node's [code]Rect[/code], in the bottom right. Use it with one of the [code]anchor_*[/code] member variables, like [member anchor_left]. To change all 4 anchors at once, use [method set_anchors_preset].
+ /// <para>Snaps one of the 4 anchor's sides to the end of the node's <c>Rect</c>, in the bottom right. Use it with one of the <c>anchor_*</c> member variables, like <see cref="Godot.Control.AnchorLeft"/>. To change all 4 anchors at once, use <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
End = 1
}
@@ -68,15 +69,15 @@
public enum FocusModeEnum
{
/// <summary>
- /// The node cannot grab focus. Use with [member focus_mode].
+ /// <para>The node cannot grab focus. Use with <see cref="Godot.Control.FocusMode"/>.</para>
/// </summary>
None = 0,
/// <summary>
- /// The node can only grab focus on mouse clicks. Use with [member focus_mode].
+ /// <para>The node can only grab focus on mouse clicks. Use with <see cref="Godot.Control.FocusMode"/>.</para>
/// </summary>
Click = 1,
/// <summary>
- /// The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member focus_mode].
+ /// <para>The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with <see cref="Godot.Control.FocusMode"/>.</para>
/// </summary>
All = 2
}
@@ -104,15 +105,15 @@
public enum MouseFilterEnum
{
/// <summary>
- /// The control will receive mouse button input events through [method _gui_input] if clicked on. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. These events are automatically marked as handled and they will not propagate further to other controls. This also results in blocking signals in other controls.
+ /// <para>The control will receive mouse button input events through <see cref="Godot.Control._GuiInput"/> if clicked on. And the control will receive the <c>mouse_entered</c> and <c>mouse_exited</c> signals. These events are automatically marked as handled and they will not propagate further to other controls. This also results in blocking signals in other controls.</para>
/// </summary>
Stop = 0,
/// <summary>
- /// The control will receive mouse button input events through [method _gui_input] if clicked on. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. If this control does not handle the event, the parent control (if any) will be considered, and so on until there is no more parent control to potentially handle it. This also allows signals to fire in other controls. Even if no control handled it at all, the event will still be handled automatically, so unhandled input will not be fired.
+ /// <para>The control will receive mouse button input events through <see cref="Godot.Control._GuiInput"/> if clicked on. And the control will receive the <c>mouse_entered</c> and <c>mouse_exited</c> signals. If this control does not handle the event, the parent control (if any) will be considered, and so on until there is no more parent control to potentially handle it. This also allows signals to fire in other controls. Even if no control handled it at all, the event will still be handled automatically, so unhandled input will not be fired.</para>
/// </summary>
Pass = 1,
/// <summary>
- /// The control will not receive mouse button input events through [method _gui_input]. Also the control will not receive the [signal mouse_entered] nor [signal mouse_exited] signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically.
+ /// <para>The control will not receive mouse button input events through <see cref="Godot.Control._GuiInput"/>. Also the control will not receive the <c>mouse_entered</c> nor <c>mouse_exited</c> signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically.</para>
/// </summary>
Ignore = 2
}
@@ -120,71 +121,71 @@
public enum CursorShape
{
/// <summary>
- /// Show the system's arrow mouse cursor when the user hovers the node. Use with [member mouse_default_cursor_shape].
+ /// <para>Show the system's arrow mouse cursor when the user hovers the node. Use with <see cref="Godot.Control.MouseDefaultCursorShape"/>.</para>
/// </summary>
Arrow = 0,
/// <summary>
- /// Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text.
+ /// <para>Show the system's I-beam mouse cursor when the user hovers the node. The I-beam pointer has a shape similar to "I". It tells the user they can highlight or insert text.</para>
/// </summary>
Ibeam = 1,
/// <summary>
- /// Show the system's pointing hand mouse cursor when the user hovers the node.
+ /// <para>Show the system's pointing hand mouse cursor when the user hovers the node.</para>
/// </summary>
PointingHand = 2,
/// <summary>
- /// Show the system's cross mouse cursor when the user hovers the node.
+ /// <para>Show the system's cross mouse cursor when the user hovers the node.</para>
/// </summary>
Cross = 3,
/// <summary>
- /// Show the system's wait mouse cursor, often an hourglass, when the user hovers the node.
+ /// <para>Show the system's wait mouse cursor, often an hourglass, when the user hovers the node.</para>
/// </summary>
Wait = 4,
/// <summary>
- /// Show the system's busy mouse cursor when the user hovers the node. Often an hourglass.
+ /// <para>Show the system's busy mouse cursor when the user hovers the node. Often an hourglass.</para>
/// </summary>
Busy = 5,
/// <summary>
- /// Show the system's drag mouse cursor, often a closed fist or a cross symbol, when the user hovers the node. It tells the user they're currently dragging an item, like a node in the Scene dock.
+ /// <para>Show the system's drag mouse cursor, often a closed fist or a cross symbol, when the user hovers the node. It tells the user they're currently dragging an item, like a node in the Scene dock.</para>
/// </summary>
Drag = 6,
/// <summary>
- /// Show the system's drop mouse cursor when the user hovers the node. It can be an open hand. It tells the user they can drop an item they're currently grabbing, like a node in the Scene dock.
+ /// <para>Show the system's drop mouse cursor when the user hovers the node. It can be an open hand. It tells the user they can drop an item they're currently grabbing, like a node in the Scene dock.</para>
/// </summary>
CanDrop = 7,
/// <summary>
- /// Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle.
+ /// <para>Show the system's forbidden mouse cursor when the user hovers the node. Often a crossed circle.</para>
/// </summary>
Forbidden = 8,
/// <summary>
- /// Show the system's vertical resize mouse cursor when the user hovers the node. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically.
+ /// <para>Show the system's vertical resize mouse cursor when the user hovers the node. A double headed vertical arrow. It tells the user they can resize the window or the panel vertically.</para>
/// </summary>
Vsize = 9,
/// <summary>
- /// Show the system's horizontal resize mouse cursor when the user hovers the node. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.
+ /// <para>Show the system's horizontal resize mouse cursor when the user hovers the node. A double headed horizontal arrow. It tells the user they can resize the window or the panel horizontally.</para>
/// </summary>
Hsize = 10,
/// <summary>
- /// Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically.
+ /// <para>Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically.</para>
/// </summary>
Bdiagsize = 11,
/// <summary>
- /// Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of [code]CURSOR_BDIAGSIZE[/code]. It tells the user they can resize the window or the panel both horizontally and vertically.
+ /// <para>Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double headed arrow that goes from the top left to the bottom right, the opposite of <c>CURSOR_BDIAGSIZE</c>. It tells the user they can resize the window or the panel both horizontally and vertically.</para>
/// </summary>
Fdiagsize = 12,
/// <summary>
- /// Show the system's move mouse cursor when the user hovers the node. It shows 2 double-headed arrows at a 90 degree angle. It tells the user they can move a UI element freely.
+ /// <para>Show the system's move mouse cursor when the user hovers the node. It shows 2 double-headed arrows at a 90 degree angle. It tells the user they can move a UI element freely.</para>
/// </summary>
Move = 13,
/// <summary>
- /// Show the system's vertical split mouse cursor when the user hovers the node. On Windows, it's the same as [code]CURSOR_VSIZE[/code].
+ /// <para>Show the system's vertical split mouse cursor when the user hovers the node. On Windows, it's the same as <c>CURSOR_VSIZE</c>.</para>
/// </summary>
Vsplit = 14,
/// <summary>
- /// Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as [code]CURSOR_HSIZE[/code].
+ /// <para>Show the system's horizontal split mouse cursor when the user hovers the node. On Windows, it's the same as <c>CURSOR_HSIZE</c>.</para>
/// </summary>
Hsplit = 15,
/// <summary>
- /// Show the system's help mouse cursor when the user hovers the node, a question mark.
+ /// <para>Show the system's help mouse cursor when the user hovers the node, a question mark.</para>
/// </summary>
Help = 16
}
@@ -192,15 +193,15 @@
public enum GrowDirection
{
/// <summary>
- /// The control will grow to the left or top to make up if its minimum size is changed to be greater than its current size on the respective axis.
+ /// <para>The control will grow to the left or top to make up if its minimum size is changed to be greater than its current size on the respective axis.</para>
/// </summary>
Begin = 0,
/// <summary>
- /// The control will grow to the right or bottom to make up if its minimum size is changed to be greater than its current size on the respective axis.
+ /// <para>The control will grow to the right or bottom to make up if its minimum size is changed to be greater than its current size on the respective axis.</para>
/// </summary>
End = 1,
/// <summary>
- /// The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size.
+ /// <para>The control will grow in both directions equally to make up if its minimum size is changed to be greater than its current size.</para>
/// </summary>
Both = 2
}
@@ -208,23 +209,23 @@
public enum SizeFlags
{
/// <summary>
- /// Tells the parent [Container] to expand the bounds of this node to fill all the available space without pushing any other node. Use with [member size_flags_horizontal] and [member size_flags_vertical].
+ /// <para>Tells the parent <see cref="Godot.Container"/> to expand the bounds of this node to fill all the available space without pushing any other node. Use with <see cref="Godot.Control.SizeFlagsHorizontal"/> and <see cref="Godot.Control.SizeFlagsVertical"/>.</para>
/// </summary>
Fill = 1,
/// <summary>
- /// Tells the parent [Container] to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See [member size_flags_stretch_ratio]. Use with [member size_flags_horizontal] and [member size_flags_vertical].
+ /// <para>Tells the parent <see cref="Godot.Container"/> to let this node take all the available space on the axis you flag. If multiple neighboring nodes are set to expand, they'll share the space based on their stretch ratio. See <see cref="Godot.Control.SizeFlagsStretchRatio"/>. Use with <see cref="Godot.Control.SizeFlagsHorizontal"/> and <see cref="Godot.Control.SizeFlagsVertical"/>.</para>
/// </summary>
Expand = 2,
/// <summary>
- /// Sets the node's size flags to both fill and expand. See the 2 constants above for more information.
+ /// <para>Sets the node's size flags to both fill and expand. See the 2 constants above for more information.</para>
/// </summary>
ExpandFill = 3,
/// <summary>
- /// Tells the parent [Container] to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical].
+ /// <para>Tells the parent <see cref="Godot.Container"/> to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with <see cref="Godot.Control.SizeFlagsHorizontal"/> and <see cref="Godot.Control.SizeFlagsVertical"/>.</para>
/// </summary>
ShrinkCenter = 4,
/// <summary>
- /// Tells the parent [Container] to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical].
+ /// <para>Tells the parent <see cref="Godot.Container"/> to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with <see cref="Godot.Control.SizeFlagsHorizontal"/> and <see cref="Godot.Control.SizeFlagsVertical"/>.</para>
/// </summary>
ShrinkEnd = 8
}
@@ -232,73 +233,73 @@
public enum LayoutPreset
{
/// <summary>
- /// Snap all 4 anchors to the top-left of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the top-left of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
TopLeft = 0,
/// <summary>
- /// Snap all 4 anchors to the top-right of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the top-right of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
TopRight = 1,
/// <summary>
- /// Snap all 4 anchors to the bottom-left of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the bottom-left of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
BottomLeft = 2,
/// <summary>
- /// Snap all 4 anchors to the bottom-right of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the bottom-right of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
BottomRight = 3,
/// <summary>
- /// Snap all 4 anchors to the center of the left edge of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the center of the left edge of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
CenterLeft = 4,
/// <summary>
- /// Snap all 4 anchors to the center of the top edge of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the center of the top edge of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
CenterTop = 5,
/// <summary>
- /// Snap all 4 anchors to the center of the right edge of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the center of the right edge of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
CenterRight = 6,
/// <summary>
- /// Snap all 4 anchors to the center of the bottom edge of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the center of the bottom edge of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
CenterBottom = 7,
/// <summary>
- /// Snap all 4 anchors to the center of the parent control's bounds. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the center of the parent control's bounds. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
Center = 8,
/// <summary>
- /// Snap all 4 anchors to the left edge of the parent control. The left margin becomes relative to the left edge and the top margin relative to the top left corner of the node's parent. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the left edge of the parent control. The left margin becomes relative to the left edge and the top margin relative to the top left corner of the node's parent. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
LeftWide = 9,
/// <summary>
- /// Snap all 4 anchors to the top edge of the parent control. The left margin becomes relative to the top left corner, the top margin relative to the top edge, and the right margin relative to the top right corner of the node's parent. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the top edge of the parent control. The left margin becomes relative to the top left corner, the top margin relative to the top edge, and the right margin relative to the top right corner of the node's parent. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
TopWide = 10,
/// <summary>
- /// Snap all 4 anchors to the right edge of the parent control. The right margin becomes relative to the right edge and the top margin relative to the top right corner of the node's parent. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the right edge of the parent control. The right margin becomes relative to the right edge and the top margin relative to the top right corner of the node's parent. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
RightWide = 11,
/// <summary>
- /// Snap all 4 anchors to the bottom edge of the parent control. The left margin becomes relative to the bottom left corner, the bottom margin relative to the bottom edge, and the right margin relative to the bottom right corner of the node's parent. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the bottom edge of the parent control. The left margin becomes relative to the bottom left corner, the bottom margin relative to the bottom edge, and the right margin relative to the bottom right corner of the node's parent. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
BottomWide = 12,
/// <summary>
- /// Snap all 4 anchors to a vertical line that cuts the parent control in half. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to a vertical line that cuts the parent control in half. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
VcenterWide = 13,
/// <summary>
- /// Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to a horizontal line that cuts the parent control in half. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
HcenterWide = 14,
/// <summary>
- /// Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the [code]Control[/code] will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with [method set_anchors_preset].
+ /// <para>Snap all 4 anchors to the respective corners of the parent control. Set all 4 margins to 0 after you applied this preset and the <c>Control</c> will fit its parent control. This is equivalent to to the "Full Rect" layout option in the editor. Use with <see cref="Godot.Control.SetAnchorsPreset"/>.</para>
/// </summary>
Wide = 15
}
/// <summary>
- /// Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience.Default value: [code]ANCHOR_BEGIN[/code].
+ /// <para>Anchors the left edge of the node to the origin, the center or the end of its parent control. It changes how the left margin updates when the node moves or changes size. You can use one of the <c>ANCHOR_*</c> constants for convenience.Default value: <c>ANCHOR_BEGIN</c>.</para>
/// </summary>
public float AnchorLeft
{
@@ -313,7 +314,7 @@
}
/// <summary>
- /// Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. Default value: [code]ANCHOR_BEGIN[/code].
+ /// <para>Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use one of the <c>ANCHOR_*</c> constants for convenience. Default value: <c>ANCHOR_BEGIN</c>.</para>
/// </summary>
public float AnchorTop
{
@@ -328,7 +329,7 @@
}
/// <summary>
- /// Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. Default value: [code]ANCHOR_BEGIN[/code].
+ /// <para>Anchors the right edge of the node to the origin, the center or the end of its parent control. It changes how the right margin updates when the node moves or changes size. You can use one of the <c>ANCHOR_*</c> constants for convenience. Default value: <c>ANCHOR_BEGIN</c>.</para>
/// </summary>
public float AnchorRight
{
@@ -343,7 +344,7 @@
}
/// <summary>
- /// Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the [code]ANCHOR_*[/code] constants for convenience. Default value: [code]ANCHOR_BEGIN[/code].
+ /// <para>Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom margin updates when the node moves or changes size. You can use one of the <c>ANCHOR_*</c> constants for convenience. Default value: <c>ANCHOR_BEGIN</c>.</para>
/// </summary>
public float AnchorBottom
{
@@ -358,8 +359,8 @@
}
/// <summary>
- /// Distance between the node's left edge and its parent control, based on [member anchor_left].
- /// Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node.
+ /// <para>Distance between the node's left edge and its parent control, based on <see cref="Godot.Control.AnchorLeft"/>.</para>
+ /// <para>Margins are often controlled by one or multiple parent <see cref="Godot.Container"/> nodes, so you should not modify them manually if your node is a direct child of a <see cref="Godot.Container"/>. Margins update automatically when you move or resize the node.</para>
/// </summary>
public float MarginLeft
{
@@ -374,8 +375,8 @@
}
/// <summary>
- /// Distance between the node's top edge and its parent control, based on [member anchor_top].
- /// Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node.
+ /// <para>Distance between the node's top edge and its parent control, based on <see cref="Godot.Control.AnchorTop"/>.</para>
+ /// <para>Margins are often controlled by one or multiple parent <see cref="Godot.Container"/> nodes, so you should not modify them manually if your node is a direct child of a <see cref="Godot.Container"/>. Margins update automatically when you move or resize the node.</para>
/// </summary>
public float MarginTop
{
@@ -390,8 +391,8 @@
}
/// <summary>
- /// Distance between the node's right edge and its parent control, based on [member anchor_right].
- /// Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node.
+ /// <para>Distance between the node's right edge and its parent control, based on <see cref="Godot.Control.AnchorRight"/>.</para>
+ /// <para>Margins are often controlled by one or multiple parent <see cref="Godot.Container"/> nodes, so you should not modify them manually if your node is a direct child of a <see cref="Godot.Container"/>. Margins update automatically when you move or resize the node.</para>
/// </summary>
public float MarginRight
{
@@ -406,8 +407,8 @@
}
/// <summary>
- /// Distance between the node's bottom edge and its parent control, based on [member anchor_bottom].
- /// Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node.
+ /// <para>Distance between the node's bottom edge and its parent control, based on <see cref="Godot.Control.AnchorBottom"/>.</para>
+ /// <para>Margins are often controlled by one or multiple parent <see cref="Godot.Container"/> nodes, so you should not modify them manually if your node is a direct child of a <see cref="Godot.Container"/>. Margins update automatically when you move or resize the node.</para>
/// </summary>
public float MarginBottom
{
@@ -422,7 +423,7 @@
}
/// <summary>
- /// Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
+ /// <para>Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.</para>
/// </summary>
public Control.GrowDirection GrowHorizontal
{
@@ -437,7 +438,7 @@
}
/// <summary>
- /// Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.
+ /// <para>Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.</para>
/// </summary>
public Control.GrowDirection GrowVertical
{
@@ -452,7 +453,7 @@
}
/// <summary>
- /// The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by [member rect_pivot_offset].
+ /// <para>The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by <see cref="Godot.Control.RectPivotOffset"/>.</para>
/// </summary>
public Vector2 RectPosition
{
@@ -467,7 +468,7 @@
}
/// <summary>
- /// The node's global position, relative to the world (usually to the top-left corner of the window).
+ /// <para>The node's global position, relative to the world (usually to the top-left corner of the window).</para>
/// </summary>
public Vector2 RectGlobalPosition
{
@@ -482,7 +483,7 @@
}
/// <summary>
- /// The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically.
+ /// <para>The size of the node's bounding rectangle, in pixels. <see cref="Godot.Container"/> nodes update this property automatically.</para>
/// </summary>
public Vector2 RectSize
{
@@ -497,7 +498,7 @@
}
/// <summary>
- /// The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.
+ /// <para>The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.</para>
/// </summary>
public Vector2 RectMinSize
{
@@ -512,7 +513,7 @@
}
/// <summary>
- /// The node's rotation around its pivot, in degrees. See [member rect_pivot_offset] to change the pivot's position.
+ /// <para>The node's rotation around its pivot, in degrees. See <see cref="Godot.Control.RectPivotOffset"/> to change the pivot's position.</para>
/// </summary>
public float RectRotation
{
@@ -527,7 +528,7 @@
}
/// <summary>
- /// The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset].
+ /// <para>The node's scale, relative to its <see cref="Godot.Control.RectSize"/>. Change this property to scale the node around its <see cref="Godot.Control.RectPivotOffset"/>.</para>
/// </summary>
public Vector2 RectScale
{
@@ -542,7 +543,7 @@
}
/// <summary>
- /// By default, the node's pivot is its top-left corner. When you change its [member rect_scale], it will scale around this pivot. Set this property to [member rect_size] / 2 to center the pivot in the node's rectangle.
+ /// <para>By default, the node's pivot is its top-left corner. When you change its <see cref="Godot.Control.RectScale"/>, it will scale around this pivot. Set this property to <see cref="Godot.Control.RectSize"/> / 2 to center the pivot in the node's rectangle.</para>
/// </summary>
public Vector2 RectPivotOffset
{
@@ -557,7 +558,7 @@
}
/// <summary>
- /// Enables whether rendering of children should be clipped to this control's rectangle. If true, parts of a child which would be visibly outside of this control's rectangle will not be rendered.
+ /// <para>Enables whether rendering of children should be clipped to this control's rectangle. If true, parts of a child which would be visibly outside of this control's rectangle will not be rendered.</para>
/// </summary>
public bool RectClipContent
{
@@ -572,7 +573,7 @@
}
/// <summary>
- /// Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE].
+ /// <para>Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the <see cref="Godot.Control.MouseFilter"/> property is not [constant MOUSE_FILTER_IGNORE].</para>
/// </summary>
public string HintTooltip
{
@@ -587,7 +588,7 @@
}
/// <summary>
- /// Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the [code]ui_left[/code] input action. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the left of this one.
+ /// <para>Tells Godot which node it should give keyboard focus to if the user presses the left arrow on the keyboard or left on a gamepad by default. You can change the key by editing the <c>ui_left</c> input action. The node must be a <c>Control</c>. If this property is not set, Godot will give focus to the closest <c>Control</c> to the left of this one.</para>
/// </summary>
public NodePath FocusNeighbourLeft
{
@@ -602,7 +603,7 @@
}
/// <summary>
- /// Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the [code]ui_top[/code] input action. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one.
+ /// <para>Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the <c>ui_top</c> input action. The node must be a <c>Control</c>. If this property is not set, Godot will give focus to the closest <c>Control</c> to the bottom of this one.</para>
/// </summary>
public NodePath FocusNeighbourTop
{
@@ -617,7 +618,7 @@
}
/// <summary>
- /// Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the [code]ui_right[/code] input action. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one.
+ /// <para>Tells Godot which node it should give keyboard focus to if the user presses the right arrow on the keyboard or right on a gamepad by default. You can change the key by editing the <c>ui_right</c> input action. The node must be a <c>Control</c>. If this property is not set, Godot will give focus to the closest <c>Control</c> to the bottom of this one.</para>
/// </summary>
public NodePath FocusNeighbourRight
{
@@ -632,7 +633,7 @@
}
/// <summary>
- /// Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the [code]ui_down[/code] input action. The node must be a [code]Control[/code]. If this property is not set, Godot will give focus to the closest [code]Control[/code] to the bottom of this one.
+ /// <para>Tells Godot which node it should give keyboard focus to if the user presses the down arrow on the keyboard or down on a gamepad by default. You can change the key by editing the <c>ui_down</c> input action. The node must be a <c>Control</c>. If this property is not set, Godot will give focus to the closest <c>Control</c> to the bottom of this one.</para>
/// </summary>
public NodePath FocusNeighbourBottom
{
@@ -647,8 +648,8 @@
}
/// <summary>
- /// Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_next[/code] input action.
- /// If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
+ /// <para>Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the <c>ui_focus_next</c> input action.</para>
+ /// <para>If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.</para>
/// </summary>
public NodePath FocusNext
{
@@ -663,8 +664,8 @@
}
/// <summary>
- /// Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_prev[/code] input action.
- /// If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.
+ /// <para>Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the <c>ui_focus_prev</c> input action.</para>
+ /// <para>If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.</para>
/// </summary>
public NodePath FocusPrevious
{
@@ -679,7 +680,7 @@
}
/// <summary>
- /// The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.
+ /// <para>The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.</para>
/// </summary>
public Control.FocusModeEnum FocusMode
{
@@ -694,7 +695,7 @@
}
/// <summary>
- /// Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does.
+ /// <para>Controls whether the control will be able to receive mouse button input events through <see cref="Godot.Control._GuiInput"/> and how these events should be handled. Also controls whether the control can receive the <c>mouse_entered</c>, and <c>mouse_exited</c> signals. See the constants to learn what each does.</para>
/// </summary>
public Control.MouseFilterEnum MouseFilter
{
@@ -709,8 +710,8 @@
}
/// <summary>
- /// The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
- /// [b]Note:[/b] On Linux, shapes may vary depending on the cursor theme of the system.
+ /// <para>The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.</para>
+ /// <para>Note: On Linux, shapes may vary depending on the cursor theme of the system.</para>
/// </summary>
public Control.CursorShape MouseDefaultCursorShape
{
@@ -725,7 +726,7 @@
}
/// <summary>
- /// Tells the parent [Container] nodes how they should resize and place the node on the X axis. Use one of the [code]SIZE_*[/code] constants to change the flags. See the constants to learn what each does.
+ /// <para>Tells the parent <see cref="Godot.Container"/> nodes how they should resize and place the node on the X axis. Use one of the <c>SIZE_*</c> constants to change the flags. See the constants to learn what each does.</para>
/// </summary>
public int SizeFlagsHorizontal
{
@@ -740,7 +741,7 @@
}
/// <summary>
- /// Tells the parent [Container] nodes how they should resize and place the node on the Y axis. Use one of the [code]SIZE_*[/code] constants to change the flags. See the constants to learn what each does.
+ /// <para>Tells the parent <see cref="Godot.Container"/> nodes how they should resize and place the node on the Y axis. Use one of the <c>SIZE_*</c> constants to change the flags. See the constants to learn what each does.</para>
/// </summary>
public int SizeFlagsVertical
{
@@ -755,7 +756,7 @@
}
/// <summary>
- /// If the node and at least one of its neighbours uses the [code]SIZE_EXPAND[/code] size flag, the parent [Container] will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space.
+ /// <para>If the node and at least one of its neighbours uses the <c>SIZE_EXPAND</c> size flag, the parent <see cref="Godot.Container"/> will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space.</para>
/// </summary>
public float SizeFlagsStretchRatio
{
@@ -770,7 +771,7 @@
}
/// <summary>
- /// Changing this property replaces the current [Theme] resource this node and all its [code]Control[/code] children use.
+ /// <para>Changing this property replaces the current <see cref="Godot.Theme"/> resource this node and all its <c>Control</c> children use.</para>
/// </summary>
public Theme Theme
{
@@ -804,7 +805,7 @@
}
/// <summary>
- /// Returns the minimum size for this control. See [member rect_min_size].
+ /// <para>Returns the minimum size for this control. See <see cref="Godot.Control.RectMinSize"/>.</para>
/// </summary>
[GodotMethod("_get_minimum_size")]
public virtual Vector2 _GetMinimumSize()
@@ -813,8 +814,8 @@
}
/// <summary>
- /// Use this method to process and accept inputs on UI elements. See [method accept_event].
- /// Replaces Godot 2's [code]_input_event[/code].
+ /// <para>Use this method to process and accept inputs on UI elements. See <see cref="Godot.Control.AcceptEvent"/>.</para>
+ /// <para>Replaces Godot 2's <c>_input_event</c>.</para>
/// </summary>
[GodotMethod("_gui_input")]
public virtual void _GuiInput(InputEvent @event)
@@ -832,16 +833,16 @@
}
/// <summary>
- /// Godot calls this method to test if [code]data[/code] from a control's [method get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control.
- /// This method should only be used to test the data. Process the data in [method drop_data].
- /// [codeblock]
+ /// <para>Godot calls this method to test if <c>data</c> from a control's <see cref="Godot.Control.GetDragData"/> can be dropped at <c>position</c>. <c>position</c> is local to this control.</para>
+ /// <para>This method should only be used to test the data. Process the data in <see cref="Godot.Control.DropData"/>.</para>
+ /// <para><code>
/// extends Control
///
/// func can_drop_data(position, data):
/// # check position if it is relevant to you
/// # otherwise just check data
/// return typeof(data) == TYPE_DICTIONARY and data.has('expected')
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("can_drop_data")]
public virtual bool CanDropData(Vector2 position, object data)
@@ -850,8 +851,8 @@
}
/// <summary>
- /// Godot calls this method to pass you the [code]data[/code] from a control's [method get_drag_data] result. Godot first calls [method can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control.
- /// [codeblock]
+ /// <para>Godot calls this method to pass you the <c>data</c> from a control's <see cref="Godot.Control.GetDragData"/> result. Godot first calls <see cref="Godot.Control.CanDropData"/> to test if <c>data</c> is allowed to drop at <c>position</c> where <c>position</c> is local to this control.</para>
+ /// <para><code>
/// extends ColorRect
///
/// func can_drop_data(position, data):
@@ -859,7 +860,7 @@
///
/// func drop_data(position, data):
/// color = data['color']
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("drop_data")]
public virtual void DropData(Vector2 position, object data)
@@ -868,16 +869,16 @@
}
/// <summary>
- /// Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag].
- /// A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method.
- /// [codeblock]
+ /// <para>Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Return null if there is no data to drag. Controls that want to receive drop data should implement <see cref="Godot.Control.CanDropData"/> and <see cref="Godot.Control.DropData"/>. <c>position</c> is local to this control. Drag may be forced with <see cref="Godot.Control.ForceDrag"/>.</para>
+ /// <para>A preview that will follow the mouse that should represent the data can be set with <see cref="Godot.Control.SetDragPreview"/>. A good time to set the preview is in this method.</para>
+ /// <para><code>
/// extends Control
///
/// func get_drag_data(position):
/// var mydata = make_data()
/// set_drag_preview(make_preview(mydata))
/// return mydata
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("get_drag_data")]
public virtual Object GetDragData(Vector2 position)
@@ -898,7 +899,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "accept_event");
/// <summary>
- /// Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input].
+ /// <para>Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to <see cref="Godot.Node._UnhandledInput"/> or <see cref="Godot.Node._UnhandledKeyInput"/>.</para>
/// </summary>
[GodotMethod("accept_event")]
public void AcceptEvent()
@@ -910,7 +911,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_minimum_size");
/// <summary>
- /// Returns the minimum size for this control. See [member rect_min_size].
+ /// <para>Returns the minimum size for this control. See <see cref="Godot.Control.RectMinSize"/>.</para>
/// </summary>
[GodotMethod("get_minimum_size")]
public Vector2 GetMinimumSize()
@@ -1020,7 +1021,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_begin");
/// <summary>
- /// Sets [member margin_left] and [member margin_top] at the same time.
+ /// <para>Sets <see cref="Godot.Control.MarginLeft"/> and <see cref="Godot.Control.MarginTop"/> at the same time.</para>
/// </summary>
[GodotMethod("set_begin")]
public void SetBegin(Vector2 position)
@@ -1032,7 +1033,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_end");
/// <summary>
- /// Sets [member margin_right] and [member margin_bottom] at the same time.
+ /// <para>Sets <see cref="Godot.Control.MarginRight"/> and <see cref="Godot.Control.MarginBottom"/> at the same time.</para>
/// </summary>
[GodotMethod("set_end")]
public void SetEnd(Vector2 position)
@@ -1080,7 +1081,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_rotation");
/// <summary>
- /// Sets the rotation (in radians).
+ /// <para>Sets the rotation (in radians).</para>
/// </summary>
[GodotMethod("set_rotation")]
public void SetRotation(float radians)
@@ -1128,7 +1129,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_begin");
/// <summary>
- /// Returns [member margin_left] and [member margin_top]. See also [member rect_position].
+ /// <para>Returns <see cref="Godot.Control.MarginLeft"/> and <see cref="Godot.Control.MarginTop"/>. See also <see cref="Godot.Control.RectPosition"/>.</para>
/// </summary>
[GodotMethod("get_begin")]
public Vector2 GetBegin()
@@ -1140,7 +1141,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_end");
/// <summary>
- /// Returns [member margin_right] and [member margin_bottom].
+ /// <para>Returns <see cref="Godot.Control.MarginRight"/> and <see cref="Godot.Control.MarginBottom"/>.</para>
/// </summary>
[GodotMethod("get_end")]
public Vector2 GetEnd()
@@ -1170,7 +1171,7 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_rotation");
/// <summary>
- /// Returns the rotation (in radians).
+ /// <para>Returns the rotation (in radians).</para>
/// </summary>
[GodotMethod("get_rotation")]
public float GetRotation()
@@ -1218,7 +1219,7 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_parent_area_size");
/// <summary>
- /// Returns the width/height occupied in the parent control.
+ /// <para>Returns the width/height occupied in the parent control.</para>
/// </summary>
[GodotMethod("get_parent_area_size")]
public Vector2 GetParentAreaSize()
@@ -1239,7 +1240,7 @@
private static IntPtr method_bind_33 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_rect");
/// <summary>
- /// Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size].
+ /// <para>Returns the position and size of the control relative to the top-left corner of the parent Control. See <see cref="Godot.Control.RectPosition"/> and <see cref="Godot.Control.RectSize"/>.</para>
/// </summary>
[GodotMethod("get_rect")]
public Rect2 GetRect()
@@ -1251,7 +1252,7 @@
private static IntPtr method_bind_34 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_global_rect");
/// <summary>
- /// Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size].
+ /// <para>Returns the position and size of the control relative to the top-left corner of the screen. See <see cref="Godot.Control.RectPosition"/> and <see cref="Godot.Control.RectSize"/>.</para>
/// </summary>
[GodotMethod("get_global_rect")]
public Rect2 GetGlobalRect()
@@ -1263,7 +1264,7 @@
private static IntPtr method_bind_35 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "show_modal");
/// <summary>
- /// Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.
+ /// <para>Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.</para>
/// </summary>
[GodotMethod("show_modal")]
public void ShowModal(bool exclusive = false)
@@ -1293,7 +1294,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "has_focus");
/// <summary>
- /// Returns [code]true[/code] if this is the current focused control. See [member focus_mode].
+ /// <para>Returns <c>true</c> if this is the current focused control. See <see cref="Godot.Control.FocusMode"/>.</para>
/// </summary>
[GodotMethod("has_focus")]
public bool HasFocus()
@@ -1305,7 +1306,7 @@
private static IntPtr method_bind_39 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "grab_focus");
/// <summary>
- /// Steal the focus from another control and become the focused control (see [member focus_mode]).
+ /// <para>Steal the focus from another control and become the focused control (see <see cref="Godot.Control.FocusMode"/>).</para>
/// </summary>
[GodotMethod("grab_focus")]
public void GrabFocus()
@@ -1317,7 +1318,7 @@
private static IntPtr method_bind_40 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "release_focus");
/// <summary>
- /// Give up the focus. No other control will be able to receive keyboard input.
+ /// <para>Give up the focus. No other control will be able to receive keyboard input.</para>
/// </summary>
[GodotMethod("release_focus")]
public void ReleaseFocus()
@@ -1329,7 +1330,7 @@
private static IntPtr method_bind_41 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_focus_owner");
/// <summary>
- /// Returns the control that has the keyboard focus or [code]null[/code] if none.
+ /// <para>Returns the control that has the keyboard focus or <c>null</c> if none.</para>
/// </summary>
[GodotMethod("get_focus_owner")]
public Control GetFocusOwner()
@@ -1413,7 +1414,7 @@
private static IntPtr method_bind_50 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_icon_override");
/// <summary>
- /// Overrides the [code]name[/code] icon in the [member theme] resource the node uses. If [code]icon[/code] is empty, Godot clears the override.
+ /// <para>Overrides the <c>name</c> icon in the <see cref="Godot.Control.Theme"/> resource the node uses. If <c>icon</c> is empty, Godot clears the override.</para>
/// </summary>
[GodotMethod("add_icon_override")]
public void AddIconOverride(string name, Texture texture)
@@ -1425,7 +1426,7 @@
private static IntPtr method_bind_51 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_shader_override");
/// <summary>
- /// Overrides the [code]name[/code] shader in the [member theme] resource the node uses. If [code]shader[/code] is empty, Godot clears the override.
+ /// <para>Overrides the <c>name</c> shader in the <see cref="Godot.Control.Theme"/> resource the node uses. If <c>shader</c> is empty, Godot clears the override.</para>
/// </summary>
[GodotMethod("add_shader_override")]
public void AddShaderOverride(string name, Shader shader)
@@ -1437,7 +1438,7 @@
private static IntPtr method_bind_52 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_stylebox_override");
/// <summary>
- /// Overrides the [code]name[/code] [StyleBox] in the [member theme] resource the node uses. If [code]stylebox[/code] is empty, Godot clears the override.
+ /// <para>Overrides the <c>name</c> <see cref="Godot.StyleBox"/> in the <see cref="Godot.Control.Theme"/> resource the node uses. If <c>stylebox</c> is empty, Godot clears the override.</para>
/// </summary>
[GodotMethod("add_stylebox_override")]
public void AddStyleboxOverride(string name, StyleBox stylebox)
@@ -1449,7 +1450,7 @@
private static IntPtr method_bind_53 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_font_override");
/// <summary>
- /// Overrides the [code]name[/code] font in the [member theme] resource the node uses. If [code]font[/code] is empty, Godot clears the override.
+ /// <para>Overrides the <c>name</c> font in the <see cref="Godot.Control.Theme"/> resource the node uses. If <c>font</c> is empty, Godot clears the override.</para>
/// </summary>
[GodotMethod("add_font_override")]
public void AddFontOverride(string name, Font font)
@@ -1461,7 +1462,7 @@
private static IntPtr method_bind_54 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_color_override");
/// <summary>
- /// Overrides the color in the [member theme] resource the node uses.
+ /// <para>Overrides the color in the <see cref="Godot.Control.Theme"/> resource the node uses.</para>
/// </summary>
[GodotMethod("add_color_override")]
public void AddColorOverride(string name, Color color)
@@ -1473,7 +1474,7 @@
private static IntPtr method_bind_55 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_constant_override");
/// <summary>
- /// Overrides an integer constant in the [member theme] resource the node uses. If the [code]constant[/code] is invalid, Godot clears the override.
+ /// <para>Overrides an integer constant in the <see cref="Godot.Control.Theme"/> resource the node uses. If the <c>constant</c> is invalid, Godot clears the override.</para>
/// </summary>
[GodotMethod("add_constant_override")]
public void AddConstantOverride(string name, int constant)
@@ -1677,7 +1678,7 @@
private static IntPtr method_bind_72 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_parent_control");
/// <summary>
- /// Returns the parent control node.
+ /// <para>Returns the parent control node.</para>
/// </summary>
[GodotMethod("get_parent_control")]
public Control GetParentControl()
@@ -1734,8 +1735,8 @@
private static IntPtr method_bind_78 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_tooltip");
/// <summary>
- /// Returns the tooltip, which will appear when the cursor is resting over this control.
- /// &lt;param name="atPosition"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <para>Returns the tooltip, which will appear when the cursor is resting over this control.</para>
+ /// <param name="atPosition">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("get_tooltip")]
public string GetTooltip(Nullable<Vector2> atPosition = null)
@@ -1774,8 +1775,8 @@
private static IntPtr method_bind_82 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_cursor_shape");
/// <summary>
- /// Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape].
- /// &lt;param name="position"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <para>Returns the mouse cursor shape the control displays on mouse hover. See <see cref="Godot.Control.CursorShape"/>.</para>
+ /// <param name="position">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("get_cursor_shape")]
public Control.CursorShape GetCursorShape(Nullable<Vector2> position = null)
@@ -1842,8 +1843,8 @@
private static IntPtr method_bind_89 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "force_drag");
/// <summary>
- /// Forces drag and bypasses [method get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control.
- /// The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data.
+ /// <para>Forces drag and bypasses <see cref="Godot.Control.GetDragData"/> and <see cref="Godot.Control.SetDragPreview"/> by passing <c>data</c> and <c>preview</c>. Drag will start even if the mouse is neither over nor pressed on this control.</para>
+ /// <para>The methods <see cref="Godot.Control.CanDropData"/> and <see cref="Godot.Control.DropData"/> must be implemented on controls that want to receive drop data.</para>
/// </summary>
[GodotMethod("force_drag")]
public void ForceDrag(object data, Control preview)
@@ -1903,11 +1904,11 @@
private static IntPtr method_bind_95 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_drag_forwarding");
/// <summary>
- /// Forwards the handling of this control's drag and drop to [code]target[/code] control.
- /// Forwarding can be implemented in the target control similar to the methods [method get_drag_data], [method can_drop_data], and [method drop_data] but with two differences:
- /// 1. The function name must be suffixed with [b]_fw[/b]
- /// 2. The function must take an extra argument that is the control doing the forwarding
- /// [codeblock]
+ /// <para>Forwards the handling of this control's drag and drop to <c>target</c> control.</para>
+ /// <para>Forwarding can be implemented in the target control similar to the methods <see cref="Godot.Control.GetDragData"/>, <see cref="Godot.Control.CanDropData"/>, and <see cref="Godot.Control.DropData"/> but with two differences:</para>
+ /// <para>1. The function name must be suffixed with _fw</para>
+ /// <para>2. The function must take an extra argument that is the control doing the forwarding</para>
+ /// <para><code>
/// # ThisControl.gd
/// extends Control
/// func _ready():
@@ -1924,7 +1925,7 @@
/// func get_drag_data_fw(position, from_control):
/// set_drag_preview(my_preview)
/// return my_data()
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("set_drag_forwarding")]
public void SetDragForwarding(Control target)
@@ -1936,7 +1937,7 @@
private static IntPtr method_bind_96 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_drag_preview");
/// <summary>
- /// Shows the given control at the mouse pointer. A good time to call this method is in [method get_drag_data].
+ /// <para>Shows the given control at the mouse pointer. A good time to call this method is in <see cref="Godot.Control.GetDragData"/>.</para>
/// </summary>
[GodotMethod("set_drag_preview")]
public void SetDragPreview(Control control)
@@ -1971,3 +1972,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConvexPolygonShape.cs GodotSharp_after/GodotSharp/ObjectType/ConvexPolygonShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConvexPolygonShape.cs 2019-03-20 21:16:54.924128300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConvexPolygonShape.cs 2019-03-23 19:57:08.140001100 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Convex polygon shape resource, which can be added to a [PhysicsBody] or area.
+ /// <para>Convex polygon shape resource, which can be added to a <see cref="Godot.PhysicsBody"/> or area.</para>
/// </summary>
public partial class ConvexPolygonShape : Shape
{
/// <summary>
- /// The list of 3D points forming the convex polygon shape.
+ /// <para>The list of 3D points forming the convex polygon shape.</para>
/// </summary>
public Vector3[] Points
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/ConvexPolygonShape2D.cs GodotSharp_after/GodotSharp/ObjectType/ConvexPolygonShape2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/ConvexPolygonShape2D.cs 2019-03-20 21:16:54.927127100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/ConvexPolygonShape2D.cs 2019-03-23 19:57:08.142000100 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check).
- /// The main difference between a [code]ConvexPolygonShape2D[/code] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
+ /// <para>Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check).</para>
+ /// <para>The main difference between a <c>ConvexPolygonShape2D</c> and a <see cref="Godot.ConcavePolygonShape2D"/> is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.</para>
/// </summary>
public partial class ConvexPolygonShape2D : Shape2D
{
/// <summary>
- /// The polygon's list of vertices. Can be in either clockwise or counterclockwise order.
+ /// <para>The polygon's list of vertices. Can be in either clockwise or counterclockwise order.</para>
/// </summary>
public Vector2[] Points
{
@@ -40,7 +41,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_cloud");
/// <summary>
- /// Based on the set of points provided, this creates and assigns the [member points] property using the convex hull algorithm. Removing all unneeded points. See [method Geometry.convex_hull_2d] for details.
+ /// <para>Based on the set of points provided, this creates and assigns the <see cref="Godot.ConvexPolygonShape2D.Points"/> property using the convex hull algorithm. Removing all unneeded points. See <see cref="Godot.Geometry.ConvexHull2d"/> for details.</para>
/// </summary>
[GodotMethod("set_point_cloud")]
public void SetPointCloud(Vector2[] pointCloud)
@@ -69,3 +70,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CPUParticles.cs GodotSharp_after/GodotSharp/ObjectType/CPUParticles.cs
--- GodotSharp_before/GodotSharp/ObjectType/CPUParticles.cs 2019-03-20 21:16:54.705200900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CPUParticles.cs 2019-03-23 19:57:07.945063900 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -851,7 +852,7 @@
}
/// <summary>
- /// Each particle's vertex color will vary along this [GradientTexture].
+ /// <para>Each particle's vertex color will vary along this <see cref="Godot.GradientTexture"/>.</para>
/// </summary>
public Gradient ColorRamp
{
@@ -1541,3 +1542,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CPUParticles2D.cs GodotSharp_after/GodotSharp/ObjectType/CPUParticles2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/CPUParticles2D.cs 2019-03-20 21:16:54.719195100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CPUParticles2D.cs 2019-03-23 19:57:07.957061000 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -1540,3 +1541,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGBox.cs GodotSharp_after/GodotSharp/ObjectType/CSGBox.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGBox.cs 2019-03-20 21:16:54.724193900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGBox.cs 2019-03-23 19:57:07.962058400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This node allows you to create a box for use with the CSG system.
+ /// <para>This node allows you to create a box for use with the CSG system.</para>
/// </summary>
public partial class CSGBox : CSGPrimitive
{
/// <summary>
- /// Width of the box measured from the center of the box.
+ /// <para>Width of the box measured from the center of the box.</para>
/// </summary>
public float Width
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Height of the box measured from the center of the box.
+ /// <para>Height of the box measured from the center of the box.</para>
/// </summary>
public float Height
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Depth of the box measured from the center of the box.
+ /// <para>Depth of the box measured from the center of the box.</para>
/// </summary>
public float Depth
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// The material used to render the box.
+ /// <para>The material used to render the box.</para>
/// </summary>
public Material Material
{
@@ -155,3 +156,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGCombiner.cs GodotSharp_after/GodotSharp/ObjectType/CSGCombiner.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGCombiner.cs 2019-03-20 21:16:54.726193300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGCombiner.cs 2019-03-23 19:57:07.964056500 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as its input to create the final shape.
+ /// <para>For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as its input to create the final shape.</para>
/// </summary>
public partial class CSGCombiner : CSGShape
{
@@ -23,3 +24,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGCylinder.cs GodotSharp_after/GodotSharp/ObjectType/CSGCylinder.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGCylinder.cs 2019-03-20 21:16:54.730191000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGCylinder.cs 2019-03-23 19:57:07.968056300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This node allows you to create a cylinder (or cone) for use with the CSG system.
+ /// <para>This node allows you to create a cylinder (or cone) for use with the CSG system.</para>
/// </summary>
public partial class CSGCylinder : CSGPrimitive
{
/// <summary>
- /// The radius of the cylinder.
+ /// <para>The radius of the cylinder.</para>
/// </summary>
public float Radius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The height of the cylinder.
+ /// <para>The height of the cylinder.</para>
/// </summary>
public float Height
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
+ /// <para>The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.</para>
/// </summary>
public int Sides
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// If true a cone is created, the [member radius] will only apply to one side.
+ /// <para>If true a cone is created, the <see cref="Godot.CSGCylinder.Radius"/> will only apply to one side.</para>
/// </summary>
public bool Cone
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look.
+ /// <para>If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look.</para>
/// </summary>
public bool SmoothFaces
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// The material used to render the cylinder.
+ /// <para>The material used to render the cylinder.</para>
/// </summary>
public Material Material
{
@@ -221,3 +222,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGMesh.cs GodotSharp_after/GodotSharp/ObjectType/CSGMesh.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGMesh.cs 2019-03-20 21:16:54.733190200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGMesh.cs 2019-03-23 19:57:07.970055600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more then two faces.
+ /// <para>This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more then two faces.</para>
/// </summary>
public partial class CSGMesh : CSGPrimitive
{
/// <summary>
- /// The mesh resource to use as a CSG shape.
+ /// <para>The mesh resource to use as a CSG shape.</para>
/// </summary>
public Mesh Mesh
{
@@ -56,3 +57,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGPolygon.cs GodotSharp_after/GodotSharp/ObjectType/CSGPolygon.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGPolygon.cs 2019-03-20 21:16:54.739189200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGPolygon.cs 2019-03-23 19:57:07.976053100 +0100
@@ -2,26 +2,27 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This node takes a 2D polygon shape and extrudes it to create a 3D mesh.
+ /// <para>This node takes a 2D polygon shape and extrudes it to create a 3D mesh.</para>
/// </summary>
public partial class CSGPolygon : CSGPrimitive
{
public enum PathRotationEnum
{
/// <summary>
- /// Slice is not rotated.
+ /// <para>Slice is not rotated.</para>
/// </summary>
Polygon = 0,
/// <summary>
- /// Slice is rotated around the up vector of the path.
+ /// <para>Slice is rotated around the up vector of the path.</para>
/// </summary>
Path = 1,
/// <summary>
- /// Slice is rotate to match the path exactly.
+ /// <para>Slice is rotate to match the path exactly.</para>
/// </summary>
PathFollow = 2
}
@@ -29,21 +30,21 @@
public enum ModeEnum
{
/// <summary>
- /// Shape is extruded to [member depth].
+ /// <para>Shape is extruded to <see cref="Godot.CSGPolygon.Depth"/>.</para>
/// </summary>
Depth = 0,
/// <summary>
- /// Shape is extruded by rotating it around an axis.
+ /// <para>Shape is extruded by rotating it around an axis.</para>
/// </summary>
Spin = 1,
/// <summary>
- /// Shape is extruded along a path set by a [Shape] set in [member path_node].
+ /// <para>Shape is extruded along a path set by a <see cref="Godot.Shape"/> set in <see cref="Godot.CSGPolygon.PathNode"/>.</para>
/// </summary>
Path = 2
}
/// <summary>
- /// Point array that defines the shape that we'll extrude.
+ /// <para>Point array that defines the shape that we'll extrude.</para>
/// </summary>
public Vector2[] Polygon
{
@@ -58,7 +59,7 @@
}
/// <summary>
- /// Extrusion mode.
+ /// <para>Extrusion mode.</para>
/// </summary>
public CSGPolygon.ModeEnum Mode
{
@@ -73,7 +74,7 @@
}
/// <summary>
- /// Extrusion depth when [member mode] is [constant MODE_DEPTH].
+ /// <para>Extrusion depth when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_DEPTH].</para>
/// </summary>
public float Depth
{
@@ -88,7 +89,7 @@
}
/// <summary>
- /// Degrees to rotate our extrusion for each slice when [member mode] is [constant MODE_SPIN].
+ /// <para>Degrees to rotate our extrusion for each slice when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_SPIN].</para>
/// </summary>
public float SpinDegrees
{
@@ -103,7 +104,7 @@
}
/// <summary>
- /// Number of extrusion when [member mode] is [constant MODE_SPIN].
+ /// <para>Number of extrusion when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_SPIN].</para>
/// </summary>
public int SpinSides
{
@@ -118,7 +119,7 @@
}
/// <summary>
- /// The [Shape] object containing the path along which we extrude when [member mode] is [constant MODE_PATH].
+ /// <para>The <see cref="Godot.Shape"/> object containing the path along which we extrude when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_PATH].</para>
/// </summary>
public NodePath PathNode
{
@@ -133,7 +134,7 @@
}
/// <summary>
- /// Interval at which a new extrusion slice is added along the path when [member mode] is [constant MODE_PATH].
+ /// <para>Interval at which a new extrusion slice is added along the path when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_PATH].</para>
/// </summary>
public float PathInterval
{
@@ -148,7 +149,7 @@
}
/// <summary>
- /// The method by which each slice is rotated along the path when [member mode] is [constant MODE_PATH].
+ /// <para>The method by which each slice is rotated along the path when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_PATH].</para>
/// </summary>
public CSGPolygon.PathRotationEnum PathRotation
{
@@ -163,7 +164,7 @@
}
/// <summary>
- /// If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when [member mode] is [constant MODE_PATH].
+ /// <para>If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_PATH].</para>
/// </summary>
public bool PathLocal
{
@@ -178,7 +179,7 @@
}
/// <summary>
- /// If true the u component of our uv will continuously increase in unison with the distance traveled along our path when [member mode] is [constant MODE_PATH].
+ /// <para>If true the u component of our uv will continuously increase in unison with the distance traveled along our path when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_PATH].</para>
/// </summary>
public bool PathContinuousU
{
@@ -193,7 +194,7 @@
}
/// <summary>
- /// If true the start and end of our path are joined together ensuring there is no seam when [member mode] is [constant MODE_PATH].
+ /// <para>If true the start and end of our path are joined together ensuring there is no seam when <see cref="Godot.CSGPolygon.Mode"/> is [constant MODE_PATH].</para>
/// </summary>
public bool PathJoined
{
@@ -208,7 +209,7 @@
}
/// <summary>
- /// Generates smooth normals so smooth shading is applied to our mesh.
+ /// <para>Generates smooth normals so smooth shading is applied to our mesh.</para>
/// </summary>
public bool SmoothFaces
{
@@ -223,7 +224,7 @@
}
/// <summary>
- /// Material to use for the resulting mesh.
+ /// <para>Material to use for the resulting mesh.</para>
/// </summary>
public Material Material
{
@@ -484,3 +485,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGPrimitive.cs GodotSharp_after/GodotSharp/ObjectType/CSGPrimitive.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGPrimitive.cs 2019-03-20 21:16:54.743188200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGPrimitive.cs 2019-03-23 19:57:07.979052300 +0100
@@ -2,13 +2,14 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
public abstract partial class CSGPrimitive : CSGShape
{
/// <summary>
- /// Invert the faces of the mesh.
+ /// <para>Invert the faces of the mesh.</para>
/// </summary>
public bool InvertFaces
{
@@ -49,3 +50,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGShape.cs GodotSharp_after/GodotSharp/ObjectType/CSGShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGShape.cs 2019-03-20 21:16:54.747186000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGShape.cs 2019-03-23 19:57:07.983051300 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot.
+ /// <para>This is the CSG base class that provides CSG operation support to the various CSG nodes in Godot.</para>
/// </summary>
public abstract partial class CSGShape : VisualInstance
{
public enum OperationEnum
{
/// <summary>
- /// Geometry of both primitives is merged, intersecting geometry is removed.
+ /// <para>Geometry of both primitives is merged, intersecting geometry is removed.</para>
/// </summary>
Union = 0,
/// <summary>
- /// Only intersecting geometry remains, the rest is removed.
+ /// <para>Only intersecting geometry remains, the rest is removed.</para>
/// </summary>
Intersection = 1,
/// <summary>
- /// The second shape is susbtracted from the first, leaving a dent with it's shape.
+ /// <para>The second shape is susbtracted from the first, leaving a dent with it's shape.</para>
/// </summary>
Subtraction = 2
}
/// <summary>
- /// The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent.
+ /// <para>The operation that is performed on this shape. This is ignored for the first CSG child node as the operation is between this node and the previous child of this nodes parent.</para>
/// </summary>
public CSGShape.OperationEnum Operation
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child.
+ /// <para>Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child.</para>
/// </summary>
public bool CalculateTangents
{
@@ -72,7 +73,7 @@
}
/// <summary>
- /// Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden.
+ /// <para>Adds a collision shape to the physics engine for our CSG shape. This will always act like a static body. Note that the collision shape is still active even if the CSG shape itself is hidden.</para>
/// </summary>
public bool UseCollision
{
@@ -87,9 +88,9 @@
}
/// <summary>
- /// The physics layers this area is in.
- /// Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.
- /// A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
+ /// <para>The physics layers this area is in.</para>
+ /// <para>Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.</para>
+ /// <para>A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.</para>
/// </summary>
public int CollisionLayer
{
@@ -104,7 +105,7 @@
}
/// <summary>
- /// The physics layers this CSG shape scans for collisions.
+ /// <para>The physics layers this CSG shape scans for collisions.</para>
/// </summary>
public int CollisionMask
{
@@ -128,7 +129,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_root_shape");
/// <summary>
- /// Returns true if this is a root shape and is thus the object that is rendered.
+ /// <para>Returns true if this is a root shape and is thus the object that is rendered.</para>
/// </summary>
[GodotMethod("is_root_shape")]
public bool IsRootShape()
@@ -230,7 +231,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_collision_mask_bit");
/// <summary>
- /// Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
+ /// <para>Sets individual bits on the collision mask. Use this if you only need to change one layer's value.</para>
/// </summary>
[GodotMethod("set_collision_mask_bit")]
public void SetCollisionMaskBit(int bit, bool value)
@@ -242,7 +243,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_collision_mask_bit");
/// <summary>
- /// Returns an individual bit on the collision mask.
+ /// <para>Returns an individual bit on the collision mask.</para>
/// </summary>
[GodotMethod("get_collision_mask_bit")]
public bool GetCollisionMaskBit(int bit)
@@ -254,7 +255,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_collision_layer_bit");
/// <summary>
- /// Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
+ /// <para>Sets individual bits on the layer mask. Use this if you only need to change one layer's value.</para>
/// </summary>
[GodotMethod("set_collision_layer_bit")]
public void SetCollisionLayerBit(int bit, bool value)
@@ -266,7 +267,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_collision_layer_bit");
/// <summary>
- /// Returns an individual bit on the collision mask.
+ /// <para>Returns an individual bit on the collision mask.</para>
/// </summary>
[GodotMethod("get_collision_layer_bit")]
public bool GetCollisionLayerBit(int bit)
@@ -307,3 +308,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGSphere.cs GodotSharp_after/GodotSharp/ObjectType/CSGSphere.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGSphere.cs 2019-03-20 21:16:54.751184200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGSphere.cs 2019-03-23 19:57:07.987050300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This node allows you to create a sphere for use with the CSG system.
+ /// <para>This node allows you to create a sphere for use with the CSG system.</para>
/// </summary>
public partial class CSGSphere : CSGPrimitive
{
/// <summary>
- /// Radius of the sphere.
+ /// <para>Radius of the sphere.</para>
/// </summary>
public float Radius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Number of vertical slices for the sphere.
+ /// <para>Number of vertical slices for the sphere.</para>
/// </summary>
public int RadialSegments
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Number of horizontal slices for the sphere.
+ /// <para>Number of horizontal slices for the sphere.</para>
/// </summary>
public int Rings
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look.
+ /// <para>If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look.</para>
/// </summary>
public bool SmoothFaces
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// The material used to render the sphere.
+ /// <para>The material used to render the sphere.</para>
/// </summary>
public Material Material
{
@@ -188,3 +189,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSGTorus.cs GodotSharp_after/GodotSharp/ObjectType/CSGTorus.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSGTorus.cs 2019-03-20 21:16:54.754183900 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSGTorus.cs 2019-03-23 19:57:07.990049000 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This node allows you to create a torus for use with the CSG system.
+ /// <para>This node allows you to create a torus for use with the CSG system.</para>
/// </summary>
public partial class CSGTorus : CSGPrimitive
{
/// <summary>
- /// The inner radius of the torus.
+ /// <para>The inner radius of the torus.</para>
/// </summary>
public float InnerRadius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The outer radius of the torus.
+ /// <para>The outer radius of the torus.</para>
/// </summary>
public float OuterRadius
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The number of slices the torus is constructed of.
+ /// <para>The number of slices the torus is constructed of.</para>
/// </summary>
public int Sides
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// The number of edges each ring of the torus is constructed of.
+ /// <para>The number of edges each ring of the torus is constructed of.</para>
/// </summary>
public int RingSides
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look.
+ /// <para>If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look.</para>
/// </summary>
public bool SmoothFaces
{
@@ -86,7 +87,7 @@
}
/// <summary>
- /// The material used to render the torus.
+ /// <para>The material used to render the torus.</para>
/// </summary>
public Material Material
{
@@ -221,3 +222,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CSharpScript.cs GodotSharp_after/GodotSharp/ObjectType/CSharpScript.cs
--- GodotSharp_before/GodotSharp/ObjectType/CSharpScript.cs 2019-03-20 21:16:54.757185000 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CSharpScript.cs 2019-03-23 19:57:07.992048400 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -32,3 +33,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CubeMap.cs GodotSharp_after/GodotSharp/ObjectType/CubeMap.cs
--- GodotSharp_before/GodotSharp/ObjectType/CubeMap.cs 2019-03-20 21:16:54.931125200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CubeMap.cs 2019-03-23 19:57:08.146997800 +0100
@@ -2,30 +2,31 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.
+ /// <para>A 6-sided 3D texture typically used for faking reflections. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.</para>
/// </summary>
public partial class CubeMap : Resource
{
public enum FlagsEnum
{
/// <summary>
- /// Generate mipmaps, to enable smooth zooming out of the texture.
+ /// <para>Generate mipmaps, to enable smooth zooming out of the texture.</para>
/// </summary>
Mipmaps = 1,
/// <summary>
- /// Repeat (instead of clamp to edge).
+ /// <para>Repeat (instead of clamp to edge).</para>
/// </summary>
Repeat = 2,
/// <summary>
- /// Turn on magnifying filter, to enable smooth zooming in of the texture.
+ /// <para>Turn on magnifying filter, to enable smooth zooming in of the texture.</para>
/// </summary>
Filter = 4,
/// <summary>
- /// Default flags. Generate mipmaps, repeat, and filter are enabled.
+ /// <para>Default flags. Generate mipmaps, repeat, and filter are enabled.</para>
/// </summary>
Default = 7
}
@@ -33,27 +34,27 @@
public enum Side
{
/// <summary>
- /// Identifier for the left face of the [code]CubeMap[/code].
+ /// <para>Identifier for the left face of the <c>CubeMap</c>.</para>
/// </summary>
Left = 0,
/// <summary>
- /// Identifier for the right face of the [code]CubeMap[/code].
+ /// <para>Identifier for the right face of the <c>CubeMap</c>.</para>
/// </summary>
Right = 1,
/// <summary>
- /// Identifier for the bottom face of the [code]CubeMap[/code].
+ /// <para>Identifier for the bottom face of the <c>CubeMap</c>.</para>
/// </summary>
Bottom = 2,
/// <summary>
- /// Identifier for the top face of the [code]CubeMap[/code].
+ /// <para>Identifier for the top face of the <c>CubeMap</c>.</para>
/// </summary>
Top = 3,
/// <summary>
- /// Identifier for the front face of the [code]CubeMap[/code].
+ /// <para>Identifier for the front face of the <c>CubeMap</c>.</para>
/// </summary>
Front = 4,
/// <summary>
- /// Identifier for the back face of the [code]CubeMap[/code].
+ /// <para>Identifier for the back face of the <c>CubeMap</c>.</para>
/// </summary>
Back = 5
}
@@ -61,21 +62,21 @@
public enum Storage
{
/// <summary>
- /// Store the [code]CubeMap[/code] without any compression.
+ /// <para>Store the <c>CubeMap</c> without any compression.</para>
/// </summary>
Raw = 0,
/// <summary>
- /// Store the [code]CubeMap[/code] with strong compression that reduces image quality.
+ /// <para>Store the <c>CubeMap</c> with strong compression that reduces image quality.</para>
/// </summary>
CompressLossy = 1,
/// <summary>
- /// Store the [code]CubeMap[/code] with moderate compression that doesn't reduce image quality.
+ /// <para>Store the <c>CubeMap</c> with moderate compression that doesn't reduce image quality.</para>
/// </summary>
CompressLossless = 2
}
/// <summary>
- /// The render flags for the [code]CubeMap[/code]. See the [code]FLAG_*[/code] constants for details.
+ /// <para>The render flags for the <c>CubeMap</c>. See the <c>FLAG_*</c> constants for details.</para>
/// </summary>
public int Flags
{
@@ -90,7 +91,7 @@
}
/// <summary>
- /// The [code]CubeMap[/code]'s storage mode. See [code]STORAGE_*[/code] constants.
+ /// <para>The <c>CubeMap</c>'s storage mode. See <c>STORAGE_*</c> constants.</para>
/// </summary>
public CubeMap.Storage StorageMode
{
@@ -105,7 +106,7 @@
}
/// <summary>
- /// The lossy storage quality of the [code]CubeMap[/code] if the storage mode is set to STORAGE_COMPRESS_LOSSY.
+ /// <para>The lossy storage quality of the <c>CubeMap</c> if the storage mode is set to STORAGE_COMPRESS_LOSSY.</para>
/// </summary>
public float LossyStorageQuality
{
@@ -133,7 +134,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_width");
/// <summary>
- /// Returns the [code]CubeMap[/code]'s width.
+ /// <para>Returns the <c>CubeMap</c>'s width.</para>
/// </summary>
[GodotMethod("get_width")]
public int GetWidth()
@@ -145,7 +146,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_height");
/// <summary>
- /// Returns the [code]CubeMap[/code]'s height.
+ /// <para>Returns the <c>CubeMap</c>'s height.</para>
/// </summary>
[GodotMethod("get_height")]
public int GetHeight()
@@ -175,7 +176,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_side");
/// <summary>
- /// Sets an [Image] for a side of the [code]CubeMap[/code] using one of the [code]SIDE_*[/code] constants or an integer 0-5.
+ /// <para>Sets an <see cref="Godot.Image"/> for a side of the <c>CubeMap</c> using one of the <c>SIDE_*</c> constants or an integer 0-5.</para>
/// </summary>
[GodotMethod("set_side")]
public void SetSide(CubeMap.Side side, Image image)
@@ -187,7 +188,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_side");
/// <summary>
- /// Returns an [Image] for a side of the [code]CubeMap[/code] using one of the [code]SIDE_*[/code] constants or an integer 0-5.
+ /// <para>Returns an <see cref="Godot.Image"/> for a side of the <c>CubeMap</c> using one of the <c>SIDE_*</c> constants or an integer 0-5.</para>
/// </summary>
[GodotMethod("get_side")]
public Image GetSide(CubeMap.Side side)
@@ -234,3 +235,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CubeMesh.cs GodotSharp_after/GodotSharp/ObjectType/CubeMesh.cs
--- GodotSharp_before/GodotSharp/ObjectType/CubeMesh.cs 2019-03-20 21:16:54.934125100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CubeMesh.cs 2019-03-23 19:57:08.149996600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Generate an axis-aligned cuboid [PrimitiveMesh].
+ /// <para>Generate an axis-aligned cuboid <see cref="Godot.PrimitiveMesh"/>.</para>
/// </summary>
public partial class CubeMesh : PrimitiveMesh
{
/// <summary>
- /// Size of the cuboid mesh. Defaults to (2, 2, 2).
+ /// <para>Size of the cuboid mesh. Defaults to (2, 2, 2).</para>
/// </summary>
public Vector3 Size
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Number of extra edge loops inserted along the x-axis. Defaults to 0.
+ /// <para>Number of extra edge loops inserted along the x-axis. Defaults to 0.</para>
/// </summary>
public int SubdivideWidth
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Number of extra edge loops inserted along the y-axis. Defaults to 0.
+ /// <para>Number of extra edge loops inserted along the y-axis. Defaults to 0.</para>
/// </summary>
public int SubdivideHeight
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Number of extra edge loops inserted along the z-axis. Defaults to 0.
+ /// <para>Number of extra edge loops inserted along the z-axis. Defaults to 0.</para>
/// </summary>
public int SubdivideDepth
{
@@ -155,3 +156,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Curve.cs GodotSharp_after/GodotSharp/ObjectType/Curve.cs
--- GodotSharp_before/GodotSharp/ObjectType/Curve.cs 2019-03-20 21:16:54.940123500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Curve.cs 2019-03-23 19:57:08.155994800 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A curve that can be saved and re-used for other objects. By default it ranges between [code]0[/code] and [code]1[/code] on the y-axis and positions points relative to the [code]0.5[/code] y-position.
+ /// <para>A curve that can be saved and re-used for other objects. By default it ranges between <c>0</c> and <c>1</c> on the y-axis and positions points relative to the <c>0.5</c> y-position.</para>
/// </summary>
public partial class Curve : Resource
{
public enum TangentMode
{
/// <summary>
- /// The tangent on this side of the point is user-defined.
+ /// <para>The tangent on this side of the point is user-defined.</para>
/// </summary>
Free = 0,
/// <summary>
- /// The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point.
+ /// <para>The curve calculates the tangent on this side of the point as the slope halfway towards the adjacent point.</para>
/// </summary>
Linear = 1,
/// <summary>
- /// The total number of available tangent modes.
+ /// <para>The total number of available tangent modes.</para>
/// </summary>
ModeCount = 2
}
/// <summary>
- /// The minimum value the curve can reach. Default value: [code]0[/code].
+ /// <para>The minimum value the curve can reach. Default value: <c>0</c>.</para>
/// </summary>
public float MinValue
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// The maximum value the curve can reach. Default value: [code]1[/code].
+ /// <para>The maximum value the curve can reach. Default value: <c>1</c>.</para>
/// </summary>
public float MaxValue
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// The number of points to include in the baked (i.e. cached) curve data.
+ /// <para>The number of points to include in the baked (i.e. cached) curve data.</para>
/// </summary>
public int BakeResolution
{
@@ -97,7 +98,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_count");
/// <summary>
- /// Returns the number of points describing the curve.
+ /// <para>Returns the number of points describing the curve.</para>
/// </summary>
[GodotMethod("get_point_count")]
public int GetPointCount()
@@ -109,7 +110,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_point");
/// <summary>
- /// Adds a point to the curve. For each side, if the [code]*_mode[/code] is [code]TANGENT_LINEAR[/code], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [code]TANGENT_FREE[/code].
+ /// <para>Adds a point to the curve. For each side, if the <c>*_mode</c> is <c>TANGENT_LINEAR</c>, the <c>*_tangent</c> angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the <c>*_tangent</c> angle if <c>*_mode</c> is set to <c>TANGENT_FREE</c>.</para>
/// </summary>
[GodotMethod("add_point")]
public int AddPoint(Vector2 position, float leftTangent = (float)0, float rightTangent = (float)0, Curve.TangentMode leftMode = (Curve.TangentMode)0, Curve.TangentMode rightMode = (Curve.TangentMode)0)
@@ -121,7 +122,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_point");
/// <summary>
- /// Removes the point at [code]index[/code] from the curve.
+ /// <para>Removes the point at <c>index</c> from the curve.</para>
/// </summary>
[GodotMethod("remove_point")]
public void RemovePoint(int index)
@@ -133,7 +134,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_points");
/// <summary>
- /// Removes all points from the curve.
+ /// <para>Removes all points from the curve.</para>
/// </summary>
[GodotMethod("clear_points")]
public void ClearPoints()
@@ -145,7 +146,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_position");
/// <summary>
- /// Returns the curve coordinates for the point at [code]index[/code].
+ /// <para>Returns the curve coordinates for the point at <c>index</c>.</para>
/// </summary>
[GodotMethod("get_point_position")]
public Vector2 GetPointPosition(int index)
@@ -157,7 +158,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_value");
/// <summary>
- /// Assigns the vertical position [code]y[/code] to the point at [code]index[/code].
+ /// <para>Assigns the vertical position <c>y</c> to the point at <c>index</c>.</para>
/// </summary>
[GodotMethod("set_point_value")]
public void SetPointValue(int index, float y)
@@ -169,7 +170,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_offset");
/// <summary>
- /// Sets the offset from [code]0.5[/code]
+ /// <para>Sets the offset from <c>0.5</c></para>
/// </summary>
[GodotMethod("set_point_offset")]
public int SetPointOffset(int index, float offset)
@@ -181,7 +182,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate");
/// <summary>
- /// Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve.
+ /// <para>Returns the y value for the point that would exist at x-position <c>offset</c> along the curve.</para>
/// </summary>
[GodotMethod("interpolate")]
public float Interpolate(float offset)
@@ -193,7 +194,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate_baked");
/// <summary>
- /// Returns the y value for the point that would exist at x-position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.
+ /// <para>Returns the y value for the point that would exist at x-position <c>offset</c> along the curve using the baked cache. Bakes the curve's points if not already baked.</para>
/// </summary>
[GodotMethod("interpolate_baked")]
public float InterpolateBaked(float offset)
@@ -205,7 +206,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_left_tangent");
/// <summary>
- /// Returns the left tangent angle (in degrees) for the point at [code]index[/code].
+ /// <para>Returns the left tangent angle (in degrees) for the point at <c>index</c>.</para>
/// </summary>
[GodotMethod("get_point_left_tangent")]
public float GetPointLeftTangent(int index)
@@ -217,7 +218,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_right_tangent");
/// <summary>
- /// Returns the right tangent angle (in degrees) for the point at [code]index[/code].
+ /// <para>Returns the right tangent angle (in degrees) for the point at <c>index</c>.</para>
/// </summary>
[GodotMethod("get_point_right_tangent")]
public float GetPointRightTangent(int index)
@@ -229,7 +230,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_left_mode");
/// <summary>
- /// Returns the left [code]TangentMode[/code] for the point at [code]index[/code].
+ /// <para>Returns the left <c>TangentMode</c> for the point at <c>index</c>.</para>
/// </summary>
[GodotMethod("get_point_left_mode")]
public Curve.TangentMode GetPointLeftMode(int index)
@@ -241,7 +242,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_right_mode");
/// <summary>
- /// Returns the right [code]TangentMode[/code] for the point at [code]index[/code].
+ /// <para>Returns the right <c>TangentMode</c> for the point at <c>index</c>.</para>
/// </summary>
[GodotMethod("get_point_right_mode")]
public Curve.TangentMode GetPointRightMode(int index)
@@ -253,7 +254,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_left_tangent");
/// <summary>
- /// Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code].
+ /// <para>Sets the left tangent angle for the point at <c>index</c> to <c>tangent</c>.</para>
/// </summary>
[GodotMethod("set_point_left_tangent")]
public void SetPointLeftTangent(int index, float tangent)
@@ -265,7 +266,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_right_tangent");
/// <summary>
- /// Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code].
+ /// <para>Sets the right tangent angle for the point at <c>index</c> to <c>tangent</c>.</para>
/// </summary>
[GodotMethod("set_point_right_tangent")]
public void SetPointRightTangent(int index, float tangent)
@@ -277,7 +278,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_left_mode");
/// <summary>
- /// Sets the left [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code].
+ /// <para>Sets the left <c>TangentMode</c> for the point at <c>index</c> to <c>mode</c>.</para>
/// </summary>
[GodotMethod("set_point_left_mode")]
public void SetPointLeftMode(int index, Curve.TangentMode mode)
@@ -289,7 +290,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_right_mode");
/// <summary>
- /// Sets the right [code]TangentMode[/code] for the point at [code]index[/code] to [code]mode[/code].
+ /// <para>Sets the right <c>TangentMode</c> for the point at <c>index</c> to <c>mode</c>.</para>
/// </summary>
[GodotMethod("set_point_right_mode")]
public void SetPointRightMode(int index, Curve.TangentMode mode)
@@ -337,7 +338,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clean_dupes");
/// <summary>
- /// Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve.
+ /// <para>Removes points that are closer than <c>CMP_EPSILON</c> (0.00001) units to their neighbor on the curve.</para>
/// </summary>
[GodotMethod("clean_dupes")]
public void CleanDupes()
@@ -349,7 +350,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "bake");
/// <summary>
- /// Recomputes the baked cache of points for the curve.
+ /// <para>Recomputes the baked cache of points for the curve.</para>
/// </summary>
[GodotMethod("bake")]
public void Bake()
@@ -394,3 +395,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Curve2D.cs GodotSharp_after/GodotSharp/ObjectType/Curve2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/Curve2D.cs 2019-03-20 21:16:54.961115800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Curve2D.cs 2019-03-23 19:57:08.163992000 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes.
- /// It keeps a cache of precalculated points along the curve, to speed further calculations up.
+ /// <para>This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a <see cref="Godot.Path2D"/>, but can be manually sampled for other purposes.</para>
+ /// <para>It keeps a cache of precalculated points along the curve, to speed further calculations up.</para>
/// </summary>
public partial class Curve2D : Resource
{
/// <summary>
- /// The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
+ /// <para>The distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time the <see cref="Godot.Curve2D.GetBakedPoints"/> or <see cref="Godot.Curve2D.GetBakedLength"/> function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.</para>
/// </summary>
public float BakeInterval
{
@@ -52,7 +53,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_count");
/// <summary>
- /// Returns the number of points describing the curve.
+ /// <para>Returns the number of points describing the curve.</para>
/// </summary>
[GodotMethod("get_point_count")]
public int GetPointCount()
@@ -64,10 +65,10 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_point");
/// <summary>
- /// Adds a point to a curve, at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
- /// If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
- /// &lt;param name="@in"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
- /// &lt;param name="@out"&gt;If the param is null, then the default value is new Vector2(0, 0)&lt;/param&gt;
+ /// <para>Adds a point to a curve, at <c>position</c>, with control points <c>in</c> and <c>out</c>.</para>
+ /// <para>If <c>at_position</c> is given, the point is inserted before the point number <c>at_position</c>, moving that point (and every point after) after the inserted point. If <c>at_position</c> is not given, or is an illegal value (<c>at_position &lt;0</c> or <c>at_position &gt;= [method get_point_count]</c>), the point will be appended at the end of the point list.</para>
+ /// <param name="in">If the parameter is null, then the default value is new Vector2(0, 0)</param>
+ /// <param name="out">If the parameter is null, then the default value is new Vector2(0, 0)</param>
/// </summary>
[GodotMethod("add_point")]
public void AddPoint(Vector2 position, Nullable<Vector2> @in = null, Nullable<Vector2> @out = null, int atPosition = -1)
@@ -81,7 +82,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_position");
/// <summary>
- /// Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
+ /// <para>Sets the position for the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
/// </summary>
[GodotMethod("set_point_position")]
public void SetPointPosition(int idx, Vector2 position)
@@ -93,7 +94,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_position");
/// <summary>
- /// Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code].
+ /// <para>Returns the position of the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>(0, 0)</c>.</para>
/// </summary>
[GodotMethod("get_point_position")]
public Vector2 GetPointPosition(int idx)
@@ -105,7 +106,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_in");
/// <summary>
- /// Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
+ /// <para>Sets the position of the control point leading to the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
/// </summary>
[GodotMethod("set_point_in")]
public void SetPointIn(int idx, Vector2 position)
@@ -117,7 +118,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_in");
/// <summary>
- /// Returns the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code].
+ /// <para>Returns the position of the control point leading to the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>(0, 0)</c>.</para>
/// </summary>
[GodotMethod("get_point_in")]
public Vector2 GetPointIn(int idx)
@@ -129,7 +130,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_out");
/// <summary>
- /// Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
+ /// <para>Sets the position of the control point leading out of the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
/// </summary>
[GodotMethod("set_point_out")]
public void SetPointOut(int idx, Vector2 position)
@@ -141,7 +142,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_out");
/// <summary>
- /// Returns the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code].
+ /// <para>Returns the position of the control point leading out of the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>(0, 0)</c>.</para>
/// </summary>
[GodotMethod("get_point_out")]
public Vector2 GetPointOut(int idx)
@@ -153,7 +154,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_point");
/// <summary>
- /// Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds.
+ /// <para>Deletes the point <c>idx</c> from the curve. Sends an error to the console if <c>idx</c> is out of bounds.</para>
/// </summary>
[GodotMethod("remove_point")]
public void RemovePoint(int idx)
@@ -165,7 +166,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_points");
/// <summary>
- /// Removes all points from the curve.
+ /// <para>Removes all points from the curve.</para>
/// </summary>
[GodotMethod("clear_points")]
public void ClearPoints()
@@ -177,8 +178,8 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate");
/// <summary>
- /// Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results.
- /// If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0)[/code].
+ /// <para>Returns the position between the vertex <c>idx</c> and the vertex <c>idx + 1</c>, where <c>t</c> controls if the point is the first vertex (<c>t = 0.0</c>), the last vertex (<c>t = 1.0</c>), or in between. Values of <c>t</c> outside the range (<c>0.0 &gt;= t &lt;=1</c>) give strange, but predictable results.</para>
+ /// <para>If <c>idx</c> is out of bounds it is truncated to the first or last vertex, and <c>t</c> is ignored. If the curve has no points, the function sends an error to the console, and returns <c>(0, 0)</c>.</para>
/// </summary>
[GodotMethod("interpolate")]
public Vector2 Interpolate(int idx, float t)
@@ -190,7 +191,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolatef");
/// <summary>
- /// Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code].
+ /// <para>Returns the position at the vertex <c>fofs</c>. It calls <see cref="Godot.Curve2D.Interpolate"/> using the integer part of <c>fofs</c> as <c>idx</c>, and its fractional part as <c>t</c>.</para>
/// </summary>
[GodotMethod("interpolatef")]
public Vector2 Interpolatef(float fofs)
@@ -220,7 +221,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_baked_length");
/// <summary>
- /// Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough.
+ /// <para>Returns the total length of the curve, based on the cached points. Given enough density (see <see cref="Godot.Curve2D.BakeInterval"/>), it should be approximate enough.</para>
/// </summary>
[GodotMethod("get_baked_length")]
public float GetBakedLength()
@@ -232,9 +233,9 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate_baked");
/// <summary>
- /// Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve.
- /// To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to true, or linear if set to false.
- /// Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
+ /// <para>Returns a point within the curve at position <c>offset</c>, where <c>offset</c> is measured as a pixel distance along the curve.</para>
+ /// <para>To do that, it finds the two cached points where the <c>offset</c> lies between, then interpolates the values. This interpolation is cubic if <c>cubic</c> is set to true, or linear if set to false.</para>
+ /// <para>Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).</para>
/// </summary>
[GodotMethod("interpolate_baked")]
public Vector2 InterpolateBaked(float offset, bool cubic = false)
@@ -246,7 +247,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_baked_points");
/// <summary>
- /// Returns the cache of points as a [PoolVector2Array].
+ /// <para>Returns the cache of points as a <see cref="Godot.Vector2"/>.</para>
/// </summary>
[GodotMethod("get_baked_points")]
public Vector2[] GetBakedPoints()
@@ -258,8 +259,8 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_closest_point");
/// <summary>
- /// Returns the closest point (in curve's local space) to [code]to_point[/code].
- /// [code]to_point[/code] must be in this curve's local space.
+ /// <para>Returns the closest point (in curve's local space) to <c>to_point</c>.</para>
+ /// <para><c>to_point</c> must be in this curve's local space.</para>
/// </summary>
[GodotMethod("get_closest_point")]
public Vector2 GetClosestPoint(Vector2 toPoint)
@@ -271,8 +272,8 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_closest_offset");
/// <summary>
- /// Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked].
- /// [code]to_point[/code] must be in this curve's local space.
+ /// <para>Returns the closest offset to <c>to_point</c>. This offset is meant to be used in <see cref="Godot.Curve2D.InterpolateBaked"/>.</para>
+ /// <para><c>to_point</c> must be in this curve's local space.</para>
/// </summary>
[GodotMethod("get_closest_offset")]
public float GetClosestOffset(Vector2 toPoint)
@@ -284,10 +285,10 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "tessellate");
/// <summary>
- /// Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
- /// This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.
- /// [code]max_stages[/code] controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care!
- /// [code]tolerance_degrees[/code] controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
+ /// <para>Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.</para>
+ /// <para>This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.</para>
+ /// <para><c>max_stages</c> controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care!</para>
+ /// <para><c>tolerance_degrees</c> controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.</para>
/// </summary>
[GodotMethod("tessellate")]
public Vector2[] Tessellate(int maxStages = 5, float toleranceDegrees = (float)4)
@@ -314,3 +315,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Curve3D.cs GodotSharp_after/GodotSharp/ObjectType/Curve3D.cs
--- GodotSharp_before/GodotSharp/ObjectType/Curve3D.cs 2019-03-20 21:16:54.968112700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Curve3D.cs 2019-03-23 19:57:08.171989400 +0100
@@ -2,17 +2,18 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes.
- /// It keeps a cache of precalculated points along the curve, to speed further calculations up.
+ /// <para>This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a <see cref="Godot.Path"/>, but can be manually sampled for other purposes.</para>
+ /// <para>It keeps a cache of precalculated points along the curve, to speed further calculations up.</para>
/// </summary>
public partial class Curve3D : Resource
{
/// <summary>
- /// The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.
+ /// <para>The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the <see cref="Godot.Curve3D.GetBakedPoints"/> or <see cref="Godot.Curve3D.GetBakedLength"/> function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.</para>
/// </summary>
public float BakeInterval
{
@@ -39,7 +40,7 @@
}
/// <summary>
- /// If [code]true[/code], the curve will bake up vectors used for orientation. This is used when a [member PathFollow.rotation_mode] is set to [code]ROTATION_ORIENTED[/code], see [PathFollow] for details. Changing it forces the cache to be recomputed.
+ /// <para>If <c>true</c>, the curve will bake up vectors used for orientation. This is used when a <see cref="Godot.PathFollow.RotationMode"/> is set to <c>ROTATION_ORIENTED</c>, see <see cref="Godot.PathFollow"/> for details. Changing it forces the cache to be recomputed.</para>
/// </summary>
public bool UpVectorEnabled
{
@@ -67,7 +68,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_count");
/// <summary>
- /// Returns the number of points describing the curve.
+ /// <para>Returns the number of points describing the curve.</para>
/// </summary>
[GodotMethod("get_point_count")]
public int GetPointCount()
@@ -79,10 +80,10 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_point");
/// <summary>
- /// Adds a point to a curve, at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
- /// If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
- /// &lt;param name="@in"&gt;If the param is null, then the default value is new Vector3(0, 0, 0)&lt;/param&gt;
- /// &lt;param name="@out"&gt;If the param is null, then the default value is new Vector3(0, 0, 0)&lt;/param&gt;
+ /// <para>Adds a point to a curve, at <c>position</c>, with control points <c>in</c> and <c>out</c>.</para>
+ /// <para>If <c>at_position</c> is given, the point is inserted before the point number <c>at_position</c>, moving that point (and every point after) after the inserted point. If <c>at_position</c> is not given, or is an illegal value (<c>at_position &lt;0</c> or <c>at_position &gt;= [method get_point_count]</c>), the point will be appended at the end of the point list.</para>
+ /// <param name="in">If the parameter is null, then the default value is new Vector3(0, 0, 0)</param>
+ /// <param name="out">If the parameter is null, then the default value is new Vector3(0, 0, 0)</param>
/// </summary>
[GodotMethod("add_point")]
public void AddPoint(Vector3 position, Nullable<Vector3> @in = null, Nullable<Vector3> @out = null, int atPosition = -1)
@@ -96,7 +97,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_position");
/// <summary>
- /// Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
+ /// <para>Sets the position for the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
/// </summary>
[GodotMethod("set_point_position")]
public void SetPointPosition(int idx, Vector3 position)
@@ -108,7 +109,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_position");
/// <summary>
- /// Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
+ /// <para>Returns the position of the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>(0, 0, 0)</c>.</para>
/// </summary>
[GodotMethod("get_point_position")]
public Vector3 GetPointPosition(int idx)
@@ -120,8 +121,8 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_tilt");
/// <summary>
- /// Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
- /// The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the [PathFollow] calculates.
+ /// <para>Sets the tilt angle in radians for the point <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
+ /// <para>The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a <see cref="Godot.PathFollow"/>, this tilt is an offset over the natural tilt the <see cref="Godot.PathFollow"/> calculates.</para>
/// </summary>
[GodotMethod("set_point_tilt")]
public void SetPointTilt(int idx, float tilt)
@@ -133,7 +134,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_tilt");
/// <summary>
- /// Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code].
+ /// <para>Returns the tilt angle in radians for the point <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>0</c>.</para>
/// </summary>
[GodotMethod("get_point_tilt")]
public float GetPointTilt(int idx)
@@ -145,7 +146,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_in");
/// <summary>
- /// Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
+ /// <para>Sets the position of the control point leading to the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
/// </summary>
[GodotMethod("set_point_in")]
public void SetPointIn(int idx, Vector3 position)
@@ -157,7 +158,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_in");
/// <summary>
- /// Returns the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
+ /// <para>Returns the position of the control point leading to the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>(0, 0, 0)</c>.</para>
/// </summary>
[GodotMethod("get_point_in")]
public Vector3 GetPointIn(int idx)
@@ -169,7 +170,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_point_out");
/// <summary>
- /// Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
+ /// <para>Sets the position of the control point leading out of the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console.</para>
/// </summary>
[GodotMethod("set_point_out")]
public void SetPointOut(int idx, Vector3 position)
@@ -181,7 +182,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_point_out");
/// <summary>
- /// Returns the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
+ /// <para>Returns the position of the control point leading out of the vertex <c>idx</c>. If the index is out of bounds, the function sends an error to the console, and returns <c>(0, 0, 0)</c>.</para>
/// </summary>
[GodotMethod("get_point_out")]
public Vector3 GetPointOut(int idx)
@@ -193,7 +194,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_point");
/// <summary>
- /// Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds.
+ /// <para>Deletes the point <c>idx</c> from the curve. Sends an error to the console if <c>idx</c> is out of bounds.</para>
/// </summary>
[GodotMethod("remove_point")]
public void RemovePoint(int idx)
@@ -205,7 +206,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_points");
/// <summary>
- /// Removes all points from the curve.
+ /// <para>Removes all points from the curve.</para>
/// </summary>
[GodotMethod("clear_points")]
public void ClearPoints()
@@ -217,8 +218,8 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate");
/// <summary>
- /// Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results.
- /// If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
+ /// <para>Returns the position between the vertex <c>idx</c> and the vertex <c>idx + 1</c>, where <c>t</c> controls if the point is the first vertex (<c>t = 0.0</c>), the last vertex (<c>t = 1.0</c>), or in between. Values of <c>t</c> outside the range (<c>0.0 &gt;= t &lt;=1</c>) give strange, but predictable results.</para>
+ /// <para>If <c>idx</c> is out of bounds it is truncated to the first or last vertex, and <c>t</c> is ignored. If the curve has no points, the function sends an error to the console, and returns <c>(0, 0, 0)</c>.</para>
/// </summary>
[GodotMethod("interpolate")]
public Vector3 Interpolate(int idx, float t)
@@ -230,7 +231,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolatef");
/// <summary>
- /// Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code].
+ /// <para>Returns the position at the vertex <c>fofs</c>. It calls <see cref="Godot.Curve3D.Interpolate"/> using the integer part of <c>fofs</c> as <c>idx</c>, and its fractional part as <c>t</c>.</para>
/// </summary>
[GodotMethod("interpolatef")]
public Vector3 Interpolatef(float fofs)
@@ -278,7 +279,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_baked_length");
/// <summary>
- /// Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough.
+ /// <para>Returns the total length of the curve, based on the cached points. Given enough density (see <see cref="Godot.Curve3D.BakeInterval"/>), it should be approximate enough.</para>
/// </summary>
[GodotMethod("get_baked_length")]
public float GetBakedLength()
@@ -290,9 +291,9 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate_baked");
/// <summary>
- /// Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve.
- /// To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to true, or linear if set to false.
- /// Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
+ /// <para>Returns a point within the curve at position <c>offset</c>, where <c>offset</c> is measured as a pixel distance along the curve.</para>
+ /// <para>To do that, it finds the two cached points where the <c>offset</c> lies between, then interpolates the values. This interpolation is cubic if <c>cubic</c> is set to true, or linear if set to false.</para>
+ /// <para>Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).</para>
/// </summary>
[GodotMethod("interpolate_baked")]
public Vector3 InterpolateBaked(float offset, bool cubic = false)
@@ -304,9 +305,9 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "interpolate_baked_up_vector");
/// <summary>
- /// Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve.
- /// To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector.
- /// If the curve has no up vectors, the function sends an error to the console, and returns [code](0, 1, 0)[/code].
+ /// <para>Returns an up vector within the curve at position <c>offset</c>, where <c>offset</c> is measured as a distance in 3D units along the curve.</para>
+ /// <para>To do that, it finds the two cached up vectors where the <c>offset</c> lies between, then interpolates the values. If <c>apply_tilt</c> is <c>true</c>, an interpolated tilt is applied to the interpolated up vector.</para>
+ /// <para>If the curve has no up vectors, the function sends an error to the console, and returns <c>(0, 1, 0)</c>.</para>
/// </summary>
[GodotMethod("interpolate_baked_up_vector")]
public Vector3 InterpolateBakedUpVector(float offset, bool applyTilt = false)
@@ -318,7 +319,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_baked_points");
/// <summary>
- /// Returns the cache of points as a [PoolVector3Array].
+ /// <para>Returns the cache of points as a <see cref="Godot.Vector3"/>.</para>
/// </summary>
[GodotMethod("get_baked_points")]
public Vector3[] GetBakedPoints()
@@ -330,7 +331,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_baked_tilts");
/// <summary>
- /// Returns the cache of tilts as a [PoolRealArray].
+ /// <para>Returns the cache of tilts as a <see cref="float"/>.</para>
/// </summary>
[GodotMethod("get_baked_tilts")]
public float[] GetBakedTilts()
@@ -342,8 +343,8 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_baked_up_vectors");
/// <summary>
- /// Returns the cache of up vectors as a [PoolVector3Array].
- /// If [member up_vector_enabled] is [code]false[/code], the cache will be empty.
+ /// <para>Returns the cache of up vectors as a <see cref="Godot.Vector3"/>.</para>
+ /// <para>If <see cref="Godot.Curve3D.UpVectorEnabled"/> is <c>false</c>, the cache will be empty.</para>
/// </summary>
[GodotMethod("get_baked_up_vectors")]
public Vector3[] GetBakedUpVectors()
@@ -355,8 +356,8 @@
private static IntPtr method_bind_24 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_closest_point");
/// <summary>
- /// Returns the closest point (in curve's local space) to [code]to_point[/code].
- /// [code]to_point[/code] must be in this curve's local space.
+ /// <para>Returns the closest point (in curve's local space) to <c>to_point</c>.</para>
+ /// <para><c>to_point</c> must be in this curve's local space.</para>
/// </summary>
[GodotMethod("get_closest_point")]
public Vector3 GetClosestPoint(Vector3 toPoint)
@@ -368,8 +369,8 @@
private static IntPtr method_bind_25 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_closest_offset");
/// <summary>
- /// Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector].
- /// [code]to_point[/code] must be in this curve's local space.
+ /// <para>Returns the closest offset to <c>to_point</c>. This offset is meant to be used in <see cref="Godot.Curve3D.InterpolateBaked"/> or <see cref="Godot.Curve3D.InterpolateBakedUpVector"/>.</para>
+ /// <para><c>to_point</c> must be in this curve's local space.</para>
/// </summary>
[GodotMethod("get_closest_offset")]
public float GetClosestOffset(Vector3 toPoint)
@@ -381,10 +382,10 @@
private static IntPtr method_bind_26 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "tessellate");
/// <summary>
- /// Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
- /// This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.
- /// [code]max_stages[/code] controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care!
- /// [code]tolerance_degrees[/code] controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.
+ /// <para>Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.</para>
+ /// <para>This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.</para>
+ /// <para><c>max_stages</c> controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care!</para>
+ /// <para><c>tolerance_degrees</c> controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.</para>
/// </summary>
[GodotMethod("tessellate")]
public Vector3[] Tessellate(int maxStages = 5, float toleranceDegrees = (float)4)
@@ -411,3 +412,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CurveTexture.cs GodotSharp_after/GodotSharp/ObjectType/CurveTexture.cs
--- GodotSharp_before/GodotSharp/ObjectType/CurveTexture.cs 2019-03-20 21:16:54.972112300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CurveTexture.cs 2019-03-23 19:57:08.174987600 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Renders a given [Curve] provided to it. Simplifies the task of drawing curves and/or saving them as image files.
+ /// <para>Renders a given <see cref="Godot.Curve"/> provided to it. Simplifies the task of drawing curves and/or saving them as image files.</para>
/// </summary>
public partial class CurveTexture : Texture
{
/// <summary>
- /// The width of the texture.
+ /// <para>The width of the texture.</para>
/// </summary>
public int Width
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The [code]curve[/code] rendered onto the texture.
+ /// <para>The <c>curve</c> rendered onto the texture.</para>
/// </summary>
public Curve Curve
{
@@ -80,3 +81,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CylinderMesh.cs GodotSharp_after/GodotSharp/ObjectType/CylinderMesh.cs
--- GodotSharp_before/GodotSharp/ObjectType/CylinderMesh.cs 2019-03-20 21:16:54.976117100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CylinderMesh.cs 2019-03-23 19:57:08.178986800 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Class representing a cylindrical [PrimitiveMesh].
+ /// <para>Class representing a cylindrical <see cref="Godot.PrimitiveMesh"/>.</para>
/// </summary>
public partial class CylinderMesh : PrimitiveMesh
{
/// <summary>
- /// Top radius of the cylinder. Defaults to 1.0.
+ /// <para>Top radius of the cylinder. Defaults to 1.0.</para>
/// </summary>
public float TopRadius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// Bottom radius of the cylinder. Defaults to 1.0.
+ /// <para>Bottom radius of the cylinder. Defaults to 1.0.</para>
/// </summary>
public float BottomRadius
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// Full height of the cylinder. Defaults to 2.0.
+ /// <para>Full height of the cylinder. Defaults to 2.0.</para>
/// </summary>
public float Height
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Number of radial segments on the cylinder. Defaults to 64.
+ /// <para>Number of radial segments on the cylinder. Defaults to 64.</para>
/// </summary>
public int RadialSegments
{
@@ -71,7 +72,7 @@
}
/// <summary>
- /// Number of edge rings along the height of the cylinder. Defaults to 4.
+ /// <para>Number of edge rings along the height of the cylinder. Defaults to 4.</para>
/// </summary>
public int Rings
{
@@ -188,3 +189,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/CylinderShape.cs GodotSharp_after/GodotSharp/ObjectType/CylinderShape.cs
--- GodotSharp_before/GodotSharp/ObjectType/CylinderShape.cs 2019-03-20 21:16:54.979109500 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/CylinderShape.cs 2019-03-23 19:57:08.180986300 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Cylinder shape for collisions.
+ /// <para>Cylinder shape for collisions.</para>
/// </summary>
public partial class CylinderShape : Shape
{
/// <summary>
- /// The cylinder's radius.
+ /// <para>The cylinder's radius.</para>
/// </summary>
public float Radius
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The cylinder's height.
+ /// <para>The cylinder's height.</para>
/// </summary>
public float Height
{
@@ -89,3 +90,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/DampedSpringJoint2D.cs GodotSharp_after/GodotSharp/ObjectType/DampedSpringJoint2D.cs
--- GodotSharp_before/GodotSharp/ObjectType/DampedSpringJoint2D.cs 2019-03-20 21:16:54.984108600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/DampedSpringJoint2D.cs 2019-03-23 19:57:08.183985400 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
+ /// <para>Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.</para>
/// </summary>
public partial class DampedSpringJoint2D : Joint2D
{
/// <summary>
- /// The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: [code]50[/code]
+ /// <para>The spring joint's maximum length. The two attached bodies cannot stretch it past this value. Default value: <c>50</c></para>
/// </summary>
public float Length
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: [code]0[/code]
+ /// <para>When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length. Default value: <c>0</c></para>
/// </summary>
public float RestLength
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: [code]20[/code]
+ /// <para>The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length. Default value: <c>20</c></para>
/// </summary>
public float Stiffness
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster. Default value: [code]1[/code]
+ /// <para>The spring joint's damping ratio. A value between <c>0</c> and <c>1</c>. When the two bodies move into different directions the system tries to align them to the spring axis again. A high <c>damping</c> value forces the attached bodies to align faster. Default value: <c>1</c></para>
/// </summary>
public float Damping
{
@@ -155,3 +156,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/DirectionalLight.cs GodotSharp_after/GodotSharp/ObjectType/DirectionalLight.cs
--- GodotSharp_before/GodotSharp/ObjectType/DirectionalLight.cs 2019-03-20 21:16:54.987106700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/DirectionalLight.cs 2019-03-23 19:57:08.187984000 +0100
@@ -2,26 +2,27 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// A directional light is a type of [Light] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction.
+ /// <para>A directional light is a type of <see cref="Godot.Light"/> node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction.</para>
/// </summary>
public partial class DirectionalLight : Light
{
public enum ShadowMode
{
/// <summary>
- /// Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects.
+ /// <para>Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects.</para>
/// </summary>
Orthogonal = 0,
/// <summary>
- /// Splits the view frustum in 2 areas, each with its own shadow map.
+ /// <para>Splits the view frustum in 2 areas, each with its own shadow map.</para>
/// </summary>
Parallel2Splits = 1,
/// <summary>
- /// Splits the view frustum in 4 areas, each with its own shadow map.
+ /// <para>Splits the view frustum in 4 areas, each with its own shadow map.</para>
/// </summary>
Parallel4Splits = 2
}
@@ -29,17 +30,17 @@
public enum ShadowDepthRange
{
/// <summary>
- /// Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value.
+ /// <para>Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value.</para>
/// </summary>
Stable = 0,
/// <summary>
- /// Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges.
+ /// <para>Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges.</para>
/// </summary>
Optimized = 1
}
/// <summary>
- /// The light's shadow rendering algorithm. See [enum ShadowMode].
+ /// <para>The light's shadow rendering algorithm. See <see cref="Godot.DirectionalLight.ShadowMode"/>.</para>
/// </summary>
public DirectionalLight.ShadowMode DirectionalShadowMode
{
@@ -54,7 +55,7 @@
}
/// <summary>
- /// The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is one of the [code]SHADOW_PARALLEL_*_SPLITS[/code] constants.
+ /// <para>The distance from camera to shadow split 1. Relative to <see cref="Godot.DirectionalLight.DirectionalShadowMaxDistance"/>. Only used when <see cref="Godot.DirectionalLight.DirectionalShadowMode"/> is one of the <c>SHADOW_PARALLEL_*_SPLITS</c> constants.</para>
/// </summary>
public float DirectionalShadowSplit1
{
@@ -69,7 +70,7 @@
}
/// <summary>
- /// The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_3_SPLITS[/code] or [code]SHADOW_PARALLEL_4_SPLITS[/code].
+ /// <para>The distance from shadow split 1 to split 2. Relative to <see cref="Godot.DirectionalLight.DirectionalShadowMaxDistance"/>. Only used when <see cref="Godot.DirectionalLight.DirectionalShadowMode"/> is <c>SHADOW_PARALLEL_3_SPLITS</c> or <c>SHADOW_PARALLEL_4_SPLITS</c>.</para>
/// </summary>
public float DirectionalShadowSplit2
{
@@ -84,7 +85,7 @@
}
/// <summary>
- /// The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code].
+ /// <para>The distance from shadow split 2 to split 3. Relative to <see cref="Godot.DirectionalLight.DirectionalShadowMaxDistance"/>. Only used when <see cref="Godot.DirectionalLight.DirectionalShadowMode"/> is <c>SHADOW_PARALLEL_4_SPLITS</c>.</para>
/// </summary>
public float DirectionalShadowSplit3
{
@@ -99,7 +100,7 @@
}
/// <summary>
- /// If [code]true[/code], shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:[code]false[/code].
+ /// <para>If <c>true</c>, shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:<c>false</c>.</para>
/// </summary>
public bool DirectionalShadowBlendSplits
{
@@ -114,7 +115,7 @@
}
/// <summary>
- /// Can be used to fix special cases of self shadowing when objects are perpendicular to the light.
+ /// <para>Can be used to fix special cases of self shadowing when objects are perpendicular to the light.</para>
/// </summary>
public float DirectionalShadowNormalBias
{
@@ -129,7 +130,7 @@
}
/// <summary>
- /// Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them.
+ /// <para>Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them.</para>
/// </summary>
public float DirectionalShadowBiasSplitScale
{
@@ -144,7 +145,7 @@
}
/// <summary>
- /// Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange].
+ /// <para>Optimizes shadow rendering for detail versus movement. See <see cref="Godot.DirectionalLight.ShadowDepthRange"/>.</para>
/// </summary>
public DirectionalLight.ShadowDepthRange DirectionalShadowDepthRange
{
@@ -159,7 +160,7 @@
}
/// <summary>
- /// The maximum distance for shadow splits.
+ /// <para>The maximum distance for shadow splits.</para>
/// </summary>
public float DirectionalShadowMaxDistance
{
@@ -240,3 +241,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Directory.cs GodotSharp_after/GodotSharp/ObjectType/Directory.cs
--- GodotSharp_before/GodotSharp/ObjectType/Directory.cs 2019-03-20 21:16:57.378832700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Directory.cs 2019-03-23 19:57:09.901546600 +0100
@@ -2,13 +2,14 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Directory type. It is used to manage directories and their content (not restricted to the project folder).
- /// Here is an example on how to iterate through the files of a directory:
- /// [codeblock]
+ /// <para>Directory type. It is used to manage directories and their content (not restricted to the project folder).</para>
+ /// <para>Here is an example on how to iterate through the files of a directory:</para>
+ /// <para><code>
/// func dir_contents(path):
/// var dir = Directory.new()
/// if dir.open(path) == OK:
@@ -22,7 +23,7 @@
/// file_name = dir.get_next()
/// else:
/// print("An error occurred when trying to access the path.")
- /// [/codeblock]
+ /// </code></para>
/// </summary>
public partial class Directory : Reference
{
@@ -40,8 +41,8 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "open");
/// <summary>
- /// Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]).
- /// The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*).
+ /// <para>Open an existing directory of the filesystem. The path argument can be within the project tree (<c>res://folder</c>), the user directory (<c>user://folder</c>) or an absolute path of the user filesystem (e.g. <c>/tmp/folder</c> or <c>C:\tmp\folder</c>).</para>
+ /// <para>The method returns one of the error code constants defined in <c>@GlobalScope</c> (OK or ERR_*).</para>
/// </summary>
[GodotMethod("open")]
public Error Open(string path)
@@ -53,9 +54,9 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "list_dir_begin");
/// <summary>
- /// Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end].
- /// If you pass [code]skip_navigational[/code], then [code].[/code] and [code]..[/code] would be filtered out.
- /// If you pass [code]skip_hidden[/code], then hidden files would be filtered out.
+ /// <para>Initialise the stream used to list all files and directories using the <see cref="Godot.Directory.GetNext"/> function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with <see cref="Godot.Directory.ListDirEnd"/>.</para>
+ /// <para>If you pass <c>skip_navigational</c>, then <c>.</c> and <c>..</c> would be filtered out.</para>
+ /// <para>If you pass <c>skip_hidden</c>, then hidden files would be filtered out.</para>
/// </summary>
[GodotMethod("list_dir_begin")]
public Error ListDirBegin(bool skipNavigational = false, bool skipHidden = false)
@@ -67,8 +68,8 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_next");
/// <summary>
- /// Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]).
- /// The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case).
+ /// <para>Return the next element (file or directory) in the current directory (including <c>.</c> and <c>..</c>, unless <c>skip_navigational</c> was given to <see cref="Godot.Directory.ListDirBegin"/>).</para>
+ /// <para>The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. <see cref="Godot.Directory.ListDirEnd"/> would not be mandatory in such a case).</para>
/// </summary>
[GodotMethod("get_next")]
public string GetNext()
@@ -80,7 +81,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "current_is_dir");
/// <summary>
- /// Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories).
+ /// <para>Return whether the current item processed with the last <see cref="Godot.Directory.GetNext"/> call is a directory (<c>.</c> and <c>..</c> are considered directories).</para>
/// </summary>
[GodotMethod("current_is_dir")]
public bool CurrentIsDir()
@@ -92,7 +93,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "list_dir_end");
/// <summary>
- /// Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter).
+ /// <para>Close the current stream opened with <see cref="Godot.Directory.ListDirBegin"/> (whether it has been fully processed with <see cref="Godot.Directory.GetNext"/> or not does not matter).</para>
/// </summary>
[GodotMethod("list_dir_end")]
public void ListDirEnd()
@@ -104,7 +105,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_drive_count");
/// <summary>
- /// On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
+ /// <para>On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.</para>
/// </summary>
[GodotMethod("get_drive_count")]
public int GetDriveCount()
@@ -116,7 +117,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_drive");
/// <summary>
- /// On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String.
+ /// <para>On Windows, return the name of the drive (partition) passed as an argument (e.g. <c>C:</c>). On other platforms, or if the requested drive does not existed, the method returns an empty String.</para>
/// </summary>
[GodotMethod("get_drive")]
public string GetDrive(int idx)
@@ -128,7 +129,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_current_drive");
/// <summary>
- /// Returns the currently opened directory's drive index. See [method get_drive] to convert returned index to the name of the drive.
+ /// <para>Returns the currently opened directory's drive index. See <see cref="Godot.Directory.GetDrive"/> to convert returned index to the name of the drive.</para>
/// </summary>
[GodotMethod("get_current_drive")]
public int GetCurrentDrive()
@@ -140,8 +141,8 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "change_dir");
/// <summary>
- /// Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]).
- /// The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*).
+ /// <para>Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. <c>newdir</c> or <c>../newdir</c>), or an absolute path (e.g. <c>/tmp/newdir</c> or <c>res://somedir/newdir</c>).</para>
+ /// <para>The method returns one of the error code constants defined in <c>@GlobalScope</c> (OK or ERR_*).</para>
/// </summary>
[GodotMethod("change_dir")]
public Error ChangeDir(string todir)
@@ -153,7 +154,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_current_dir");
/// <summary>
- /// Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]).
+ /// <para>Return the absolute path to the currently opened directory (e.g. <c>res://folder</c> or <c>C:\tmp\folder</c>).</para>
/// </summary>
[GodotMethod("get_current_dir")]
public string GetCurrentDir()
@@ -165,8 +166,8 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_dir");
/// <summary>
- /// Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]).
- /// The method returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).
+ /// <para>Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see <see cref="Godot.Directory.MakeDirRecursive"/>).</para>
+ /// <para>The method returns one of the error code constants defined in <c>@GlobalScope</c> (OK, FAILED or ERR_*).</para>
/// </summary>
[GodotMethod("make_dir")]
public Error MakeDir(string path)
@@ -178,8 +179,8 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "make_dir_recursive");
/// <summary>
- /// Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path.
- /// Return one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).
+ /// <para>Create a target directory and all necessary intermediate directories in its path, by calling <see cref="Godot.Directory.MakeDir"/> recursively. The argument can be relative to the current directory, or an absolute path.</para>
+ /// <para>Return one of the error code constants defined in <c>@GlobalScope</c> (OK, FAILED or ERR_*).</para>
/// </summary>
[GodotMethod("make_dir_recursive")]
public Error MakeDirRecursive(string path)
@@ -191,7 +192,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "file_exists");
/// <summary>
- /// Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
+ /// <para>Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.</para>
/// </summary>
[GodotMethod("file_exists")]
public bool FileExists(string path)
@@ -203,7 +204,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "dir_exists");
/// <summary>
- /// Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
+ /// <para>Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.</para>
/// </summary>
[GodotMethod("dir_exists")]
public bool DirExists(string path)
@@ -215,7 +216,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_space_left");
/// <summary>
- /// On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
+ /// <para>On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.</para>
/// </summary>
[GodotMethod("get_space_left")]
public int GetSpaceLeft()
@@ -227,8 +228,8 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "copy");
/// <summary>
- /// Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
- /// Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).
+ /// <para>Copy the from file to the to destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.</para>
+ /// <para>Returns one of the error code constants defined in <c>@GlobalScope</c> (OK, FAILED or ERR_*).</para>
/// </summary>
[GodotMethod("copy")]
public Error Copy(string from, string to)
@@ -240,8 +241,8 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "rename");
/// <summary>
- /// Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
- /// Return one of the error code constants defined in [@GlobalScope] (OK or FAILED).
+ /// <para>Rename (move) the from file to the to destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.</para>
+ /// <para>Return one of the error code constants defined in <c>@GlobalScope</c> (OK or FAILED).</para>
/// </summary>
[GodotMethod("rename")]
public Error Rename(string from, string to)
@@ -253,8 +254,8 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove");
/// <summary>
- /// Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
- /// Return one of the error code constants defined in [@GlobalScope] (OK or FAILED).
+ /// <para>Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.</para>
+ /// <para>Return one of the error code constants defined in <c>@GlobalScope</c> (OK or FAILED).</para>
/// </summary>
[GodotMethod("remove")]
public Error Remove(string path)
@@ -265,3 +266,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/DynamicFont.cs GodotSharp_after/GodotSharp/ObjectType/DynamicFont.cs
--- GodotSharp_before/GodotSharp/ObjectType/DynamicFont.cs 2019-03-20 21:16:54.994105100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/DynamicFont.cs 2019-03-23 19:57:08.193982400 +0100
@@ -2,36 +2,37 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths.
+ /// <para>DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like <see cref="Godot.BitmapFont"/>. This trades the faster loading time of <see cref="Godot.BitmapFont"/>s for the ability to change font parameters like size and spacing during runtime. <see cref="Godot.DynamicFontData"/> is used for referencing the font file paths.</para>
/// </summary>
public partial class DynamicFont : Font
{
public enum SpacingType
{
/// <summary>
- /// Spacing at the top.
+ /// <para>Spacing at the top.</para>
/// </summary>
Top = 0,
/// <summary>
- /// Spacing at the bottom.
+ /// <para>Spacing at the bottom.</para>
/// </summary>
Bottom = 1,
/// <summary>
- /// Character spacing.
+ /// <para>Character spacing.</para>
/// </summary>
Char = 2,
/// <summary>
- /// Space spacing.
+ /// <para>Space spacing.</para>
/// </summary>
Space = 3
}
/// <summary>
- /// The font size.
+ /// <para>The font size.</para>
/// </summary>
public int Size
{
@@ -76,7 +77,7 @@
}
/// <summary>
- /// If [code]true[/code], mipmapping is used.
+ /// <para>If <c>true</c>, mipmapping is used.</para>
/// </summary>
public bool UseMipmaps
{
@@ -91,7 +92,7 @@
}
/// <summary>
- /// If [code]true[/code], filtering is used.
+ /// <para>If <c>true</c>, filtering is used.</para>
/// </summary>
public bool UseFilter
{
@@ -106,7 +107,7 @@
}
/// <summary>
- /// Extra spacing at the top in pixels.
+ /// <para>Extra spacing at the top in pixels.</para>
/// </summary>
public int ExtraSpacingTop
{
@@ -121,7 +122,7 @@
}
/// <summary>
- /// Extra spacing at the bottom in pixels.
+ /// <para>Extra spacing at the bottom in pixels.</para>
/// </summary>
public int ExtraSpacingBottom
{
@@ -136,7 +137,7 @@
}
/// <summary>
- /// Extra character spacing in pixels.
+ /// <para>Extra character spacing in pixels.</para>
/// </summary>
public int ExtraSpacingChar
{
@@ -151,7 +152,7 @@
}
/// <summary>
- /// Extra space spacing in pixels.
+ /// <para>Extra space spacing in pixels.</para>
/// </summary>
public int ExtraSpacingSpace
{
@@ -166,7 +167,7 @@
}
/// <summary>
- /// The font data.
+ /// <para>The font data.</para>
/// </summary>
public DynamicFontData FontData
{
@@ -320,7 +321,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_fallback");
/// <summary>
- /// Adds a fallback font.
+ /// <para>Adds a fallback font.</para>
/// </summary>
[GodotMethod("add_fallback")]
public void AddFallback(DynamicFontData data)
@@ -332,7 +333,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_fallback");
/// <summary>
- /// Sets the fallback font at index [code]idx[/code].
+ /// <para>Sets the fallback font at index <c>idx</c>.</para>
/// </summary>
[GodotMethod("set_fallback")]
public void SetFallback(int idx, DynamicFontData data)
@@ -344,7 +345,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_fallback");
/// <summary>
- /// Returns the fallback font at index [code]idx[/code].
+ /// <para>Returns the fallback font at index <c>idx</c>.</para>
/// </summary>
[GodotMethod("get_fallback")]
public DynamicFontData GetFallback(int idx)
@@ -356,7 +357,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "remove_fallback");
/// <summary>
- /// Removes the fallback font at index [code]idx[/code].
+ /// <para>Removes the fallback font at index <c>idx</c>.</para>
/// </summary>
[GodotMethod("remove_fallback")]
public void RemoveFallback(int idx)
@@ -368,7 +369,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_fallback_count");
/// <summary>
- /// Returns the number of fallback fonts.
+ /// <para>Returns the number of fallback fonts.</para>
/// </summary>
[GodotMethod("get_fallback_count")]
public int GetFallbackCount()
@@ -379,3 +380,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/DynamicFontData.cs GodotSharp_after/GodotSharp/ObjectType/DynamicFontData.cs
--- GodotSharp_before/GodotSharp/ObjectType/DynamicFontData.cs 2019-03-20 21:16:54.998103200 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/DynamicFontData.cs 2019-03-23 19:57:08.196980900 +0100
@@ -2,32 +2,33 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Used with [DynamicFont] to describe the location of a vector font file for dynamic rendering at runtime.
+ /// <para>Used with <see cref="Godot.DynamicFont"/> to describe the location of a vector font file for dynamic rendering at runtime.</para>
/// </summary>
public partial class DynamicFontData : Resource
{
public enum HintingEnum
{
/// <summary>
- /// Disable font hinting (smoother but less crisp).
+ /// <para>Disable font hinting (smoother but less crisp).</para>
/// </summary>
None = 0,
/// <summary>
- /// Use the light font hinting mode.
+ /// <para>Use the light font hinting mode.</para>
/// </summary>
Light = 1,
/// <summary>
- /// Use the default font hinting mode (crisper but less smooth).
+ /// <para>Use the default font hinting mode (crisper but less smooth).</para>
/// </summary>
Normal = 2
}
/// <summary>
- /// Controls whether the font should be rendered with anti-aliasing.
+ /// <para>Controls whether the font should be rendered with anti-aliasing.</para>
/// </summary>
public bool Antialiased
{
@@ -42,7 +43,7 @@
}
/// <summary>
- /// The font hinting mode used by FreeType.
+ /// <para>The font hinting mode used by FreeType.</para>
/// </summary>
public DynamicFontData.HintingEnum Hinting
{
@@ -57,7 +58,7 @@
}
/// <summary>
- /// The path to the vector font file.
+ /// <para>The path to the vector font file.</para>
/// </summary>
public string FontPath
{
@@ -138,3 +139,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/EncodedObjectAsID.cs GodotSharp_after/GodotSharp/ObjectType/EncodedObjectAsID.cs
--- GodotSharp_before/GodotSharp/ObjectType/EncodedObjectAsID.cs 2019-03-20 21:16:55.001103100 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/EncodedObjectAsID.cs 2019-03-23 19:57:08.199979700 +0100
@@ -2,6 +2,7 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
@@ -44,3 +45,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Engine.cs GodotSharp_after/GodotSharp/ObjectType/Engine.cs
--- GodotSharp_before/GodotSharp/ObjectType/Engine.cs 2019-03-20 21:16:57.384830800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Engine.cs 2019-03-23 19:57:09.907543800 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// The [code]Engine[/code] class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others.
+ /// <para>The <c>Engine</c> class allows you to query and modify the game's run-time parameters, such as frames per second, time scale, and others.</para>
/// </summary>
public static partial class Engine
{
/// <summary>
- /// If [code]true[/code], it is running inside the editor. Useful for tool scripts.
+ /// <para>If <c>true</c>, it is running inside the editor. Useful for tool scripts.</para>
/// </summary>
public static bool EditorHint
{
@@ -26,7 +27,7 @@
}
/// <summary>
- /// The number of fixed iterations per second (for fixed process and physics).
+ /// <para>The number of fixed iterations per second (for fixed process and physics).</para>
/// </summary>
public static int IterationsPerSecond
{
@@ -41,7 +42,7 @@
}
/// <summary>
- /// The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
+ /// <para>The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.</para>
/// </summary>
public static int TargetFps
{
@@ -56,7 +57,7 @@
}
/// <summary>
- /// Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.
+ /// <para>Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed.</para>
/// </summary>
public static float TimeScale
{
@@ -176,7 +177,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_frames_drawn");
/// <summary>
- /// Returns the total number of frames drawn.
+ /// <para>Returns the total number of frames drawn.</para>
/// </summary>
[GodotMethod("get_frames_drawn")]
public static int GetFramesDrawn()
@@ -188,7 +189,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_frames_per_second");
/// <summary>
- /// Returns the frames per second of the running game.
+ /// <para>Returns the frames per second of the running game.</para>
/// </summary>
[GodotMethod("get_frames_per_second")]
public static float GetFramesPerSecond()
@@ -200,7 +201,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_main_loop");
/// <summary>
- /// Returns the main loop object (see [MainLoop] and [SceneTree]).
+ /// <para>Returns the main loop object (see <see cref="Godot.MainLoop"/> and <see cref="Godot.SceneTree"/>).</para>
/// </summary>
[GodotMethod("get_main_loop")]
public static MainLoop GetMainLoop()
@@ -212,21 +213,21 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_version_info");
/// <summary>
- /// Returns the current engine version information in a Dictionary.
- /// "major" - Holds the major version number as an int
- /// "minor" - Holds the minor version number as an int
- /// "patch" - Holds the patch version number as an int
- /// "hex" - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below)
- /// "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String
- /// "build" - Holds the build name (e.g. "custom-build") as a String
- /// "string" - major + minor + patch + status + build in a single String
- /// The "hex" value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be [code]0x03010C[/code]. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code:
- /// [codeblock]
+ /// <para>Returns the current engine version information in a Dictionary.</para>
+ /// <para>"major" - Holds the major version number as an int</para>
+ /// <para>"minor" - Holds the minor version number as an int</para>
+ /// <para>"patch" - Holds the patch version number as an int</para>
+ /// <para>"hex" - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below)</para>
+ /// <para>"status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String</para>
+ /// <para>"build" - Holds the build name (e.g. "custom-build") as a String</para>
+ /// <para>"string" - major + minor + patch + status + build in a single String</para>
+ /// <para>The "hex" value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be <c>0x03010C</c>. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code:</para>
+ /// <para><code>
/// if Engine.get_version_info().hex &gt;= 0x030200:
/// # do things specific to version 3.2 or later
/// else:
/// # do things specific to versions before 3.2
- /// [/codeblock]
+ /// </code></para>
/// </summary>
[GodotMethod("get_version_info")]
public static Godot.Collections.Dictionary GetVersionInfo()
@@ -238,11 +239,11 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_author_info");
/// <summary>
- /// Returns engine author information in a Dictionary.
- /// "lead_developers" - Array of Strings, lead developer names
- /// "founders" - Array of Strings, founder names
- /// "project_managers" - Array of Strings, project manager names
- /// "developers" - Array of Strings, developer names
+ /// <para>Returns engine author information in a Dictionary.</para>
+ /// <para>"lead_developers" - Array of Strings, lead developer names</para>
+ /// <para>"founders" - Array of Strings, founder names</para>
+ /// <para>"project_managers" - Array of Strings, project manager names</para>
+ /// <para>"developers" - Array of Strings, developer names</para>
/// </summary>
[GodotMethod("get_author_info")]
public static Godot.Collections.Dictionary GetAuthorInfo()
@@ -254,9 +255,9 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_copyright_info");
/// <summary>
- /// Returns an Array of copyright information Dictionaries.
- /// "name" - String, component name
- /// "parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component
+ /// <para>Returns an Array of copyright information Dictionaries.</para>
+ /// <para>"name" - String, component name</para>
+ /// <para>"parts" - Array of Dictionaries {"files", "copyright", "license"} describing subsections of the component</para>
/// </summary>
[GodotMethod("get_copyright_info")]
public static Godot.Collections.Array GetCopyrightInfo()
@@ -268,8 +269,8 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_donor_info");
/// <summary>
- /// Returns a Dictionary of Arrays of donor names.
- /// {"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"}
+ /// <para>Returns a Dictionary of Arrays of donor names.</para>
+ /// <para>{"platinum_sponsors", "gold_sponsors", "mini_sponsors", "gold_donors", "silver_donors", "bronze_donors"}</para>
/// </summary>
[GodotMethod("get_donor_info")]
public static Godot.Collections.Dictionary GetDonorInfo()
@@ -281,7 +282,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_license_info");
/// <summary>
- /// Returns Dictionary of licenses used by Godot and included third party components.
+ /// <para>Returns Dictionary of licenses used by Godot and included third party components.</para>
/// </summary>
[GodotMethod("get_license_info")]
public static Godot.Collections.Dictionary GetLicenseInfo()
@@ -293,7 +294,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_license_text");
/// <summary>
- /// Returns Godot license text.
+ /// <para>Returns Godot license text.</para>
/// </summary>
[GodotMethod("get_license_text")]
public static string GetLicenseText()
@@ -305,7 +306,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_in_physics_frame");
/// <summary>
- /// Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop.
+ /// <para>Returns <c>true</c> if the game is inside the fixed process and physics phase of the game loop.</para>
/// </summary>
[GodotMethod("is_in_physics_frame")]
public static bool IsInPhysicsFrame()
@@ -358,3 +359,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Environment.cs GodotSharp_after/GodotSharp/ObjectType/Environment.cs
--- GodotSharp_before/GodotSharp/ObjectType/Environment.cs 2019-03-20 21:16:55.024095400 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Environment.cs 2019-03-23 19:57:08.219975000 +0100
@@ -2,16 +2,17 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Resource for environment nodes (like [WorldEnvironment]) that define multiple environment operations (such as background [Sky] or [Color], ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is:
- /// - DOF Blur
- /// - Motion Blur
- /// - Bloom
- /// - Tonemap (auto exposure)
- /// - Adjustments
+ /// <para>Resource for environment nodes (like <see cref="Godot.WorldEnvironment"/>) that define multiple environment operations (such as background <see cref="Godot.Sky"/> or <see cref="Godot.Color"/>, ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is:</para>
+ /// <para>- DOF Blur</para>
+ /// <para>- Motion Blur</para>
+ /// <para>- Bloom</para>
+ /// <para>- Tonemap (auto exposure)</para>
+ /// <para>- Adjustments</para>
/// </summary>
public partial class Environment : Resource
{
@@ -38,19 +39,19 @@
public enum ToneMapper
{
/// <summary>
- /// Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.
+ /// <para>Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.</para>
/// </summary>
Linear = 0,
/// <summary>
- /// Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color).
+ /// <para>Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color).</para>
/// </summary>
Reinhardt = 1,
/// <summary>
- /// Filmic tonemapper operator.
+ /// <para>Filmic tonemapper operator.</para>
/// </summary>
Filmic = 2,
/// <summary>
- /// Academy Color Encoding System tonemapper operator.
+ /// <para>Academy Color Encoding System tonemapper operator.</para>
/// </summary>
Aces = 3
}
@@ -58,19 +59,19 @@
public enum GlowBlendModeEnum
{
/// <summary>
- /// Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
+ /// <para>Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.</para>
/// </summary>
Additive = 0,
/// <summary>
- /// Screen glow blending mode. Increases brightness, used frequently with bloom.
+ /// <para>Screen glow blending mode. Increases brightness, used frequently with bloom.</para>
/// </summary>
Screen = 1,
/// <summary>
- /// Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom.
+ /// <para>Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom.</para>
/// </summary>
Softlight = 2,
/// <summary>
- /// Replace glow blending mode. Replaces all pixels' color by the glow value.
+ /// <para>Replace glow blending mode. Replaces all pixels' color by the glow value.</para>
/// </summary>
Replace = 3
}
@@ -78,31 +79,31 @@
public enum BGMode
{
/// <summary>
- /// Keep on screen every pixel drawn in the background.
+ /// <para>Keep on screen every pixel drawn in the background.</para>
/// </summary>
Keep = 5,
/// <summary>
- /// Clear the background using the project's clear color.
+ /// <para>Clear the background using the project's clear color.</para>
/// </summary>
ClearColor = 0,
/// <summary>
- /// Clear the background using a custom clear color.
+ /// <para>Clear the background using a custom clear color.</para>
/// </summary>
Color = 1,
/// <summary>
- /// Display a user-defined sky in the background.
+ /// <para>Display a user-defined sky in the background.</para>
/// </summary>
Sky = 2,
/// <summary>
- /// Clear the background using a custom clear color and allows defining a sky for shading and reflection.
+ /// <para>Clear the background using a custom clear color and allows defining a sky for shading and reflection.</para>
/// </summary>
ColorSky = 3,
/// <summary>
- /// Display a [CanvasLayer] in the background.
+ /// <para>Display a <see cref="Godot.CanvasLayer"/> in the background.</para>
/// </summary>
Canvas = 4,
/// <summary>
- /// Helper constant keeping track of the enum's size, has no direct usage in API calls.
+ /// <para>Helper constant keeping track of the enum's size, has no direct usage in API calls.</para>
/// </summary>
Max = 6
}
@@ -126,21 +127,21 @@
public enum DOFBlurQuality
{
/// <summary>
- /// Low depth-of-field blur quality.
+ /// <para>Low depth-of-field blur quality.</para>
/// </summary>
Low = 0,
/// <summary>
- /// Medium depth-of-field blur quality.
+ /// <para>Medium depth-of-field blur quality.</para>
/// </summary>
Medium = 1,
/// <summary>
- /// High depth-of-field blur quality.
+ /// <para>High depth-of-field blur quality.</para>
/// </summary>
High = 2
}
/// <summary>
- /// Defines the mode of background.
+ /// <para>Defines the mode of background.</para>
/// </summary>
public Environment.BGMode BackgroundMode
{
@@ -155,7 +156,7 @@
}
/// <summary>
- /// [Sky] resource defined as background.
+ /// <para><see cref="Godot.Sky"/> resource defined as background.</para>
/// </summary>
public Sky BackgroundSky
{
@@ -170,7 +171,7 @@
}
/// <summary>
- /// [Sky] resource's custom field of view.
+ /// <para><see cref="Godot.Sky"/> resource's custom field of view.</para>
/// </summary>
public float BackgroundSkyCustomFov
{
@@ -185,7 +186,7 @@
}
/// <summary>
- /// [Sky] resource's rotation expressed as a [Basis]
+ /// <para><see cref="Godot.Sky"/> resource's rotation expressed as a <see cref="Godot.Basis"/></para>
/// </summary>
public Basis BackgroundSkyOrientation
{
@@ -200,7 +201,7 @@
}
/// <summary>
- /// [Sky] resource's rotation expressed as euler angles in radians
+ /// <para><see cref="Godot.Sky"/> resource's rotation expressed as euler angles in radians</para>
/// </summary>
public Vector3 BackgroundSkyRotation
{
@@ -215,7 +216,7 @@
}
/// <summary>
- /// [Sky] resource's rotation expressed as euler angles in degrees
+ /// <para><see cref="Godot.Sky"/> resource's rotation expressed as euler angles in degrees</para>
/// </summary>
public Vector3 BackgroundSkyRotationDegrees
{
@@ -230,7 +231,7 @@
}
/// <summary>
- /// Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
+ /// <para>Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).</para>
/// </summary>
public Color BackgroundColor
{
@@ -245,7 +246,7 @@
}
/// <summary>
- /// Power of light emitted by the background.
+ /// <para>Power of light emitted by the background.</para>
/// </summary>
public float BackgroundEnergy
{
@@ -260,7 +261,7 @@
}
/// <summary>
- /// Maximum layer id (if using Layer background mode).
+ /// <para>Maximum layer id (if using Layer background mode).</para>
/// </summary>
public int BackgroundCanvasMaxLayer
{
@@ -275,7 +276,7 @@
}
/// <summary>
- /// [Color] of the ambient light.
+ /// <para><see cref="Godot.Color"/> of the ambient light.</para>
/// </summary>
public Color AmbientLightColor
{
@@ -290,7 +291,7 @@
}
/// <summary>
- /// Energy of the ambient light. The higher the value, the stronger the light.
+ /// <para>Energy of the ambient light. The higher the value, the stronger the light.</para>
/// </summary>
public float AmbientLightEnergy
{
@@ -305,7 +306,7 @@
}
/// <summary>
- /// Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene.
+ /// <para>Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene.</para>
/// </summary>
public float AmbientLightSkyContribution
{
@@ -320,7 +321,7 @@
}
/// <summary>
- /// Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
+ /// <para>Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.</para>
/// </summary>
public bool FogEnabled
{
@@ -335,7 +336,7 @@
}
/// <summary>
- /// Fog's [Color].
+ /// <para>Fog's <see cref="Godot.Color"/>.</para>
/// </summary>
public Color FogColor
{
@@ -350,7 +351,7 @@
}
/// <summary>
- /// Sun [Color].
+ /// <para>Sun <see cref="Godot.Color"/>.</para>
/// </summary>
public Color FogSunColor
{
@@ -365,7 +366,7 @@
}
/// <summary>
- /// Amount of sun that affects the fog rendering.
+ /// <para>Amount of sun that affects the fog rendering.</para>
/// </summary>
public float FogSunAmount
{
@@ -380,7 +381,7 @@
}
/// <summary>
- /// Enables the fog depth.
+ /// <para>Enables the fog depth.</para>
/// </summary>
public bool FogDepthEnabled
{
@@ -395,7 +396,7 @@
}
/// <summary>
- /// Fog's depth starting distance from the camera.
+ /// <para>Fog's depth starting distance from the camera.</para>
/// </summary>
public float FogDepthBegin
{
@@ -425,7 +426,7 @@
}
/// <summary>
- /// Value defining the fog depth intensity.
+ /// <para>Value defining the fog depth intensity.</para>
/// </summary>
public float FogDepthCurve
{
@@ -440,7 +441,7 @@
}
/// <summary>
- /// Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.
+ /// <para>Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.</para>
/// </summary>
public bool FogTransmitEnabled
{
@@ -455,7 +456,7 @@
}
/// <summary>
- /// Amount of light that the fog transmits.
+ /// <para>Amount of light that the fog transmits.</para>
/// </summary>
public float FogTransmitCurve
{
@@ -470,7 +471,7 @@
}
/// <summary>
- /// Enables the fog height.
+ /// <para>Enables the fog height.</para>
/// </summary>
public bool FogHeightEnabled
{
@@ -485,7 +486,7 @@
}
/// <summary>
- /// Minimum height of fog.
+ /// <para>Minimum height of fog.</para>
/// </summary>
public float FogHeightMin
{
@@ -500,7 +501,7 @@
}
/// <summary>
- /// Maximum height of fog.
+ /// <para>Maximum height of fog.</para>
/// </summary>
public float FogHeightMax
{
@@ -515,7 +516,7 @@
}
/// <summary>
- /// Value defining the fog height intensity.
+ /// <para>Value defining the fog height intensity.</para>
/// </summary>
public float FogHeightCurve
{
@@ -530,7 +531,7 @@
}
/// <summary>
- /// Tonemapping mode.
+ /// <para>Tonemapping mode.</para>
/// </summary>
public Environment.ToneMapper TonemapMode
{
@@ -545,7 +546,7 @@
}
/// <summary>
- /// Default exposure for tonemap.
+ /// <para>Default exposure for tonemap.</para>
/// </summary>
public float TonemapExposure
{
@@ -560,7 +561,7 @@
}
/// <summary>
- /// White reference value for tonemap.
+ /// <para>White reference value for tonemap.</para>
/// </summary>
public float TonemapWhite
{
@@ -575,7 +576,7 @@
}
/// <summary>
- /// Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light.
+ /// <para>Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light.</para>
/// </summary>
public bool AutoExposureEnabled
{
@@ -590,7 +591,7 @@
}
/// <summary>
- /// Scale of the auto exposure effect. Affects the intensity of auto exposure.
+ /// <para>Scale of the auto exposure effect. Affects the intensity of auto exposure.</para>
/// </summary>
public float AutoExposureScale
{
@@ -605,7 +606,7 @@
}
/// <summary>
- /// Minimum luminance value for the auto exposure.
+ /// <para>Minimum luminance value for the auto exposure.</para>
/// </summary>
public float AutoExposureMinLuma
{
@@ -620,7 +621,7 @@
}
/// <summary>
- /// Maximum luminance value for the auto exposure.
+ /// <para>Maximum luminance value for the auto exposure.</para>
/// </summary>
public float AutoExposureMaxLuma
{
@@ -635,7 +636,7 @@
}
/// <summary>
- /// Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
+ /// <para>Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.</para>
/// </summary>
public float AutoExposureSpeed
{
@@ -920,7 +921,7 @@
}
/// <summary>
- /// Enables the far blur effect.
+ /// <para>Enables the far blur effect.</para>
/// </summary>
public bool DofBlurFarEnabled
{
@@ -935,7 +936,7 @@
}
/// <summary>
- /// Distance from the camera where the far blur effect affects the rendering.
+ /// <para>Distance from the camera where the far blur effect affects the rendering.</para>
/// </summary>
public float DofBlurFarDistance
{
@@ -950,7 +951,7 @@
}
/// <summary>
- /// Transition between no-blur area and far blur.
+ /// <para>Transition between no-blur area and far blur.</para>
/// </summary>
public float DofBlurFarTransition
{
@@ -965,7 +966,7 @@
}
/// <summary>
- /// Amount of far blur.
+ /// <para>Amount of far blur.</para>
/// </summary>
public float DofBlurFarAmount
{
@@ -980,7 +981,7 @@
}
/// <summary>
- /// Quality of the far blur quality.
+ /// <para>Quality of the far blur quality.</para>
/// </summary>
public Environment.DOFBlurQuality DofBlurFarQuality
{
@@ -995,7 +996,7 @@
}
/// <summary>
- /// Enables the near blur effect.
+ /// <para>Enables the near blur effect.</para>
/// </summary>
public bool DofBlurNearEnabled
{
@@ -1010,7 +1011,7 @@
}
/// <summary>
- /// Distance from the camera where the near blur effect affects the rendering.
+ /// <para>Distance from the camera where the near blur effect affects the rendering.</para>
/// </summary>
public float DofBlurNearDistance
{
@@ -1025,7 +1026,7 @@
}
/// <summary>
- /// Transition between near blur and no-blur area.
+ /// <para>Transition between near blur and no-blur area.</para>
/// </summary>
public float DofBlurNearTransition
{
@@ -1040,7 +1041,7 @@
}
/// <summary>
- /// Amount of near blur.
+ /// <para>Amount of near blur.</para>
/// </summary>
public float DofBlurNearAmount
{
@@ -1055,7 +1056,7 @@
}
/// <summary>
- /// Quality of the near blur quality.
+ /// <para>Quality of the near blur quality.</para>
/// </summary>
public Environment.DOFBlurQuality DofBlurNearQuality
{
@@ -1070,7 +1071,7 @@
}
/// <summary>
- /// Enables glow rendering.
+ /// <para>Enables glow rendering.</para>
/// </summary>
public bool GlowEnabled
{
@@ -1085,7 +1086,7 @@
}
/// <summary>
- /// First level of glow (most local).
+ /// <para>First level of glow (most local).</para>
/// </summary>
public bool GlowLevels__1
{
@@ -1100,7 +1101,7 @@
}
/// <summary>
- /// Second level of glow.
+ /// <para>Second level of glow.</para>
/// </summary>
public bool GlowLevels__2
{
@@ -1115,7 +1116,7 @@
}
/// <summary>
- /// Third level of glow.
+ /// <para>Third level of glow.</para>
/// </summary>
public bool GlowLevels__3
{
@@ -1130,7 +1131,7 @@
}
/// <summary>
- /// Fourth level of glow.
+ /// <para>Fourth level of glow.</para>
/// </summary>
public bool GlowLevels__4
{
@@ -1145,7 +1146,7 @@
}
/// <summary>
- /// Fifth level of glow.
+ /// <para>Fifth level of glow.</para>
/// </summary>
public bool GlowLevels__5
{
@@ -1160,7 +1161,7 @@
}
/// <summary>
- /// Sixth level of glow.
+ /// <para>Sixth level of glow.</para>
/// </summary>
public bool GlowLevels__6
{
@@ -1175,7 +1176,7 @@
}
/// <summary>
- /// Seventh level of glow (most global).
+ /// <para>Seventh level of glow (most global).</para>
/// </summary>
public bool GlowLevels__7
{
@@ -1190,7 +1191,7 @@
}
/// <summary>
- /// Glow intensity.
+ /// <para>Glow intensity.</para>
/// </summary>
public float GlowIntensity
{
@@ -1205,7 +1206,7 @@
}
/// <summary>
- /// Glow strength.
+ /// <para>Glow strength.</para>
/// </summary>
public float GlowStrength
{
@@ -1220,7 +1221,7 @@
}
/// <summary>
- /// Bloom value (global glow).
+ /// <para>Bloom value (global glow).</para>
/// </summary>
public float GlowBloom
{
@@ -1235,7 +1236,7 @@
}
/// <summary>
- /// Glow blending mode.
+ /// <para>Glow blending mode.</para>
/// </summary>
public Environment.GlowBlendModeEnum GlowBlendMode
{
@@ -1250,7 +1251,7 @@
}
/// <summary>
- /// Bleed threshold of the HDR glow.
+ /// <para>Bleed threshold of the HDR glow.</para>
/// </summary>
public float GlowHdrThreshold
{
@@ -1280,7 +1281,7 @@
}
/// <summary>
- /// Bleed scale of the HDR glow.
+ /// <para>Bleed scale of the HDR glow.</para>
/// </summary>
public float GlowHdrScale
{
@@ -1310,7 +1311,7 @@
}
/// <summary>
- /// Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.
+ /// <para>Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.</para>
/// </summary>
public bool AdjustmentEnabled
{
@@ -1325,7 +1326,7 @@
}
/// <summary>
- /// Global brightness value of the rendered scene (default value is 1).
+ /// <para>Global brightness value of the rendered scene (default value is 1).</para>
/// </summary>
public float AdjustmentBrightness
{
@@ -1340,7 +1341,7 @@
}
/// <summary>
- /// Global contrast value of the rendered scene (default value is 1).
+ /// <para>Global contrast value of the rendered scene (default value is 1).</para>
/// </summary>
public float AdjustmentContrast
{
@@ -1355,7 +1356,7 @@
}
/// <summary>
- /// Global color saturation value of the rendered scene (default value is 1).
+ /// <para>Global color saturation value of the rendered scene (default value is 1).</para>
/// </summary>
public float AdjustmentSaturation
{
@@ -1370,7 +1371,7 @@
}
/// <summary>
- /// Applies the provided [Texture] resource to affect the global color aspect of the rendered scene.
+ /// <para>Applies the provided <see cref="Godot.Texture"/> resource to affect the global color aspect of the rendered scene.</para>
/// </summary>
public Texture AdjustmentColorCorrection
{
@@ -2783,3 +2784,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Expression.cs GodotSharp_after/GodotSharp/ObjectType/Expression.cs
--- GodotSharp_before/GodotSharp/ObjectType/Expression.cs 2019-03-20 21:16:55.031094600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Expression.cs 2019-03-23 19:57:08.227970600 +0100
@@ -2,14 +2,15 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// An expression can be made of any arithmetic operation, built-in math function call, method call of a passed instance, or built-in type construction call.
- /// An example expression text using the built-in math functions could be [code]sqrt(pow(3,2) + pow(4,2))[/code].
- /// In the following example we use a [LineEdit] node to write our expression and show the result.
- /// [codeblock]
+ /// <para>An expression can be made of any arithmetic operation, built-in math function call, method call of a passed instance, or built-in type construction call.</para>
+ /// <para>An example expression text using the built-in math functions could be <c>sqrt(pow(3,2) + pow(4,2))</c>.</para>
+ /// <para>In the following example we use a <see cref="Godot.LineEdit"/> node to write our expression and show the result.</para>
+ /// <para><code>
/// onready var expression = Expression.new()
///
/// func _ready():
@@ -23,7 +24,7 @@
/// var result = expression.execute([], null, true)
/// if not expression.has_execute_failed():
/// $LineEdit.text = str(result)
- /// [/codeblock]
+ /// </code></para>
/// </summary>
public partial class Expression : Reference
{
@@ -41,9 +42,9 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "parse");
/// <summary>
- /// Parses the expression and returns a [enum @GlobalScope.Error].
- /// You can optionally specify names of variables that may appear in the expression with [code]input_names[/code], so that you can bind them when it gets executed.
- /// &lt;param name="inputNames"&gt;If the param is null, then the default value is new string[] {}&lt;/param&gt;
+ /// <para>Parses the expression and returns a <see cref="Godot.Error"/>.</para>
+ /// <para>You can optionally specify names of variables that may appear in the expression with <c>input_names</c>, so that you can bind them when it gets executed.</para>
+ /// <param name="inputNames">If the parameter is null, then the default value is new string[] {}</param>
/// </summary>
[GodotMethod("parse")]
public Error Parse(string expression, string[] inputNames = null)
@@ -56,9 +57,9 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "execute");
/// <summary>
- /// Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed].
- /// If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order.
- /// &lt;param name="inputs"&gt;If the param is null, then the default value is new Godot.Collections.Array {}&lt;/param&gt;
+ /// <para>Executes the expression that was previously parsed by <see cref="Godot.Expression.Parse"/> and returns the result. Before you use the returned object, you should check if the method failed by calling <see cref="Godot.Expression.HasExecuteFailed"/>.</para>
+ /// <para>If you defined input variables in <see cref="Godot.Expression.Parse"/>, you can specify their values in the inputs array, in the same order.</para>
+ /// <param name="inputs">If the parameter is null, then the default value is new Godot.Collections.Array {}</param>
/// </summary>
[GodotMethod("execute")]
public object Execute(Godot.Collections.Array inputs = null, Object baseInstance = null, bool showError = true)
@@ -71,7 +72,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "has_execute_failed");
/// <summary>
- /// Returns [code]true[/code] if [method execute] has failed.
+ /// <para>Returns <c>true</c> if <see cref="Godot.Expression.Execute"/> has failed.</para>
/// </summary>
[GodotMethod("has_execute_failed")]
public bool HasExecuteFailed()
@@ -83,7 +84,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_error_text");
/// <summary>
- /// Returns the error text if [method parse] has failed.
+ /// <para>Returns the error text if <see cref="Godot.Expression.Parse"/> has failed.</para>
/// </summary>
[GodotMethod("get_error_text")]
public string GetErrorText()
@@ -94,3 +95,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/File.cs GodotSharp_after/GodotSharp/ObjectType/File.cs
--- GodotSharp_before/GodotSharp/ObjectType/File.cs 2019-03-20 21:16:57.393827600 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/File.cs 2019-03-23 19:57:09.916540500 +0100
@@ -2,13 +2,14 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example.
- /// Here's a sample on how to write and read from a file:
- /// [codeblock]
+ /// <para>File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example.</para>
+ /// <para>Here's a sample on how to write and read from a file:</para>
+ /// <para><code>
/// func save(content):
/// var file = File.new()
/// file.open("user://save_game.dat", File.WRITE)
@@ -21,26 +22,26 @@
/// var content = file.get_as_text()
/// file.close()
/// return content
- /// [/codeblock]
+ /// </code></para>
/// </summary>
public partial class File : Reference
{
public enum CompressionMode
{
/// <summary>
- /// Uses the FastLZ compression method.
+ /// <para>Uses the FastLZ compression method.</para>
/// </summary>
Fastlz = 0,
/// <summary>
- /// Uses the Deflate compression method.
+ /// <para>Uses the Deflate compression method.</para>
/// </summary>
Deflate = 1,
/// <summary>
- /// Uses the Zstd compression method.
+ /// <para>Uses the Zstd compression method.</para>
/// </summary>
Zstd = 2,
/// <summary>
- /// Uses the gzip compression method.
+ /// <para>Uses the gzip compression method.</para>
/// </summary>
Gzip = 3
}
@@ -48,26 +49,26 @@
public enum ModeFlags
{
/// <summary>
- /// Opens the file for read operations.
+ /// <para>Opens the file for read operations.</para>
/// </summary>
Read = 1,
/// <summary>
- /// Opens the file for write operations. Create it if the file does not exist and truncate if it exists.
+ /// <para>Opens the file for write operations. Create it if the file does not exist and truncate if it exists.</para>
/// </summary>
Write = 2,
/// <summary>
- /// Opens the file for read and write operations. Does not truncate the file.
+ /// <para>Opens the file for read and write operations. Does not truncate the file.</para>
/// </summary>
ReadWrite = 3,
/// <summary>
- /// Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.
+ /// <para>Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.</para>
/// </summary>
WriteRead = 7
}
/// <summary>
- /// If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written in big endian machines.
- /// Note that this is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file.
+ /// <para>If <c>true</c>, the file's endianness is swapped. Use this if you're dealing with files written in big endian machines.</para>
+ /// <para>Note that this is about the file format, not CPU type. This is always reset to <c>false</c> whenever you open the file.</para>
/// </summary>
public bool EndianSwap
{
@@ -95,7 +96,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "open_encrypted");
/// <summary>
- /// Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
+ /// <para>Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.</para>
/// </summary>
[GodotMethod("open_encrypted")]
public Error OpenEncrypted(string path, int modeFlags, byte[] key)
@@ -107,7 +108,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "open_encrypted_with_pass");
/// <summary>
- /// Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
+ /// <para>Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.</para>
/// </summary>
[GodotMethod("open_encrypted_with_pass")]
public Error OpenEncryptedWithPass(string path, int modeFlags, string pass)
@@ -119,7 +120,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "open_compressed");
/// <summary>
- /// Opens a compressed file for reading or writing. Use COMPRESSION_* constants to set [code]compression_mode[/code].
+ /// <para>Opens a compressed file for reading or writing. Use COMPRESSION_* constants to set <c>compression_mode</c>.</para>
/// </summary>
[GodotMethod("open_compressed")]
public Error OpenCompressed(string path, int modeFlags, int compressionMode = 0)
@@ -131,7 +132,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "open");
/// <summary>
- /// Opens the file for writing or reading, depending on the flags.
+ /// <para>Opens the file for writing or reading, depending on the flags.</para>
/// </summary>
[GodotMethod("open")]
public Error Open(string path, int flags)
@@ -143,7 +144,7 @@
private static IntPtr method_bind_4 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "close");
/// <summary>
- /// Closes the currently opened file.
+ /// <para>Closes the currently opened file.</para>
/// </summary>
[GodotMethod("close")]
public void Close()
@@ -155,7 +156,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_path");
/// <summary>
- /// Returns the path as a [String] for the current open file.
+ /// <para>Returns the path as a <see cref="string"/> for the current open file.</para>
/// </summary>
[GodotMethod("get_path")]
public string GetPath()
@@ -167,7 +168,7 @@
private static IntPtr method_bind_6 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_path_absolute");
/// <summary>
- /// Returns the absolute path as a [String] for the current open file.
+ /// <para>Returns the absolute path as a <see cref="string"/> for the current open file.</para>
/// </summary>
[GodotMethod("get_path_absolute")]
public string GetPathAbsolute()
@@ -179,7 +180,7 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "is_open");
/// <summary>
- /// Returns [code]true[/code] if the file is currently opened.
+ /// <para>Returns <c>true</c> if the file is currently opened.</para>
/// </summary>
[GodotMethod("is_open")]
public bool IsOpen()
@@ -191,7 +192,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "seek");
/// <summary>
- /// Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
+ /// <para>Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file).</para>
/// </summary>
[GodotMethod("seek")]
public void Seek(int position)
@@ -203,7 +204,7 @@
private static IntPtr method_bind_9 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "seek_end");
/// <summary>
- /// Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
+ /// <para>Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.</para>
/// </summary>
[GodotMethod("seek_end")]
public void SeekEnd(int position = 0)
@@ -215,7 +216,7 @@
private static IntPtr method_bind_10 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_position");
/// <summary>
- /// Returns the file cursor's position.
+ /// <para>Returns the file cursor's position.</para>
/// </summary>
[GodotMethod("get_position")]
public int GetPosition()
@@ -227,7 +228,7 @@
private static IntPtr method_bind_11 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_len");
/// <summary>
- /// Returns the size of the file in bytes.
+ /// <para>Returns the size of the file in bytes.</para>
/// </summary>
[GodotMethod("get_len")]
public int GetLen()
@@ -239,7 +240,7 @@
private static IntPtr method_bind_12 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "eof_reached");
/// <summary>
- /// Returns [code]true[/code] if the file cursor has read past the end of the file. Note that this function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic.
+ /// <para>Returns <c>true</c> if the file cursor has read past the end of the file. Note that this function will still return <c>false</c> while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low level file access works in all operating systems. There is always <see cref="Godot.File.GetLen"/> and <see cref="Godot.File.GetPosition"/> to implement a custom logic.</para>
/// </summary>
[GodotMethod("eof_reached")]
public bool EofReached()
@@ -251,7 +252,7 @@
private static IntPtr method_bind_13 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_8");
/// <summary>
- /// Returns the next 8 bits from the file as an integer.
+ /// <para>Returns the next 8 bits from the file as an integer.</para>
/// </summary>
[GodotMethod("get_8")]
public int Get8()
@@ -263,7 +264,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_16");
/// <summary>
- /// Returns the next 16 bits from the file as an integer.
+ /// <para>Returns the next 16 bits from the file as an integer.</para>
/// </summary>
[GodotMethod("get_16")]
public int Get16()
@@ -275,7 +276,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_32");
/// <summary>
- /// Returns the next 32 bits from the file as an integer.
+ /// <para>Returns the next 32 bits from the file as an integer.</para>
/// </summary>
[GodotMethod("get_32")]
public int Get32()
@@ -287,7 +288,7 @@
private static IntPtr method_bind_16 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_64");
/// <summary>
- /// Returns the next 64 bits from the file as an integer.
+ /// <para>Returns the next 64 bits from the file as an integer.</para>
/// </summary>
[GodotMethod("get_64")]
public int Get64()
@@ -299,7 +300,7 @@
private static IntPtr method_bind_17 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_float");
/// <summary>
- /// Returns the next 32 bits from the file as a floating point number.
+ /// <para>Returns the next 32 bits from the file as a floating point number.</para>
/// </summary>
[GodotMethod("get_float")]
public float GetFloat()
@@ -311,7 +312,7 @@
private static IntPtr method_bind_18 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_double");
/// <summary>
- /// Returns the next 64 bits from the file as a floating point number.
+ /// <para>Returns the next 64 bits from the file as a floating point number.</para>
/// </summary>
[GodotMethod("get_double")]
public float GetDouble()
@@ -323,7 +324,7 @@
private static IntPtr method_bind_19 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_real");
/// <summary>
- /// Returns the next bits from the file as a floating point number.
+ /// <para>Returns the next bits from the file as a floating point number.</para>
/// </summary>
[GodotMethod("get_real")]
public float GetReal()
@@ -335,7 +336,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_buffer");
/// <summary>
- /// Returns next [code]len[/code] bytes of the file as a [PoolByteArray].
+ /// <para>Returns next <c>len</c> bytes of the file as a <see cref="byte"/>.</para>
/// </summary>
[GodotMethod("get_buffer")]
public byte[] GetBuffer(int len)
@@ -347,7 +348,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_line");
/// <summary>
- /// Returns the next line of the file as a [String].
+ /// <para>Returns the next line of the file as a <see cref="string"/>.</para>
/// </summary>
[GodotMethod("get_line")]
public string GetLine()
@@ -359,7 +360,7 @@
private static IntPtr method_bind_22 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_csv_line");
/// <summary>
- /// Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
+ /// <para>Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.</para>
/// </summary>
[GodotMethod("get_csv_line")]
public string[] GetCsvLine(string delim = ",")
@@ -371,7 +372,7 @@
private static IntPtr method_bind_23 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_as_text");
/// <summary>
- /// Returns the whole file as a [String].
+ /// <para>Returns the whole file as a <see cref="string"/>.</para>
/// </summary>
[GodotMethod("get_as_text")]
public string GetAsText()
@@ -383,7 +384,7 @@
private static IntPtr method_bind_24 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_md5");
/// <summary>
- /// Returns an MD5 String representing the file at the given path or an empty [String] on failure.
+ /// <para>Returns an MD5 String representing the file at the given path or an empty <see cref="string"/> on failure.</para>
/// </summary>
[GodotMethod("get_md5")]
public string GetMd5(string path)
@@ -395,7 +396,7 @@
private static IntPtr method_bind_25 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_sha256");
/// <summary>
- /// Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure.
+ /// <para>Returns a SHA-256 <see cref="string"/> representing the file at the given path or an empty <see cref="string"/> on failure.</para>
/// </summary>
[GodotMethod("get_sha256")]
public string GetSha256(string path)
@@ -425,7 +426,7 @@
private static IntPtr method_bind_28 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_error");
/// <summary>
- /// Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@GlobalScope].
+ /// <para>Returns the last error that happened when trying to perform operations. Compare with the <c>ERR_FILE_*</c> constants from <c>@GlobalScope</c>.</para>
/// </summary>
[GodotMethod("get_error")]
public Error GetError()
@@ -437,7 +438,7 @@
private static IntPtr method_bind_29 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_var");
/// <summary>
- /// Returns the next [Variant] value from the file.
+ /// <para>Returns the next <c>Variant</c> value from the file.</para>
/// </summary>
[GodotMethod("get_var")]
public object GetVar()
@@ -449,7 +450,7 @@
private static IntPtr method_bind_30 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_8");
/// <summary>
- /// Stores an integer as 8 bits in the file.
+ /// <para>Stores an integer as 8 bits in the file.</para>
/// </summary>
[GodotMethod("store_8")]
public void Store8(int value)
@@ -461,7 +462,7 @@
private static IntPtr method_bind_31 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_16");
/// <summary>
- /// Stores an integer as 16 bits in the file.
+ /// <para>Stores an integer as 16 bits in the file.</para>
/// </summary>
[GodotMethod("store_16")]
public void Store16(int value)
@@ -473,7 +474,7 @@
private static IntPtr method_bind_32 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_32");
/// <summary>
- /// Stores an integer as 32 bits in the file.
+ /// <para>Stores an integer as 32 bits in the file.</para>
/// </summary>
[GodotMethod("store_32")]
public void Store32(int value)
@@ -485,7 +486,7 @@
private static IntPtr method_bind_33 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_64");
/// <summary>
- /// Stores an integer as 64 bits in the file.
+ /// <para>Stores an integer as 64 bits in the file.</para>
/// </summary>
[GodotMethod("store_64")]
public void Store64(int value)
@@ -497,7 +498,7 @@
private static IntPtr method_bind_34 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_float");
/// <summary>
- /// Stores a floating point number as 32 bits in the file.
+ /// <para>Stores a floating point number as 32 bits in the file.</para>
/// </summary>
[GodotMethod("store_float")]
public void StoreFloat(float value)
@@ -509,7 +510,7 @@
private static IntPtr method_bind_35 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_double");
/// <summary>
- /// Stores a floating point number as 64 bits in the file.
+ /// <para>Stores a floating point number as 64 bits in the file.</para>
/// </summary>
[GodotMethod("store_double")]
public void StoreDouble(float value)
@@ -521,7 +522,7 @@
private static IntPtr method_bind_36 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_real");
/// <summary>
- /// Stores a floating point number in the file.
+ /// <para>Stores a floating point number in the file.</para>
/// </summary>
[GodotMethod("store_real")]
public void StoreReal(float value)
@@ -533,7 +534,7 @@
private static IntPtr method_bind_37 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_buffer");
/// <summary>
- /// Stores the given array of bytes in the file.
+ /// <para>Stores the given array of bytes in the file.</para>
/// </summary>
[GodotMethod("store_buffer")]
public void StoreBuffer(byte[] buffer)
@@ -545,7 +546,7 @@
private static IntPtr method_bind_38 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_line");
/// <summary>
- /// Stores the given [String] as a line in the file.
+ /// <para>Stores the given <see cref="string"/> as a line in the file.</para>
/// </summary>
[GodotMethod("store_line")]
public void StoreLine(string line)
@@ -557,7 +558,7 @@
private static IntPtr method_bind_39 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_csv_line");
/// <summary>
- /// Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
+ /// <para>Store the given <see cref="string"/> in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.</para>
/// </summary>
[GodotMethod("store_csv_line")]
public void StoreCsvLine(string[] values, string delim = ",")
@@ -569,7 +570,7 @@
private static IntPtr method_bind_40 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_string");
/// <summary>
- /// Stores the given [String] in the file.
+ /// <para>Stores the given <see cref="string"/> in the file.</para>
/// </summary>
[GodotMethod("store_string")]
public void StoreString(string @string)
@@ -581,7 +582,7 @@
private static IntPtr method_bind_41 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_var");
/// <summary>
- /// Stores any Variant value in the file.
+ /// <para>Stores any Variant value in the file.</para>
/// </summary>
[GodotMethod("store_var")]
public void StoreVar(object value)
@@ -593,7 +594,7 @@
private static IntPtr method_bind_42 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "store_pascal_string");
/// <summary>
- /// Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
+ /// <para>Stores the given <see cref="string"/> as a line in the file in Pascal format (i.e. also store the length of the string).</para>
/// </summary>
[GodotMethod("store_pascal_string")]
public void StorePascalString(string @string)
@@ -605,7 +606,7 @@
private static IntPtr method_bind_43 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_pascal_string");
/// <summary>
- /// Returns a [String] saved in Pascal format from the file.
+ /// <para>Returns a <see cref="string"/> saved in Pascal format from the file.</para>
/// </summary>
[GodotMethod("get_pascal_string")]
public string GetPascalString()
@@ -617,8 +618,8 @@
private static IntPtr method_bind_44 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "file_exists");
/// <summary>
- /// Returns [code]true[/code] if the file exists in the given path.
- /// Note that many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the [code]res://.import[/code] folder). To check for the existence of such resources while taking into account the remapping to their imported location, use [method ResourceLoader.exists]. Typically, using [code]File.file_exists[/code] on an imported resource would work while you are developing in the editor (the source asset is present in [code]res://[/code], but fail when exported).
+ /// <para>Returns <c>true</c> if the file exists in the given path.</para>
+ /// <para>Note that many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the <c>res://.import</c> folder). To check for the existence of such resources while taking into account the remapping to their imported location, use <see cref="Godot.ResourceLoader.Exists"/>. Typically, using <c>File.file_exists</c> on an imported resource would work while you are developing in the editor (the source asset is present in <c>res://</c>, but fail when exported).</para>
/// </summary>
[GodotMethod("file_exists")]
public bool FileExists(string path)
@@ -630,7 +631,7 @@
private static IntPtr method_bind_45 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_modified_time");
/// <summary>
- /// Returns the last time the [code]file[/code] was modified in unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time].
+ /// <para>Returns the last time the <c>file</c> was modified in unix timestamp format or returns a <see cref="string"/> "ERROR IN <c>file</c>". This unix timestamp can be converted to datetime by using <see cref="Godot.OS.GetDatetimeFromUnixTime"/>.</para>
/// </summary>
[GodotMethod("get_modified_time")]
public int GetModifiedTime(string file)
@@ -641,3 +642,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/FileDialog.cs GodotSharp_after/GodotSharp/ObjectType/FileDialog.cs
--- GodotSharp_before/GodotSharp/ObjectType/FileDialog.cs 2019-03-20 21:16:55.036091300 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/FileDialog.cs 2019-03-23 19:57:08.232978100 +0100
@@ -2,34 +2,35 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.
+ /// <para>FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks.</para>
/// </summary>
public partial class FileDialog : ConfirmationDialog
{
public enum ModeEnum
{
/// <summary>
- /// The dialog allows the selection of one, and only one file.
+ /// <para>The dialog allows the selection of one, and only one file.</para>
/// </summary>
OpenFile = 0,
/// <summary>
- /// The dialog allows the selection of multiple files.
+ /// <para>The dialog allows the selection of multiple files.</para>
/// </summary>
OpenFiles = 1,
/// <summary>
- /// The dialog functions as a folder selector, disallowing the selection of any file.
+ /// <para>The dialog functions as a folder selector, disallowing the selection of any file.</para>
/// </summary>
OpenDir = 2,
/// <summary>
- /// The dialog allows the selection of a file or a directory.
+ /// <para>The dialog allows the selection of a file or a directory.</para>
/// </summary>
OpenAny = 3,
/// <summary>
- /// The dialog will warn when a file exists.
+ /// <para>The dialog will warn when a file exists.</para>
/// </summary>
SaveFile = 4
}
@@ -37,21 +38,21 @@
public enum AccessEnum
{
/// <summary>
- /// The dialog allows the selection of file and directory.
+ /// <para>The dialog allows the selection of file and directory.</para>
/// </summary>
Resources = 0,
/// <summary>
- /// The dialog allows access files under [Resource] path(res://) .
+ /// <para>The dialog allows access files under <see cref="Godot.Resource"/> path(res://) .</para>
/// </summary>
Userdata = 1,
/// <summary>
- /// The dialog allows access files in whole file system.
+ /// <para>The dialog allows access files in whole file system.</para>
/// </summary>
Filesystem = 2
}
/// <summary>
- /// If [code]true[/code], changing the [code]Mode[/code] property will set the window title accordingly (e.g. setting mode to [code]MODE_OPEN_FILE[/code] will change the window title to "Open a File").
+ /// <para>If <c>true</c>, changing the <c>Mode</c> property will set the window title accordingly (e.g. setting mode to <c>MODE_OPEN_FILE</c> will change the window title to "Open a File").</para>
/// </summary>
public bool ModeOverridesTitle
{
@@ -66,7 +67,7 @@
}
/// <summary>
- /// Set dialog to open or save mode, changes selection behavior. See enum [code]Mode[/code] constants.
+ /// <para>Set dialog to open or save mode, changes selection behavior. See enum <c>Mode</c> constants.</para>
/// </summary>
public FileDialog.ModeEnum Mode
{
@@ -81,7 +82,7 @@
}
/// <summary>
- /// The file system access scope. See enum [code]Access[/code] constants.
+ /// <para>The file system access scope. See enum <c>Access</c> constants.</para>
/// </summary>
public FileDialog.AccessEnum Access
{
@@ -96,7 +97,7 @@
}
/// <summary>
- /// Set file type filters. This example shows only .png and .gd files [code]set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))[/code].
+ /// <para>Set file type filters. This example shows only .png and .gd files <c>set_filters(PoolStringArray(["*.png ; PNG Images","*.gd ; GD Script"]))</c>.</para>
/// </summary>
public string[] Filters
{
@@ -111,7 +112,7 @@
}
/// <summary>
- /// If [code]true[/code], the dialog will show hidden files.
+ /// <para>If <c>true</c>, the dialog will show hidden files.</para>
/// </summary>
public bool ShowHiddenFiles
{
@@ -126,7 +127,7 @@
}
/// <summary>
- /// The current working directory of the file dialog.
+ /// <para>The current working directory of the file dialog.</para>
/// </summary>
public string CurrentDir
{
@@ -141,7 +142,7 @@
}
/// <summary>
- /// The currently selected file of the file dialog.
+ /// <para>The currently selected file of the file dialog.</para>
/// </summary>
public string CurrentFile
{
@@ -156,7 +157,7 @@
}
/// <summary>
- /// The currently selected file path of the file dialog.
+ /// <para>The currently selected file path of the file dialog.</para>
/// </summary>
public string CurrentPath
{
@@ -184,7 +185,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "clear_filters");
/// <summary>
- /// Clear all the added filters in the dialog.
+ /// <para>Clear all the added filters in the dialog.</para>
/// </summary>
[GodotMethod("clear_filters")]
public void ClearFilters()
@@ -196,7 +197,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "add_filter");
/// <summary>
- /// Add a custom filter. Example: [code]add_filter("*.png ; PNG Images")[/code]
+ /// <para>Add a custom filter. Example: <c>add_filter("*.png ; PNG Images")</c></para>
/// </summary>
[GodotMethod("add_filter")]
public void AddFilter(string filter)
@@ -316,7 +317,7 @@
private static IntPtr method_bind_14 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_vbox");
/// <summary>
- /// Return the vertical box container of the dialog, custom controls can be added to it.
+ /// <para>Return the vertical box container of the dialog, custom controls can be added to it.</para>
/// </summary>
[GodotMethod("get_vbox")]
public VBoxContainer GetVbox()
@@ -328,7 +329,7 @@
private static IntPtr method_bind_15 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_line_edit");
/// <summary>
- /// Returns the LineEdit for the selected file.
+ /// <para>Returns the LineEdit for the selected file.</para>
/// </summary>
[GodotMethod("get_line_edit")]
public LineEdit GetLineEdit()
@@ -376,7 +377,7 @@
private static IntPtr method_bind_20 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "deselect_items");
/// <summary>
- /// Clear currently selected items in the dialog.
+ /// <para>Clear currently selected items in the dialog.</para>
/// </summary>
[GodotMethod("deselect_items")]
public void DeselectItems()
@@ -388,7 +389,7 @@
private static IntPtr method_bind_21 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "invalidate");
/// <summary>
- /// Invalidate and update the current dialog content list.
+ /// <para>Invalidate and update the current dialog content list.</para>
/// </summary>
[GodotMethod("invalidate")]
public void Invalidate()
@@ -399,3 +400,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/Font.cs GodotSharp_after/GodotSharp/ObjectType/Font.cs
--- GodotSharp_before/GodotSharp/ObjectType/Font.cs 2019-03-20 21:16:55.042088800 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/Font.cs 2019-03-23 19:57:08.235975100 +0100
@@ -2,11 +2,12 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts.
+ /// <para>Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts.</para>
/// </summary>
public abstract partial class Font : Resource
{
@@ -20,9 +21,9 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw");
/// <summary>
- /// Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
- /// &lt;param name="outlineModulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draw "string" into a canvas item using the font at a given position, with "modulate" color, and optionally clipping the width. "position" specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
+ /// <param name="outlineModulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw")]
public void Draw(RID canvasItem, Vector2 position, string @string, Nullable<Color> modulate = null, int clipW = -1, Nullable<Color> outlineModulate = null)
@@ -36,7 +37,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_ascent");
/// <summary>
- /// Return the font ascent (number of pixels above the baseline).
+ /// <para>Return the font ascent (number of pixels above the baseline).</para>
/// </summary>
[GodotMethod("get_ascent")]
public float GetAscent()
@@ -48,7 +49,7 @@
private static IntPtr method_bind_2 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_descent");
/// <summary>
- /// Return the font descent (number of pixels below the baseline).
+ /// <para>Return the font descent (number of pixels below the baseline).</para>
/// </summary>
[GodotMethod("get_descent")]
public float GetDescent()
@@ -60,7 +61,7 @@
private static IntPtr method_bind_3 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_height");
/// <summary>
- /// Return the total font height (ascent plus descent) in pixels.
+ /// <para>Return the total font height (ascent plus descent) in pixels.</para>
/// </summary>
[GodotMethod("get_height")]
public float GetHeight()
@@ -84,7 +85,7 @@
private static IntPtr method_bind_5 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "get_string_size");
/// <summary>
- /// Return the size of a string, taking kerning and advance into account.
+ /// <para>Return the size of a string, taking kerning and advance into account.</para>
/// </summary>
[GodotMethod("get_string_size")]
public Vector2 GetStringSize(string @string)
@@ -108,8 +109,8 @@
private static IntPtr method_bind_7 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "draw_char");
/// <summary>
- /// Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
- /// &lt;param name="modulate"&gt;If the param is null, then the default value is new Color(1, 1, 1, 1)&lt;/param&gt;
+ /// <para>Draw character "char" into a canvas item using the font at a given position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "position" specifies the baseline, not the top. To draw from the top, ascent must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.</para>
+ /// <param name="modulate">If the parameter is null, then the default value is new Color(1, 1, 1, 1)</param>
/// </summary>
[GodotMethod("draw_char")]
public float DrawChar(RID canvasItem, Vector2 position, int @char, int next = -1, Nullable<Color> modulate = null, bool outline = false)
@@ -122,7 +123,7 @@
private static IntPtr method_bind_8 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "update_changes");
/// <summary>
- /// After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.
+ /// <para>After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.</para>
/// </summary>
[GodotMethod("update_changes")]
public void UpdateChanges()
@@ -133,3 +134,4 @@
}
#pragma warning restore CS1591
+#pragma warning restore CS1573
diff -ur GodotSharp_before/GodotSharp/ObjectType/FuncRef.cs GodotSharp_after/GodotSharp/ObjectType/FuncRef.cs
--- GodotSharp_before/GodotSharp/ObjectType/FuncRef.cs 2019-03-20 21:16:55.045088700 +0100
+++ GodotSharp_after/GodotSharp/ObjectType/FuncRef.cs 2019-03-23 19:57:08.244970900 +0100
@@ -2,12 +2,13 @@
using System.Diagnostics;
#pragma warning disable CS1591 // Disable warning: 'Missing XML comment for publicly visible type or member'
+#pragma warning disable CS1573 // Disable warning: 'Parameter has no matching param tag in the XML comment'
namespace Godot
{
/// <summary>
- /// In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments.
- /// However, by creating a [code]FuncRef[/code] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called.
+ /// <para>In GDScript, functions are not first-class objects. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments.</para>
+ /// <para>However, by creating a <c>FuncRef</c> using the <c>@GDScript.funcref</c> function, a reference to a function in a given object can be created, passed around and called.</para>
/// </summary>
public partial class FuncRef : Reference
{
@@ -25,7 +26,7 @@
private static IntPtr method_bind_0 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "call_func");
/// <summary>
- /// Calls the referenced function previously set by [method set_function] or [method @GDScript.funcref].
+ /// <para>Calls the referenced function previously set by <see cref="Godot.FuncRef.SetFunction"/> or <c>@GDScript.funcref</c>.</para>
/// </summary>
[GodotMethod("call_func")]
public object CallFunc(params object[] @args)
@@ -37,7 +38,7 @@
private static IntPtr method_bind_1 = Object.godot_icall_Object_ClassDB_get_method(nativeName, "set_instance");
/// <summary>
- /// The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment