Mercurial Repositories > eric / file diff

--- a/docs/README-eric7-doc.md	Mon Dec 18 16:39:01 2023 +0100
+++ b/docs/README-eric7-doc.md	Mon Dec 18 16:39:44 2023 +0100
@@ -97,8 +97,8 @@
   followed by one or more lines of descriptive text.
 
 @event eventname description
-: This tag is used to describe the events (PyQt) a class may emit. It is 
-  always followed by the event name and one or more lines of descriptive 
+: This tag is used to describe the events (PyQt, PySide) a class may emit. It
+  is always followed by the event name and one or more lines of descriptive 
   text. For example:
 
         @event closeEvent Emitted when an editor window is closed.
@@ -110,9 +110,6 @@
 
         @exception ValueError The searched value is not contained in the list.
 
-@ireturn description
-: This tag is an alias for the @return tag.
-
 @keyparam name description
 : This tag is like the @param tag, but should be used for parameters, that 
   should always be given as keyword parameters. It is always followed by 
@@ -127,16 +124,6 @@
 
         @param filename name of the source file
 
-@ptype name parameter-type
-: This tag is used to describe the type of a function or method argument.
-  It is always followed by the argument name and type. The argument has
-  to be defined already with @param or @keyparam. For example:
-
-        @ptype filename str
-
-@raise exception description
-: This tag is an alias for the @exception tag.
-
 @return description
 : This tag is used to describe a function or method return value. It can 
   include one or more lines of descriptive text. For example:
@@ -160,7 +147,7 @@
 
             @see "eric7-doc readme file"
 
-: @see <a href="URL#value">label</a>
+: @see &lt;a href="URL#value"&gt;label&lt;/a&gt;
     : Adds a link as defined by URL#value. eric7-doc distinguishes this form
       from the others by looking for a less-than symbol (<) as the first
       character. For example:
@@ -178,15 +165,12 @@
             see eric7.DocumentationTools.ModuleDocumentor#ModuleDocument.__genModuleSection ModuleDocument.__genModuleSection
 
 @signal signalname description
-: This tag is used to describe the signals (PyQt) a class may emit. It is 
-  always followed by the signal name and one or more lines of descriptive 
-  text. For example:
+: This tag is used to describe the signals (PyQt, PySide) a class may emit. It is 
+  always followed by the signal name and one or more lines of descriptive text.
+  For example:
 
         @signal lastEditorClosed Emitted after the last editor window was closed.
 
-@throws exception description
-: This tag is an alias for the @exception tag.
-
 @type parameter-type
 : This tag is used to give the type of the parameter just described.
   It must be preceded by a @param or @keyparam tag. For example:
@@ -194,10 +178,22 @@
         @param filename name of the source file
         @type str
 
+@yield description
+: This tag is used to describe a function or method yield value. It can 
+  include one or more lines of descriptive text. For example:
+
+        @yield file names
+
+@ytype type
+: This tag is used to describe a function or method yield type. It should
+  follow an @yield tag. For example:
+
+        @ytype str
+
 # 3. Inline Tags
 The inline tags recogized by eric7-doc are:
 
 {@link package.module#member label}
 : Inserts an in-line link with visible text label that points to the documentation
-  given in the reference. This tag works he same way as the @see block tag of this
+  given in the reference. This tag works the same way as the @see block tag of this
   form.