README-eric5-doc.txt

changeset 59
6f891dcc93d9
parent 15
f6ccc31d6e72
--- a/README-eric5-doc.txt	Thu Jan 14 18:35:52 2010 +0000
+++ b/README-eric5-doc.txt	Fri Jan 15 11:40:20 2010 +0000
@@ -1,6 +1,6 @@
-README for the eric4-doc documentation generator
+README for the eric5-doc documentation generator
 
-    eric4-doc is the documentation generator of the eric4 IDE. Python source
+    eric5-doc is the documentation generator of the eric5 IDE. Python source
     code documentation may be included as ordinary Python doc-strings or as 
     documentation comments. For Quixote Template files (PTL) only documentation 
     comments are available due to the inner workings of Quixote. Documentation 
@@ -20,7 +20,7 @@
     the module, class, function or method. The second part, separated from the 
     first by a blank line, consists of one or more tags. These are described below.
     
-    eric4-doc produces HTML files from the documentation found within the source 
+    eric5-doc produces HTML files from the documentation found within the source 
     files scaned. It understands the following commandline parameters next to others.
     
     -o directory
@@ -36,7 +36,7 @@
     -i
       Don't generate index files.
     
-    Just type "eric4-doc" to get some usage information.
+    Just type "eric5-doc" to get some usage information.
     
     Description
     -----------
@@ -89,7 +89,7 @@
 
     Block Tags
     ----------
-    The block tags recogized by eric4-doc are:
+    The block tags recogized by eric5-doc are:
 
     @@
         This isn't really a tag. This is used to escape an at sign at the beginning
@@ -145,18 +145,18 @@
         three different forms.
 
         @see "string"
-            Adds a text entry of string. No link is generated. eric4-doc distinguishes
+            Adds a text entry of string. No link is generated. eric5-doc distinguishes
             this form from the others by looking for a double-quote (") as the first
             character. For example:
 
-            @see "eric4-doc readme file"
+            @see "eric5-doc readme file"
 
         @see <a href="URL#value">label</a>
-            Adds a link as defined by URL#value. eric4-doc distinguishes this form from
+            Adds a link as defined by URL#value. eric5-doc distinguishes this form from
             the others by looking for a less-than symbol (<) as the first character.
             For example:
 
-            @see <a href="eric4.eric4-doc.html>eric4-doc documentation generator</a>
+            @see <a href="eric5.eric5-doc.html>eric5-doc documentation generator</a>
 
         @see package.module#member label
             Adds a link to "member" in "module" in "package". package can be a package
@@ -164,8 +164,8 @@
             "package.module#member" part must not be split over several lines and
             must name a valid target within the documentation directory. For example:
 
-            @see eric4.eric4-doc#main eric4-doc main() function
-            @see eric4.DocumentationTools.ModuleDocumentor#ModuleDocument.__genModuleSection
+            @see eric5.eric5-doc#main eric5-doc main() function
+            @see eric5.DocumentationTools.ModuleDocumentor#ModuleDocument.__genModuleSection
                 ModuleDocument.__genModuleSection
 
     @signal signalname description
@@ -181,7 +181,7 @@
 
     Inline Tags
     -----------
-    The inline tags recogized by eric4-doc are:
+    The inline tags recogized by eric5-doc are:
 
     {@link package.module#member label}
         Inserts an in-line link with visible text label that points to the documentation

eric ide

mercurial