1.1 release; update and improve documentation

Source/VisualU/Public/BackgroundVisualImage.h

@@ -57,8 +57,10 @@ class UBackgroundVisualImage final : public UVisualImage
 	/**
 	* Version for non-animated flipbooks.
 	* 
-	* @see PlayTransition()
+	* @see UBackgroundVisualImage::PlayTransition(UPaperFlipbook*, UMaterialInstanceDynamic*, bool)
 	* 
+	* @param Target New flipbook that would be displayed by this image after transition ends
+	* @param Transition Material that serves as transition effect
 	* @param FrameIndex which frame to show after transition ends.
 	*/
 	void PlayTransition(UPaperFlipbook* Target, UMaterialInstanceDynamic* Transition, int32 FrameIndex);

Source/VisualU/Public/BreakVisualTextBlockDecorator.h

@@ -11,7 +11,7 @@ class URichTextBlock;
 
 /**
 * Pauses typewriter when it hits break tag - {@code <b/>}.
-* Understands *text*<b>*text*</> and *text*<b/>*text*.
+* Understands @code{.unparsed} *text*<b>*text*</> and *text*<b/>*text*. @endcode
 * Only one tag per text is supported at this time.
 * 
 * @note Only the last found break tag in the text will have an effect.

Source/VisualU/Public/InfoAssignable.h

@@ -43,7 +43,7 @@ class IInfoAssignable
 * -# Create a struct that inherits from {@code FVisualInfo}
 * -# Add desired fields
 * -# Override {@code Accept} function to implement Visitor pattern
-* -# Override {@codeToString} function if needed
+* -# Override {@code ToString} function if needed
 * 
 * @see FVisualImageInfo
 */

Source/VisualU/Public/SVisualImageBase.h

@@ -37,7 +37,7 @@ class VISUALU_API SVisualImageBase : public SLeafWidget
 	* Paints render resource as a brush after applying all modifiers.
 	* 
 	* @param Args contains information about paint of this widget
-	* @param AllotedGeometry base geometry for this widget
+	* @param AllottedGeometry base geometry for this widget
 	* @param MyCullingRect culling bounds of this widget
 	* @param OutDrawElements elements to draw in the slate window
 	* @param LayerId layer on which elements should be drawn

Source/VisualU/Public/Scenario.h

@@ -347,7 +347,7 @@ struct VISUALU_API FScenario : public FTableRowBase, public IInfoAssignable
 	int32 Index;
 
 public:
-	/*
+	/**
 	* Matches provided scene to its data stored in the data table.
 	* 
 	* @note Used during serialization
@@ -407,7 +407,7 @@ struct VISUALU_API FScenario : public FTableRowBase, public IInfoAssignable
 	* 
 	* @note said assets might be already loaded. Will empty Out.
 	* 
-	* @param Array to be filled with data that should be loaded
+	* @param Out array to be filled with data that should be loaded
 	*/
 	virtual void GetDataToLoad(TArray<FSoftObjectPath>& Out) const
 	{

Source/VisualU/Public/VisualController.h

@@ -184,7 +184,7 @@ class VISUALU_API UVisualController : public UObject
 	* 
 	* @note will trigger assertion for invalid index.
 	* 
-	* @param position of the scene
+	* @param Index position of the scene
 	* @return valid scene
 	*/
 	const FScenario* GetSceneAt(int32 Index);
@@ -361,7 +361,7 @@ class VISUALU_API UVisualController : public UObject
 	*
 	* @note scene is considered exhausted when it was already seen by player
 	*
-	* @param scene to check for exhaustion
+	* @param Scene scene to check for exhaustion
 	* @return is scene considered exhausted
 	*
 	* @see UVisualController::ExhaustedScenes

Source/VisualU/Public/VisualTextBlock.h

@@ -123,8 +123,14 @@ class VISUALU_API UVisualTextBlock : public URichTextBlock
 	FString CalculateSegments();
 
 private:
+	/**
+	* Text layout of this text block.
+	*/
 	TSharedPtr<FSlateTextLayout> TextLayout;
 
+	/**
+	* Text marshaller for the text layout.
+	*/
 	TSharedPtr<FRichTextLayoutMarshaller> TextMarshaller;
 
 	/**
@@ -147,7 +153,7 @@ class VISUALU_API UVisualTextBlock : public URichTextBlock
 	*/
 	FString CachedSegmentText;
 
-	/*
+	/**
 	* Index of last letter that already been printed out and won't ever change.
 	*/
 	int32 CachedLetterIndex;

Source/VisualU/Public/VisualVersioningSubsystem.h

@@ -101,7 +101,7 @@ class VISUALU_API UVisualVersioningSubsystem : public ULocalPlayerSubsystem
 	* Switches all scenes in the data table to an older version.
 	* Has no effect for scenes not altered by this subsystem.
 	*
-	* @param Scene scene to revert back to the previous version
+	* @param DataTable node which scenes will be reverted to previous version
 	*/
 	void CheckoutAll(UDataTable* const DataTable) const;
 

VisualU.uplugin

@@ -1,7 +1,7 @@
 {
 	"FileVersion": 3,
 	"Version": 1,
-	"VersionName": "1.0",
+	"VersionName": "1.1",
 	"FriendlyName": "VisualU",
 	"Description": "Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel narrative",
 	"Category": "Other",

docs/annotated.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -146,8 +147,9 @@
 <tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_u_visual_text_block.html" target="_self">UVisualTextBlock</a></td><td class="desc">A text block that exposes more information about text layout </td></tr>
 <tr id="row_31_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_u_visual_u_blueprint_statics.html" target="_self">UVisualUBlueprintStatics</a></td><td class="desc">Blueprint library with utility functions that could be helpful while developing blueprints with <a class="el" href="class_visual_u.html">VisualU</a> plugin </td></tr>
 <tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_u_visual_u_settings.html" target="_self">UVisualUSettings</a></td><td class="desc">Global plugin settings </td></tr>
-<tr id="row_33_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_u_visual_versioning_subsystem.html" target="_self">UVisualVersioningSubsystem</a></td><td class="desc">Allows for altering scenes in chosen nodes </td></tr>
-<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_visual_u.html" target="_self">VisualU</a></td><td class="desc"></td></tr>
+<tr id="row_33_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_33_" class="arrow" onclick="dynsection.toggleFolder('33_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_u_visual_versioning_subsystem.html" target="_self">UVisualVersioningSubsystem</a></td><td class="desc">Allows for altering scenes in nodes </td></tr>
+<tr id="row_33_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_u_visual_versioning_subsystem_1_1_f_scenario_id.html" target="_self">FScenarioId</a></td><td class="desc"></td></tr>
+<tr id="row_34_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_visual_u.html" target="_self">VisualU</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

docs/class_f_break_visual_text_block_decorator-members.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -118,7 +119,6 @@
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>Super</b> typedef (defined in <a class="el" href="class_f_break_visual_text_block_decorator.html">FBreakVisualTextBlockDecorator</a>)</td><td class="entry"><a class="el" href="class_f_break_visual_text_block_decorator.html">FBreakVisualTextBlockDecorator</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_f_break_visual_text_block_decorator.html#a668190548c9959075e33602c36032207">Supports</a>(const FTextRunParseResults &amp;RunParseResult, const FString &amp;Text) const override</td><td class="entry"><a class="el" href="class_f_break_visual_text_block_decorator.html">FBreakVisualTextBlockDecorator</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="class_f_break_visual_text_block_decorator.html#aa11d94ef37b093a86e5abc43c72fb4f9">TagPosition</a></td><td class="entry"><a class="el" href="class_f_break_visual_text_block_decorator.html">FBreakVisualTextBlockDecorator</a></td><td class="entry"><span class="mlabel">mutable</span><span class="mlabel">private</span></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~FBreakVisualTextBlockDecorator</b>() override (defined in <a class="el" href="class_f_break_visual_text_block_decorator.html">FBreakVisualTextBlockDecorator</a>)</td><td class="entry"><a class="el" href="class_f_break_visual_text_block_decorator.html">FBreakVisualTextBlockDecorator</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

docs/class_f_break_visual_text_block_decorator.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -118,7 +119,7 @@
 <p>Pauses typewriter when it hits break tag - <code class="JavaDocCode">&lt;b/&gt;</code>.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/BreakVisualTextBlockDecorator.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/BreakVisualTextBlockDecorator.h&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for FBreakVisualTextBlockDecorator:</div>
 <div class="dyncontent">
@@ -171,9 +172,9 @@
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Pauses typewriter when it hits break tag - <code class="JavaDocCode">&lt;b/&gt;</code>. </p>
-<p>Understands <em>text</em><b><em>text</em>&lt;/&gt; and <em>text</em><em>text</em>. Only one tag per text is supported at this time.</b></p>
-<p><b></p><dl class="section note"><dt>Note</dt><dd>Only the last found break tag in the text will have an effect. </dd></dl>
-<p></b></p>
+<p>Understands </p><div class="fragment"><div class="line">*text*&lt;b&gt;*text*&lt;/&gt; and *text*&lt;b/&gt;*text*. </div>
+</div><!-- fragment --><p> Only one tag per text is supported at this time.</p>
+<dl class="section note"><dt>Note</dt><dd>Only the last found break tag in the text will have an effect. </dd></dl>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="ab8c4035592a0b88d181f7f763726cd33" name="ab8c4035592a0b88d181f7f763726cd33"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ab8c4035592a0b88d181f7f763726cd33">&#9670;&#160;</a></span>CreateDecoratorText()</h2>

docs/class_f_visual_u_module-members.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>

docs/class_f_visual_u_module.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -114,7 +115,7 @@
 <p><a class="el" href="class_visual_u.html">VisualU</a> plugin runtime module.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/VisualU.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/VisualU.h&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for FVisualUModule:</div>
 <div class="dyncontent">

docs/class_has_member_of_type_impl-members.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>

docs/class_has_member_of_type_impl.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -115,7 +116,7 @@
 <p>Checks if T has a member variable of type U.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/VisualTemplates.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/VisualTemplates.h&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
 Static Public Attributes</h2></td></tr>

docs/class_i_info_assignable.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -111,7 +112,7 @@
 <p>Interface that allows classes to take data from <a class="el" href="struct_f_visual_info.html" title="Base struct for assignable info.">FVisualInfo</a> structures.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/InfoAssignable.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/InfoAssignable.h&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for IInfoAssignable:</div>
 <div class="dyncontent">

docs/class_i_visual_controller_interface-members.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>

docs/class_i_visual_controller_interface.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -114,7 +115,7 @@
 <p>Indicates that the class has access to <a class="el" href="class_u_visual_controller.html" title="Organizes scenes described by FScenario in a meaningful way.">UVisualController</a>.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/VisualControllerInterface.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/VisualControllerInterface.h&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>

docs/class_s_background_visual_image-members.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>

docs/class_s_background_visual_image.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -117,7 +118,7 @@
 <p>Slate visual image that supports transition effects through material.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/SBackgroundVisualImage.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/SBackgroundVisualImage.h&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for SBackgroundVisualImage:</div>
 <div class="dyncontent">

docs/class_s_visual_image-members.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>

docs/class_s_visual_image.html

@@ -32,8 +32,9 @@
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr id="projectrow">
+  <td id="projectlogo"><img alt="Logo" src="logocombined.png"/></td>
   <td id="projectalign">
-   <div id="projectname">VisualU<span id="projectnumber">&#160;1.0</span>
+   <div id="projectname">VisualU<span id="projectnumber">&#160;1.1</span>
    </div>
    <div id="projectbrief">Plugin for Unreal Engine 5 that brings core functionality for a widget-based visual novel game</div>
   </td>
@@ -116,7 +117,7 @@
 <p>Slate widget that displays sprite flipbooks.  
  <a href="#details">More...</a></p>
 
-<p><code>#include &lt;VisualU/Public/SVisualImage.h&gt;</code></p>
+<p><code>#include &lt;G:/UE5/UEProjects/5.3/VisualUEx/Plugins/VisualU/Source/VisualU/Public/SVisualImage.h&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for SVisualImage:</div>
 <div class="dyncontent">