--- a/SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html Fri May 28 19:09:47 2021 +0200
+++ b/SplitMergeCamelCase/Documentation/source/Plugin_Tools_SplitMergeCamelCase.PluginSplitMergeCamelCase.html Fri May 28 19:37:46 2021 +0200
@@ -77,7 +77,7 @@
<td>Private method to change the selected text.</td>
</tr>
<tr>
-<td><a href="#SplitMergeCamelCasePlugin.__camelCaseToUnderscore">__camelCaseToUnderscore</a></td>
+<td><a href="#SplitMergeCamelCasePlugin.__camelCaseToSnakeCase">__camelCaseToSnakeCase</a></td>
<td>Private slot to convert camel case text to underscore separated text.</td>
</tr>
<tr>
@@ -105,20 +105,32 @@
<td>Private slot to merge the selected text to camel case.</td>
</tr>
<tr>
+<td><a href="#SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst">__mergeCamelCaseUppercaseFirst</a></td>
+<td>Private slot to merge the selected text to camel case upper casing the first character.</td>
+</tr>
+<tr>
+<td><a href="#SplitMergeCamelCasePlugin.__mergeSnakeCase">__mergeSnakeCase</a></td>
+<td>Private slot to merge the selected text to snake case.</td>
+</tr>
+<tr>
<td><a href="#SplitMergeCamelCasePlugin.__populateMenu">__populateMenu</a></td>
<td>Private slot to populate the tools menu with our entries.</td>
</tr>
<tr>
+<td><a href="#SplitMergeCamelCasePlugin.__snakeCaseToCamelCase">__snakeCaseToCamelCase</a></td>
+<td>Private slot to convert underscore separated text to camel case.</td>
+</tr>
+<tr>
+<td><a href="#SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst">__snakeCaseToCamelCaseUppercaseFirst</a></td>
+<td>Private slot to convert underscore separated text to camel case upper casing the first character.</td>
+</tr>
+<tr>
<td><a href="#SplitMergeCamelCasePlugin.__splitCamelCase">__splitCamelCase</a></td>
<td>Private slot to split the selected camel case text.</td>
</tr>
<tr>
-<td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCase">__underscoreToCamelCase</a></td>
-<td>Private slot to convert underscore separated text to camel case.</td>
-</tr>
-<tr>
-<td><a href="#SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst">__underscoreToCamelCaseUppercaseFirst</a></td>
-<td>Private slot to convert underscore separated text to camel case upper casing the first character.</td>
+<td><a href="#SplitMergeCamelCasePlugin.__splitSnakeCase">__splitSnakeCase</a></td>
+<td>Private slot to split the selected snake case text.</td>
</tr>
<tr>
<td><a href="#SplitMergeCamelCasePlugin.activate">activate</a></td>
@@ -144,9 +156,9 @@
</p>
<dl>
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
<dd>
-reference to the user interface object (UI.UserInterface)
+reference to the user interface object
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__applyChange" ID="SplitMergeCamelCasePlugin.__applyChange"></a>
@@ -158,19 +170,19 @@
</p>
<dl>
-<dt><i>newText</i></dt>
+<dt><i>newText</i> (str)</dt>
<dd>
-new (converted) text (string)
+new (converted) text
</dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor to apply the text
- change to (Editor)
+ change to
</dd>
</dl>
-<a NAME="SplitMergeCamelCasePlugin.__camelCaseToUnderscore" ID="SplitMergeCamelCasePlugin.__camelCaseToUnderscore"></a>
-<h4>SplitMergeCamelCasePlugin.__camelCaseToUnderscore</h4>
-<b>__camelCaseToUnderscore</b>(<i></i>)
+<a NAME="SplitMergeCamelCasePlugin.__camelCaseToSnakeCase" ID="SplitMergeCamelCasePlugin.__camelCaseToSnakeCase"></a>
+<h4>SplitMergeCamelCasePlugin.__camelCaseToSnakeCase</h4>
+<b>__camelCaseToSnakeCase</b>(<i></i>)
<p>
Private slot to convert camel case text to underscore separated text.
@@ -184,9 +196,9 @@
</p>
<dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
<dd>
-reference to the editor (QScintilla.Editor)
+reference to the editor
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__editorOpened" ID="SplitMergeCamelCasePlugin.__editorOpened"></a>
@@ -198,9 +210,9 @@
</p>
<dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
<dd>
-reference to the new editor (QScintilla.Editor)
+reference to the new editor
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.__editorShowMenu" ID="SplitMergeCamelCasePlugin.__editorShowMenu"></a>
@@ -213,15 +225,15 @@
</p>
<dl>
-<dt><i>menuName</i></dt>
+<dt><i>menuName</i> (str)</dt>
<dd>
-name of the menu to be shown (string)
+name of the menu to be shown
</dd>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu (QMenu)
+reference to the menu
</dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor
</dd>
@@ -242,11 +254,34 @@
</p>
<a NAME="SplitMergeCamelCasePlugin.__mergeCamelCase" ID="SplitMergeCamelCasePlugin.__mergeCamelCase"></a>
<h4>SplitMergeCamelCasePlugin.__mergeCamelCase</h4>
-<b>__mergeCamelCase</b>(<i></i>)
+<b>__mergeCamelCase</b>(<i>uppercaseFirst=False</i>)
<p>
Private slot to merge the selected text to camel case.
</p>
+<dl>
+
+<dt><i>uppercaseFirst</i> (bool)</dt>
+<dd>
+flag indicating to upper case the
+ first character
+</dd>
+</dl>
+<a NAME="SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst"></a>
+<h4>SplitMergeCamelCasePlugin.__mergeCamelCaseUppercaseFirst</h4>
+<b>__mergeCamelCaseUppercaseFirst</b>(<i></i>)
+
+<p>
+ Private slot to merge the selected text to camel case upper casing
+ the first character.
+</p>
+<a NAME="SplitMergeCamelCasePlugin.__mergeSnakeCase" ID="SplitMergeCamelCasePlugin.__mergeSnakeCase"></a>
+<h4>SplitMergeCamelCasePlugin.__mergeSnakeCase</h4>
+<b>__mergeSnakeCase</b>(<i></i>)
+
+<p>
+ Private slot to merge the selected text to snake case.
+</p>
<a NAME="SplitMergeCamelCasePlugin.__populateMenu" ID="SplitMergeCamelCasePlugin.__populateMenu"></a>
<h4>SplitMergeCamelCasePlugin.__populateMenu</h4>
<b>__populateMenu</b>(<i>name, menu</i>)
@@ -256,15 +291,38 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the menu (string)
+name of the menu
</dd>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be populated (QMenu)
+reference to the menu to be populated
</dd>
</dl>
+<a NAME="SplitMergeCamelCasePlugin.__snakeCaseToCamelCase" ID="SplitMergeCamelCasePlugin.__snakeCaseToCamelCase"></a>
+<h4>SplitMergeCamelCasePlugin.__snakeCaseToCamelCase</h4>
+<b>__snakeCaseToCamelCase</b>(<i>uppercaseFirst=False</i>)
+
+<p>
+ Private slot to convert underscore separated text to camel case.
+</p>
+<dl>
+
+<dt><i>uppercaseFirst</i> (bool)</dt>
+<dd>
+flag indicating to upper case the
+ first character
+</dd>
+</dl>
+<a NAME="SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst"></a>
+<h4>SplitMergeCamelCasePlugin.__snakeCaseToCamelCaseUppercaseFirst</h4>
+<b>__snakeCaseToCamelCaseUppercaseFirst</b>(<i></i>)
+
+<p>
+ Private slot to convert underscore separated text to camel case
+ upper casing the first character.
+</p>
<a NAME="SplitMergeCamelCasePlugin.__splitCamelCase" ID="SplitMergeCamelCasePlugin.__splitCamelCase"></a>
<h4>SplitMergeCamelCasePlugin.__splitCamelCase</h4>
<b>__splitCamelCase</b>(<i></i>)
@@ -272,28 +330,12 @@
<p>
Private slot to split the selected camel case text.
</p>
-<a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCase" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCase"></a>
-<h4>SplitMergeCamelCasePlugin.__underscoreToCamelCase</h4>
-<b>__underscoreToCamelCase</b>(<i>uppercaseFirst=False</i>)
+<a NAME="SplitMergeCamelCasePlugin.__splitSnakeCase" ID="SplitMergeCamelCasePlugin.__splitSnakeCase"></a>
+<h4>SplitMergeCamelCasePlugin.__splitSnakeCase</h4>
+<b>__splitSnakeCase</b>(<i></i>)
<p>
- Private slot to convert underscore separated text to camel case.
-</p>
-<dl>
-
-<dt><i>uppercaseFirst</i></dt>
-<dd>
-flag indicating to upper case the
- first character (boolean)
-</dd>
-</dl>
-<a NAME="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst" ID="SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst"></a>
-<h4>SplitMergeCamelCasePlugin.__underscoreToCamelCaseUppercaseFirst</h4>
-<b>__underscoreToCamelCaseUppercaseFirst</b>(<i></i>)
-
-<p>
- Private slot to convert underscore separated text to camel case
- upper casing the first character.
+ Private slot to split the selected snake case text.
</p>
<a NAME="SplitMergeCamelCasePlugin.activate" ID="SplitMergeCamelCasePlugin.activate"></a>
<h4>SplitMergeCamelCasePlugin.activate</h4>
@@ -305,7 +347,13 @@
<dl>
<dt>Return:</dt>
<dd>
-tuple of None and activation status (boolean)
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (None, bool)
</dd>
</dl>
<a NAME="SplitMergeCamelCasePlugin.deactivate" ID="SplitMergeCamelCasePlugin.deactivate"></a>
