Browse Source

Improved reference doc export

Tweaks to make exported reference files work nicely on Github wiki
master
chrisgregan 10 years ago
parent
commit
350935812d
  1. 4
      Assets/Fungus/Flowchart/Editor/BlockEditor.cs
  2. 2
      Assets/Fungus/Flowchart/Scripts/Commands/DeleteSaveKey.cs
  3. 2
      Assets/Fungus/Flowchart/Scripts/Commands/LoadVariable.cs
  4. 2
      Assets/Fungus/Flowchart/Scripts/Commands/RandomFloat.cs
  5. 2
      Assets/Fungus/Flowchart/Scripts/Commands/RandomInteger.cs
  6. 2
      Assets/Fungus/Flowchart/Scripts/Commands/Reset.cs
  7. 2
      Assets/Fungus/Flowchart/Scripts/Commands/SaveVariable.cs
  8. 2
      Assets/Fungus/Flowchart/Scripts/Commands/SetSaveProfile.cs
  9. 2
      Assets/Fungus/Flowchart/Scripts/Commands/SetVariable.cs
  10. 2
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs
  11. 2
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs
  12. 2
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs
  13. 2
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs
  14. 2
      Assets/Fungus/Sprite/Scripts/EventHandlers/DragStarted.cs
  15. 2
      Assets/Fungus/Sprite/Scripts/EventHandlers/ObjectClicked.cs

4
Assets/Fungus/Flowchart/Editor/BlockEditor.cs

@ -553,7 +553,7 @@ namespace Fungus
} }
} }
string filePath = path + "/commands/" + category + ".md"; string filePath = path + "/commands/" + category.ToLower() + "_commands.md";
Directory.CreateDirectory(Path.GetDirectoryName(filePath)); Directory.CreateDirectory(Path.GetDirectoryName(filePath));
File.WriteAllText(filePath, markdown); File.WriteAllText(filePath, markdown);
@ -594,7 +594,7 @@ namespace Fungus
} }
} }
string filePath = path + "/event_handlers/" + category + ".md"; string filePath = path + "/event_handlers/" + category.ToLower() + "_events.md";
Directory.CreateDirectory(Path.GetDirectoryName(filePath)); Directory.CreateDirectory(Path.GetDirectoryName(filePath));
File.WriteAllText(filePath, markdown); File.WriteAllText(filePath, markdown);

2
Assets/Fungus/Flowchart/Scripts/Commands/DeleteSaveKey.cs

@ -4,7 +4,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Delete Save Key", "Delete Save Key",
"Deletes a saved value from permanent storage.")] "Deletes a saved value from permanent storage.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Flowchart/Scripts/Commands/LoadVariable.cs

@ -4,7 +4,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Load Variable", "Load Variable",
"Loads a saved value and stores it in a Boolean, Integer, Float or String variable. If the key is not found then the variable is not modified.")] "Loads a saved value and stores it in a Boolean, Integer, Float or String variable. If the key is not found then the variable is not modified.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Flowchart/Scripts/Commands/RandomFloat.cs

@ -3,7 +3,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Random Float", "Random Float",
"Sets an float variable to a random value in the defined range.")] "Sets an float variable to a random value in the defined range.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Flowchart/Scripts/Commands/RandomInteger.cs

@ -3,7 +3,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Random Integer", "Random Integer",
"Sets an integer variable to a random value in the defined range.")] "Sets an integer variable to a random value in the defined range.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Flowchart/Scripts/Commands/Reset.cs

@ -4,7 +4,7 @@ using System.Collections.Generic;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Reset", "Reset",
"Resets the state of all commands and variables in the Flowchart.")] "Resets the state of all commands and variables in the Flowchart.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Flowchart/Scripts/Commands/SaveVariable.cs

@ -4,7 +4,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Save Variable", "Save Variable",
"Save an Boolean, Integer, Float or String variable to persistent storage using a string key. " + "Save an Boolean, Integer, Float or String variable to persistent storage using a string key. " +
"The value can be loaded again later using the Load Variable command. You can also " + "The value can be loaded again later using the Load Variable command. You can also " +

2
Assets/Fungus/Flowchart/Scripts/Commands/SetSaveProfile.cs

@ -4,7 +4,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Set Save Profile", "Set Save Profile",
"Sets the active profile that the Save Variable and Load Variable commands will use. This is useful to crete multiple player save games. Once set, the profile applies across all Flowcharts and will also persist across scene loads.")] "Sets the active profile that the Save Variable and Load Variable commands will use. This is useful to crete multiple player save games. Once set, the profile applies across all Flowcharts and will also persist across scene loads.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Flowchart/Scripts/Commands/SetVariable.cs

@ -3,7 +3,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[CommandInfo("Variables", [CommandInfo("Variable",
"Set Variable", "Set Variable",
"Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation. The value can be a constant or reference another variable of the same type.")] "Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation. The value can be a constant or reference another variable of the same type.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Sprite/Scripts/EventHandlers/DragCancelled.cs

@ -5,7 +5,7 @@ using System.Collections.Generic;
namespace Fungus namespace Fungus
{ {
[EventHandlerInfo("Sprites", [EventHandlerInfo("Sprite",
"Drag Cancelled", "Drag Cancelled",
"The block will execute when the player drags an object and releases it without dropping it on a target object.")] "The block will execute when the player drags an object and releases it without dropping it on a target object.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Sprite/Scripts/EventHandlers/DragCompleted.cs

@ -5,7 +5,7 @@ using System.Collections.Generic;
namespace Fungus namespace Fungus
{ {
[EventHandlerInfo("Sprites", [EventHandlerInfo("Sprite",
"Drag Completed", "Drag Completed",
"The block will execute when the player drags an object and successfully drops it on a target object.")] "The block will execute when the player drags an object and successfully drops it on a target object.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Sprite/Scripts/EventHandlers/DragEntered.cs

@ -6,7 +6,7 @@ using System.Collections.Generic;
namespace Fungus namespace Fungus
{ {
[EventHandlerInfo("Sprites", [EventHandlerInfo("Sprite",
"Drag Entered", "Drag Entered",
"The block will execute when the player is dragging an object which starts touching the target object.")] "The block will execute when the player is dragging an object which starts touching the target object.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Sprite/Scripts/EventHandlers/DragExited.cs

@ -6,7 +6,7 @@ using System.Collections.Generic;
namespace Fungus namespace Fungus
{ {
[EventHandlerInfo("Sprites", [EventHandlerInfo("Sprite",
"Drag Exited", "Drag Exited",
"The block will execute when the player is dragging an object which stops touching the target object.")] "The block will execute when the player is dragging an object which stops touching the target object.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Sprite/Scripts/EventHandlers/DragStarted.cs

@ -5,7 +5,7 @@ using System.Collections.Generic;
namespace Fungus namespace Fungus
{ {
[EventHandlerInfo("Sprites", [EventHandlerInfo("Sprite",
"Drag Started", "Drag Started",
"The block will execute when the player starts dragging an object.")] "The block will execute when the player starts dragging an object.")]
[AddComponentMenu("")] [AddComponentMenu("")]

2
Assets/Fungus/Sprite/Scripts/EventHandlers/ObjectClicked.cs

@ -3,7 +3,7 @@ using System.Collections;
namespace Fungus namespace Fungus
{ {
[EventHandlerInfo("Sprites", [EventHandlerInfo("Sprite",
"Object Clicked", "Object Clicked",
"The block will execute when the user clicks or taps on the clickable object.")] "The block will execute when the user clicks or taps on the clickable object.")]
[AddComponentMenu("")] [AddComponentMenu("")]

Loading…
Cancel
Save