Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html

Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html

changeset 5977
8a0ec75b0f73
parent 5606
da305d172769
--- a/Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html	Sat Nov 18 12:35:13 2017 +0100
+++ b/Documentation/Source/eric6.Utilities.ClassBrowsers.ClbrBaseClasses.html	Sat Nov 18 18:27:25 2017 +0100
@@ -45,6 +45,9 @@
 <td><a href="#Coding">Coding</a></td>
 <td>Class to represent a source coding.</td>
 </tr><tr>
+<td><a href="#Enum">Enum</a></td>
+<td>Class to represent an enum definition.</td>
+</tr><tr>
 <td><a href="#Function">Function</a></td>
 <td>Class to represent a function or method.</td>
 </tr><tr>
@@ -95,18 +98,18 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the module containing this class
-</dd><dt><i>name</i></dt>
+name of the module containing this attribute
+</dd><dt><i>name</i> (str)</dt>
 <dd>
-name of this class
-</dd><dt><i>file</i></dt>
+name of this attribute
+</dd><dt><i>file</i> (str)</dt>
 <dd>
 filename containing this attribute
-</dd><dt><i>lineno</i></dt>
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition
+line number of the attribute definition
 </dd>
 </dl><a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a>
 <h4>Attribute.addAssignment</h4>
@@ -114,10 +117,9 @@
 <p>
         Public method to add another assignment line number.
 </p><dl>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the additional attribute assignment
-            (integer)
+line number of the additional attribute assignment
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -154,21 +156,21 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
 name of the module containing this class
-</dd><dt><i>name</i></dt>
+</dd><dt><i>name</i> (str)</dt>
 <dd>
 name of this class
-</dd><dt><i>superClasses</i></dt>
+</dd><dt><i>superClasses</i> (list of str)</dt>
 <dd>
 list of class names this class is inherited from
-</dd><dt><i>file</i></dt>
+</dd><dt><i>file</i> (str)</dt>
 <dd>
 filename containing this class
-</dd><dt><i>lineno</i></dt>
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition
+line number of the class definition
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -226,18 +228,18 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the module containing this class
-</dd><dt><i>name</i></dt>
+name of the module containing this object
+</dd><dt><i>name</i> (str)</dt>
 <dd>
-name of this class
-</dd><dt><i>file</i></dt>
+name of this object
+</dd><dt><i>file</i> (str)</dt>
 <dd>
 filename containing this object
-</dd><dt><i>lineno</i></dt>
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition
+linenumber of the object definition
 </dd>
 </dl><a NAME="ClbrBase._addattribute" ID="ClbrBase._addattribute"></a>
 <h4>ClbrBase._addattribute</h4>
@@ -245,9 +247,9 @@
 <p>
         Protected method to add information about attributes.
 </p><dl>
-<dt><i>attr</i></dt>
+<dt><i>attr</i> (Attribute)</dt>
 <dd>
-Attribute object to be added (Attribute)
+Attribute object to be added
 </dd>
 </dl><a NAME="ClbrBase._addclass" ID="ClbrBase._addclass"></a>
 <h4>ClbrBase._addclass</h4>
@@ -255,12 +257,12 @@
 <p>
         Protected method method to add a nested class to this class.
 </p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
 name of the class
-</dd><dt><i>_class</i></dt>
+</dd><dt><i>_class</i> (Class)</dt>
 <dd>
-Class object to be added (Class)
+Class object to be added
 </dd>
 </dl><a NAME="ClbrBase._addglobal" ID="ClbrBase._addglobal"></a>
 <h4>ClbrBase._addglobal</h4>
@@ -268,9 +270,9 @@
 <p>
         Protected method to add information about global variables.
 </p><dl>
-<dt><i>attr</i></dt>
+<dt><i>attr</i> (Attribute)</dt>
 <dd>
-Attribute object to be added (Attribute)
+Attribute object to be added
 </dd>
 </dl><a NAME="ClbrBase._addmethod" ID="ClbrBase._addmethod"></a>
 <h4>ClbrBase._addmethod</h4>
@@ -278,10 +280,10 @@
 <p>
         Protected method to add information about a method.
 </p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of method to be added (string)
-</dd><dt><i>function</i></dt>
+name of method to be added
+</dd><dt><i>function</i> (Function)</dt>
 <dd>
 Function object to be added
 </dd>
@@ -291,14 +293,19 @@
 <p>
         Protected method to retrieve an attribute by name.
 </p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the attribute (string)
+name of the attribute
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the named attribute or None
+the named attribute
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+Attribute or None
 </dd>
 </dl><a NAME="ClbrBase._getglobal" ID="ClbrBase._getglobal"></a>
 <h4>ClbrBase._getglobal</h4>
@@ -306,14 +313,19 @@
 <p>
         Protected method to retrieve a global variable by name.
 </p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the global variable (string)
+name of the global variable
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the named global variable or None
+the named global variable
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+Attribute or None
 </dd>
 </dl><a NAME="ClbrBase._getmethod" ID="ClbrBase._getmethod"></a>
 <h4>ClbrBase._getmethod</h4>
@@ -321,14 +333,19 @@
 <p>
         Protected method to retrieve a method by name.
 </p><dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
 name of the method (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-the named method or None
+the named method
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+Function or None
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -382,7 +399,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating Private visibility (boolean)
+flag indicating Private visibility
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ClbrVisibilityMixinBase.isProtected" ID="ClbrVisibilityMixinBase.isProtected"></a>
 <h4>ClbrVisibilityMixinBase.isProtected</h4>
@@ -392,7 +414,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating Protected visibility (boolean)
+flag indicating Protected visibility
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ClbrVisibilityMixinBase.isPublic" ID="ClbrVisibilityMixinBase.isPublic"></a>
 <h4>ClbrVisibilityMixinBase.isPublic</h4>
@@ -402,7 +429,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating Public visibility (boolean)
+flag indicating Public visibility
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="ClbrVisibilityMixinBase.setPrivate" ID="ClbrVisibilityMixinBase.setPrivate"></a>
 <h4>ClbrVisibilityMixinBase.setPrivate</h4>
@@ -454,22 +486,70 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the module containing this module
-</dd><dt><i>file</i></dt>
+name of the module containing this coding statement
+</dd><dt><i>file</i> (str)</dt>
 <dd>
-filename containing this module
-</dd><dt><i>lineno</i></dt>
+filename containing this coding statement
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the module definition
-</dd><dt><i>coding</i></dt>
+line number of the coding definition
+</dd><dt><i>coding</i> (str)</dt>
 <dd>
 character coding of the source file
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="Enum" ID="Enum"></a>
+<h2>Enum</h2>
+<p>
+    Class to represent an enum definition.
+</p>
+<h3>Derived from</h3>
+ClbrBase
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Enum.__init__">Enum</a></td>
+<td>Constructor</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="Enum.__init__" ID="Enum.__init__"></a>
+<h4>Enum (Constructor)</h4>
+<b>Enum</b>(<i>module, name, file, lineno</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>module</i> (str)</dt>
+<dd>
+name of the module containing this enum
+</dd><dt><i>name</i> (str)</dt>
+<dd>
+name of this enum
+</dd><dt><i>file</i> (str)</dt>
+<dd>
+filename containing this enum
+</dd><dt><i>lineno</i> (int)</dt>
+<dd>
+line number of the enum definition
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="Function" ID="Function"></a>
 <h2>Function</h2>
 <p>
@@ -502,30 +582,30 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
 name of the module containing this function
-</dd><dt><i>name</i></dt>
+</dd><dt><i>name</i> (str)</dt>
 <dd>
 name of this function
-</dd><dt><i>file</i></dt>
+</dd><dt><i>file</i> (str)</dt>
 <dd>
-filename containing this class
-</dd><dt><i>lineno</i></dt>
+filename containing this function
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition
-</dd><dt><i>signature</i></dt>
+line number of the function definition
+</dd><dt><i>signature</i> (str)</dt>
 <dd>
-parameterlist of the method
-</dd><dt><i>separator</i></dt>
+parameter list of the function
+</dd><dt><i>separator</i> (str)</dt>
 <dd>
-string separating the parameters
-</dd><dt><i>modifierType</i></dt>
+string separating the parameters of the function
+</dd><dt><i>modifierType</i> (int)</dt>
 <dd>
 type of the function
-</dd><dt><i>annotation</i></dt>
+</dd><dt><i>annotation</i> (str)</dt>
 <dd>
-return annotation
+function return annotation
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -562,18 +642,18 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
 name of the module containing this module
-</dd><dt><i>name</i></dt>
+</dd><dt><i>name</i> (str)</dt>
 <dd>
 name of this module
-</dd><dt><i>file</i></dt>
+</dd><dt><i>file</i> (str)</dt>
 <dd>
 filename containing this module
-</dd><dt><i>lineno</i></dt>
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the module definition
+line number of the module definition
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -613,18 +693,18 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>module</i></dt>
+<dt><i>module</i> (str)</dt>
 <dd>
-name of the module containing this class
-</dd><dt><i>name</i></dt>
+name of the module containing this object
+</dd><dt><i>name</i> (str)</dt>
 <dd>
-name of this class
-</dd><dt><i>file</i></dt>
+name of this object
+</dd><dt><i>file</i> (str)</dt>
 <dd>
 filename containing this object
-</dd><dt><i>lineno</i></dt>
+</dd><dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the class definition
+linenumber of the object definition
 </dd>
 </dl><a NAME="_ClbrBase.setEndLine" ID="_ClbrBase.setEndLine"></a>
 <h4>_ClbrBase.setEndLine</h4>
@@ -632,9 +712,9 @@
 <p>
         Public method to set the ending line number.
 </p><dl>
-<dt><i>endLineNo</i></dt>
+<dt><i>endLineNo</i> (int)</dt>
 <dd>
-number of the last line (integer)
+number of the last line
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial