Convert hidden [Desc] to a <summary>.

This commit is contained in:
Paul Chote
2015-04-22 19:48:39 +12:00
parent 44f2dd5a3d
commit 8a1f9261c3

View File

@@ -16,15 +16,18 @@ using OpenRA.Traits;
namespace OpenRA namespace OpenRA
{ {
// TODO: This is not exported into the documentation yet. /// <summary>
[Desc("A unit/building inside the game. Every rules starts with one and adds trait to it.", /// A unit/building inside the game. Every rules starts with one and adds trait to it.
"Special actors like world or player are usually defined in system.yaml and affect everything.")] /// Special actors like world or player are usually defined in system.yaml and affect everything.
/// </summary>
public class ActorInfo public class ActorInfo
{ {
[Desc("The actor name can be anything, but the sprites used in the Render*: traits default to this one.", /// <summary>
"If you add an ^ in front of the name, the engine will recognize this as a collection of traits", /// The actor name can be anything, but the sprites used in the Render*: traits default to this one.
"that can be inherited by others (using Inherits:) and not a real unit.", /// If you add an ^ in front of the name, the engine will recognize this as a collection of traits
"You can remove inherited traits by adding a - infront of them as in -TraitName: to inherit everything, but this trait.")] /// that can be inherited by others (using Inherits:) and not a real unit.
/// You can remove inherited traits by adding a - infront of them as in -TraitName: to inherit everything, but this trait.
/// </summary>
public readonly string Name; public readonly string Name;
public readonly TypeDictionary Traits = new TypeDictionary(); public readonly TypeDictionary Traits = new TypeDictionary();
List<ITraitInfo> constructOrderCache = null; List<ITraitInfo> constructOrderCache = null;