Some more places adapted to eric6 and Qt5/PyQt5.

Sat, 09 Aug 2014 18:16:12 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 09 Aug 2014 18:16:12 +0200
changeset 3758
19866b4e9027
parent 3751
3b5476d5420c
child 3762
ac51ccb60e35

Some more places adapted to eric6 and Qt5/PyQt5.

README file | annotate | diff | comparison | revisions
README-MacOSX.txt file | annotate | diff | comparison | revisions
README-Raspberry.txt file | annotate | diff | comparison | revisions
README-eric5-doc.txt file | annotate | diff | comparison | revisions
README-eric6-doc.txt file | annotate | diff | comparison | revisions
README-i18n.txt file | annotate | diff | comparison | revisions
README-passive-debugging.txt file | annotate | diff | comparison | revisions
default.e4k file | annotate | diff | comparison | revisions
default_Mac.e4k file | annotate | diff | comparison | revisions
eric6.appdata.xml file | annotate | diff | comparison | revisions
eric6.e4p file | annotate | diff | comparison | revisions
install.py file | annotate | diff | comparison | revisions
pixmaps/eric5.ico file | annotate | diff | comparison | revisions
pixmaps/eric6.ico file | annotate | diff | comparison | revisions
uninstall.py file | annotate | diff | comparison | revisions
--- a/README	Sat Aug 09 12:23:18 2014 +0200
+++ b/README	Sat Aug 09 18:16:12 2014 +0200
@@ -13,7 +13,7 @@
         below mentioned address and tell me your reason. This might give me a hint on
         how to improve eric6.
         
-        If the required packages (Qt4, QScintilla2, sip and PyQt4) are not installed, 
+        If the required packages (Qt5, QScintilla2, sip and PyQt5) are not installed, 
         please get them and install them in the following order (order is important).
         
             1. Install Qt5 (from Nokia)
@@ -33,7 +33,7 @@
         install them in any order and at any time.
         
         Please note, that the QScintilla2 Python bindings have to be rebuild, if
-        the PyQt4 package gets updated. If this step is omitted, a bunch of strange
+        the PyQt5 package gets updated. If this step is omitted, a bunch of strange
         errors will occur.
     
     Installation of translations
@@ -160,10 +160,6 @@
             profile 
                 This is part of the standard Python distribution and is used to profile
                 Python source code.
-            
-            cyclops 
-                This is a tool to detect variable cycles which can cause the garbage
-                collector being unable to do his job.
     
     Interfaces to additional software packages via plugins
     
--- a/README-MacOSX.txt	Sat Aug 09 12:23:18 2014 +0200
+++ b/README-MacOSX.txt	Sat Aug 09 18:16:12 2014 +0200
@@ -9,33 +9,10 @@
 because of it's completeness. This is the way described below.
 
 
-1. Install Xcode 3 (for Snow Leopard)
-------------------
-The installation of various packages require the Xcode package that is
-available from Apple for free. Xcode 3 is contained on the Install DVD
-that came with your Mac. Just insert it and select the optional packages.
-In this window select Xcode. Make sure, you have the following selected:
-
- - Essentials
- - System Tools
- - UNIX Development
- - Documentation
-
-After the installation has finished perform an update of your system
-software via the Apple menu.
-
-Alternatively you may install the Xcode 3 package from the Apple developer
-web site. Just open your browser and enter the URL "http://developer.apple.com/xcode/".
-Follow the instructions on this page. This page requires to log in first. If
-you don't have an AppleID yet, follow the link next to the "Log in" button.
-After you have been logged in follow the download link for Xcode 3. After you
-downloaded the package install it as described above. 
-
-
-1. Install Xcode 4 (for Lion and Mountain Lion)
-------------------
+1. Install Xcode
+----------------
 Open the Mac App Store and enter "xcode" into the search entry at the top
-right of the window. From the list of results select the Xcode entry. Xcode 4
+right of the window. From the list of results select the Xcode entry. Xcode
 is provided free of charge. On the Xcode page select the button to get the
 package. Follow the usual procedure to start the download. Once the download
 has finished open the applications folder and select the "Install Xcode" entry.
@@ -43,8 +20,8 @@
 ask for a selection of sub-packages.
 
 
-2. Install Python 3.2 or 3.3
-----------------------------
+2. Install Python 3.4
+---------------------
 Although Mac OS X comes with a python installation it is recommended to
 install the python package provided by the Python community. Download it
 from 
@@ -55,37 +32,11 @@
 
 Note: The Python documentation can be found in these locations
 
-/Library/Frameworks/Python.framework/Versions/3.2/Resources/English.lproj/Documentation/index.html
-/Applications/Python 3.2/Python Documentation.html
-
-or
-
-/Library/Frameworks/Python.framework/Versions/3.3/Resources/English.lproj/Documentation/index.html
-/Applications/Python 3.3/Python Documentation.html
-
-3a. Install Qt4
----------------
-Download the Qt4 package from
-
-http://qt-project.org/downloads
+/Library/Frameworks/Python.framework/Versions/3.4/Resources/English.lproj/Documentation/index.html
+/Applications/Python 3.4/Python Documentation.html
 
-After the download finished open the downloaded package and install it. The
-tools (e.g. Designer, Linguist) can be found in the location
-
-/Developer/Tools/Qt
-
-The documentation can be found in these locations
-
-/Developer/Documentation/Qt/html (HTML format)
-/Developer/Documentation/Qt/qch (QtHelp format)
-
-The translation files can be found in this location
-
-/Developer/Applications/Qt/translations
-
-
-3b. Install Qt5
----------------
+3. Install Qt5
+--------------
 Download the Qt5 package from
 
 http://qt-project.org/downloads
@@ -94,7 +45,7 @@
 tools (e.g. Designer, Linguist) can be found in the location
 
 ˜/Qt<version>/<version>/<compiler>/bin
-e.g. ˜/Qt5.0.0/5.0.0/clang_64/bin
+e.g. ˜/Qt5.3.0/5.3.0/clang_64/bin
 
 The documentation can be found in these locations
 
@@ -117,11 +68,6 @@
 the Qt4 directory within the extracted folder and enter these commands in a
 terminal window
 
-Qt4:
-qmake qscintilla.pro -spec macx-g++
-make -j x (number of cores including hyper threaded ones)
-sudo make install
-
 Qt5:
 qmake qscintilla.pro
 make -j x (number of cores including hyper threaded ones)
@@ -143,11 +89,11 @@
 sudo make install
 
 
-6. Install PyQt4
+6. Install PyQt5
 ----------------
-Download the PyQt4 source code package from
+Download the PyQt5 source code package from
 
-http://www.riverbankcomputing.com/software/pyqt/download
+http://www.riverbankcomputing.com/software/pyqt/download5
 
 After the download has finished open a Finder window and extract the downloaded
 archive in the Downloads folder (or any other folder of your choice). Change to
@@ -163,7 +109,7 @@
 Change back to the extracted QScintilla2 directory and in there change to the
 Python subdirectory. Enter these commands in a terminal window
 
-python3 configure.py -c -j x (number of cores including hyper threaded ones)
+python3 configure.py --pyqt=PyQt5 -c -j x (number of cores including hyper threaded ones)
 make -j x (number of cores including hyper threaded ones)
 sudo make install
 
@@ -231,7 +177,7 @@
 ---------------------
 Get the penchant sources from
 
-http://pypi.python.org/pypi/pyenchant/1.6.5
+http://pypi.python.org/pypi/pyenchant/1.6.6
 
 Extract the downloaded sources, change to the sources directory and enter
 this command
@@ -256,7 +202,7 @@
 
 13. Install pysvn
 -----------------
-Mac OS X already provides subversion. However, best performance for eric5 is
+Mac OS X already provides subversion. However, best performance for eric6 is
 gained with the pysvn interface to subversion. Therefore it is recommended to
 install pysvn. Get pysvn via 
 
@@ -288,9 +234,9 @@
 Extract the downloaded package and install it.
 
 
-15. Install eric5
+15. Install eric6
 -----------------
-Get the latest eric5 distribution package from 
+Get the latest eric6 distribution package from 
 
 http://eric-ide.python-projects.org/eric-download.html
 
@@ -302,18 +248,18 @@
 sudo python3 install.py
 
 This step concludes the installation procedure. You are ready for the first
-start of eric5.
+start of eric6.
 
-The eric5 installer created an application bundle in the location
+The eric6 installer created an application bundle in the location
 
-/Developer/Applications/Eric5
+/Applications/eric6
 
 You may drag it to the dock to have it ready.
 
 
-16. First start of eric5
+16. First start of eric6
 ------------------------
-When eric5 is started for the first time it will recognize that it hasn't been
+When eric6 is started for the first time it will recognize that it hasn't been
 configured yet. Therefore it will start the configuration dialog with the
 default configuration. At this point you could simply close the dialog by
 pressing the OK button. However, it is strongly recommended that you go through
@@ -324,11 +270,11 @@
 values to be entered are given above in the Python and Qt installation sections.
 
 
-17. Install optional packages for eric5 (for plug-ins)
+17. Install optional packages for eric6 (for plug-ins)
 ------------------------------------------------------
-eric5 provides an extension mechanism via plug-ins. Some of them require the
+eric6 provides an extension mechanism via plug-ins. Some of them require the
 installation of additional python packages. The plug-ins themselves are
-available via the Plugin Repository from within eric5.
+available via the Plugin Repository from within eric6.
 
 
 17.1 Installation of pylint
@@ -378,7 +324,7 @@
 
 sudo python3 setup.py install
 
-This completes this installation instruction. Please enjoy using eric5 and let
+This completes this installation instruction. Please enjoy using eric6 and let
 the world know about it.
 
 
--- a/README-Raspberry.txt	Sat Aug 09 12:23:18 2014 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,172 +0,0 @@
-Readme for Raspberry Pi usage
-=============================
-
-This Readme file describes how to prepare a Raspberry Pi computer for eric.
-The recommended way to do this is to install the software packages from the
-distributors web pages. This procedure assumes, that the Raspbian "Wheezy"
-immage available via the Raspberry.org web site was used to prepare the
-SD card and that the initial setup steps have been completed.
-
-
-1. Finalisation of setup
-------------------------
-Perform these steps to get your installation up-to-date and remove obsolete
-packages.
-
-sudo apt-get update
-sudo apt-get upgrade
-sudo apt-get autoremove
-
-
-2. Complete Python3 and Python2 installation
---------------------------------------------
-Perform these steps to install the Python documentation and examples.
-
-sudo apt-get install python3-doc python3-examples python3-dev
-sudo apt-get install python-doc python-examples python-dev
-
-
-3. Install Qt4
---------------
-Perform these steps to install Qt4.
-
-sudo apt-get install qt4-designer qt4-dev-tools qt4-doc qt4-doc-html
-    qt4-linguist-tools qt4-qtconfig libqt4-sql-sqlite
-
-Note: Enter the above command on ONE line!
-
-This command will install all required packages as well. Once installation
-has finished you may change the Qt4 configuration using the 'qtconfig'
-tool (e.g. to select another GUI style).
-
-
-4. Install PyQt4
-----------------
-Perform these steps to install PyQt4.
-
-sudo apt-get install python3-pyqt4 python3-pyqt4.qsci python3-pyqt4.qtopengl
-    python3-pyqt4.qtsql pyqt4-dev-tools python3-dbus.mainloop.qt python-qt4-doc
-
-Note: Enter the above command on ONE line!
-
-This command will install all required packages as well.
-
-
-5. Install Spell Checker and Dictionaries
------------------------------------------
-Perform these steps to install the spell checker and spelling dictionaries.
-
-sudo apt-get install python3-enchant
-sudo apt-get install aspell-<xx>
-
-Replace <xx> by the desired language. To see which dictionaries are available
-execute this command.
-
-apt-cache search aspell
-
-
-6. Install Version Control Systems
-----------------------------------
-Perform these steps to install the version control systems supported by eric5.
-
-Mercurial:  sudo apt-get install mercurial kdiff3-qt
-Subversion: sudo apt-get install subversion subversion-tools
-
-
-7. Install eric5
-----------------
-Get the latest eric5 distribution package from 
-
-http://eric-ide.python-projects.org/eric-download.html
-
-Just follow the link on this page to the latest download.
-
-Extract the downloaded package and language packs into a directory and install
-it with this command
-
-sudo python3 install.py
-
-This step concludes the installation procedure. You are ready for the first
-start of eric5.
-
-The eric5 installer created an entry in the Development menu. You may add it to
-the desktop.
-
-
-8. First start of eric5
------------------------
-When eric5 is started for the first time it will recognize that it hasn't been
-configured yet. Therefore it will start the configuration dialog with the
-default configuration. At this point you could simply close the dialog by
-pressing the OK button. However, it is strongly recommended that you go through
-the configuration pages to get a feeling for the configuration possibilities.
-
-It is recommended to configure at least the paths to the various help pages on
-the Help Documentation page. The values to be entered are given below.
-
-Python2:    /usr/share/doc/python/html/index.html
-Python3:    /usr/share/doc/python3/html/index.html
-Qt4:        /usr/share/qt4/doc/html/classes.html
-PyQt4:      /usr/share/doc/python-qt4-doc/html/index.html
-
-
-9. Install optional packages for eric5 (for plug-ins)
------------------------------------------------------
-eric5 provides an extension mechanism via plug-ins. Some of them require the
-installation of additional python packages. The plug-ins themselves are
-available via the Plugin Repository from within eric5.
-
-
-9.1 Installation of pylint
---------------------------
-pylint is a tool to check Python sources for issues. In order to get it
-installed you have to download these packages with the latest version each.
-
-http://download.logilab.org/pub/pylint
-http://download.logilab.org/pub/astng 
-http://download.logilab.org/pub/common
-
-Once the downloads have been finished, extract all three packages and install
-them with these commands.
-
-In the logilab-common-<version> directory do
-
-sudo python3 setup.py install
-
-In the logilab-astng-<version> directory do
-
-sudo python3 setup.py install
-
-In the pylint-<version> directory do
-
-sudo python3 setup.py install
-
-Note: You may receive some errors during the above steps. They just relate to
-the tests included in the packages. If this occurs, please delete the faulty
-test file and retry. As of pylint 0.25.0 this file was 
-"test/input/func_unknown_encoding.py".
-
-
-9.2 Installation of cx_freeze
------------------------------
-cx_freeze is a tool that packages a Python application into executables. It is
-like py2exe and py2app. Get the sources from
-
-http://cx-freeze.sourceforge.net/
-
-and extract the downloaded source archive. In the extracted cx_freeze directory
-execute the command
-
-sudo python3 setup.py install
-
-This completes this installation instruction. Please enjoy using eric5 and let
-the world know about it.
-
-
-Appendix A.
------------
-In order to keep your system up-to-date execute these commands.
-
-sudo apt-get update
-sudo apt-get upgrade
-sudo apt-get autoremove
--- a/README-eric5-doc.txt	Sat Aug 09 12:23:18 2014 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,189 +0,0 @@
-README for the eric5-doc documentation generator
-
-    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 
-    comments start with the string ###, followed by the contents and ended by 
-    ###. Every line of the documentation comments contents must start with a # 
-    (see example below).
-    
-    For Ruby files, the documentation string must be started with "=begin edoc"
-    and must be ended with "=end". The documentation string for classes, modules
-    and functions/methods must follow their defininition.
-    
-    Documentation for packages (i.e. directories) must be in a file called 
-    __init__.py or __init__.rb. If a package directory doesn't contain a file
-    like these, documentation for files in this directory is suppressed.
-    
-    The documentation consist of two parts. The first part is the description of 
-    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.
-    
-    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
-      Generate files in the named directory.
-    
-    -R, -r
-      Perform a recursive search for Python files.
-    
-    -x directory
-      Specify a directory basename to be excluded. This option may be repeated
-      multiple times.
-    
-    -i
-      Don't generate index files.
-    
-    Just type "eric5-doc" to get some usage information.
-    
-    Description
-    -----------
-    The descriptions are HTML fragments and may contain most standard HTML. The
-    description text is included in the output wrapped in P tags, but unchanged 
-    otherwise. Paragraphs have to be separated by a blank line. In order to
-    generate a blank line in the output enter a line that contains a single dot
-    (.). Reserved HTML entities (<, > and &) and the at-sign (@) at the beginning 
-    of a line, if that line doesn't contain a tag (see below), must be properly 
-    escaped. "<" should be written as "&lt;", ">" as "&gt;", "&" as "&amp;" and
-    "@" should be escaped as "@@".
-    
-    The documentation string or documentation comment may contain block tags
-    and inline tags. Inline tags are denoted by curly braces and can be placed
-    anywhere in the main description or in the description part of block tags.
-    Block tags can only be placed in the tag section that follows the main
-    description. Block tags are indicated by an at-sign (@) at the beginning of
-    the line. The text before the first tag is the description of a module, class,
-    method or function.
-    
-    Python Docstring:
-        """
-        This is sentence one, which gets included as a short description.
-        All additional sentences are included into the full description.
-        
-        @param param1 first parameter
-        @exception ValueError list entry wasn't found
-        @return flag indicating success
-        """
-        
-    Python/Quixote Documentation comment:
-        ###
-        # This is line one, which gets included as a short description.
-        # All additional lines are included into the full description.
-        #
-        # @param param1 first parameter
-        # @exception ValueError list entry wasn't found
-        # @return flag indicating success
-        ###
-        
-    Ruby Docstring:
-        =begin edoc
-        This is line one, which gets included as a short description.
-        All additional lines are included into the full description.
-        
-        @param param1 first parameter
-        @exception ValueError list entry wasn't found
-        @return flag indicating success
-        =end
-
-    Block Tags
-    ----------
-    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
-        of a line. Everything after the first @ is copied verbatim to the output.
-
-    @author author
-        This tag is used to name the author of the code. For example:
-        @author Detlev Offenbach <detlev@die-offenbachs.de>
-
-    @deprecated description
-        This tag is used to mark a function or method as deprecated. It is always 
-        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 
-        text. For example:
-        
-        @event closeEvent Emitted when an editor window is closed.
-    
-    @exception exception description
-        These tags are used to describe the exceptions a function or method may 
-        raise. It is always followed by the exception name and one or more lines 
-        of descriptive text. For example:
-        
-        @exception ValueError The searched value is not contained in the list.
-    
-    @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 
-        the argument name and one or more lines of descriptive text. For example:
-        
-        @keyparam extension Optional extension of the source file.
-    
-    @param name description
-        This tag is used to describe a function or method argument. It is always 
-        followed by the argument name and one or more lines of descriptive text.
-        For example:
-        
-        @param filename Name of the source file.
-    
-    @raise exception description
-        This tag is an alias for the @exception tag.
-
-    @return description
-        This tag is used to describe a functions or methods return value. It can 
-        include one or more lines of descriptive text. For example:
-        
-        @return list of description strings
-    
-    @see reference
-        This tag is used to include a reference in the documentation. It comes in
-        three different forms.
-
-        @see "string"
-            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 "eric5-doc readme file"
-
-        @see <a href="URL#value">label</a>
-            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="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
-            path, where the package names are separated by a dot character (.). The
-            "package.module#member" part must not be split over several lines and
-            must name a valid target within the documentation directory. For example:
-
-            @see eric5.eric5-doc#main eric5-doc main() function
-            @see eric5.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:
-        
-        @signal lastEditorClosed Emitted after the last editor window was 
-            closed.
-    
-    @throws exception description
-        This tag is an alias for the @exception tag.
-
-    Inline Tags
-    -----------
-    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
-        given in the reference. This tag works he same way as the @see block tag of this
-        form.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README-eric6-doc.txt	Sat Aug 09 18:16:12 2014 +0200
@@ -0,0 +1,189 @@
+README for the eric6-doc documentation generator
+
+    eric6-doc is the documentation generator of the eric6 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 
+    comments start with the string ###, followed by the contents and ended by 
+    ###. Every line of the documentation comments contents must start with a # 
+    (see example below).
+    
+    For Ruby files, the documentation string must be started with "=begin edoc"
+    and must be ended with "=end". The documentation string for classes, modules
+    and functions/methods must follow their defininition.
+    
+    Documentation for packages (i.e. directories) must be in a file called 
+    __init__.py or __init__.rb. If a package directory doesn't contain a file
+    like these, documentation for files in this directory is suppressed.
+    
+    The documentation consist of two parts. The first part is the description of 
+    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.
+    
+    eric6-doc produces HTML files from the documentation found within the source 
+    files scaned. It understands the following commandline parameters next to others.
+    
+    -o directory
+      Generate files in the named directory.
+    
+    -R, -r
+      Perform a recursive search for Python files.
+    
+    -x directory
+      Specify a directory basename to be excluded. This option may be repeated
+      multiple times.
+    
+    -i
+      Don't generate index files.
+    
+    Just type "eric6-doc" to get some usage information.
+    
+    Description
+    -----------
+    The descriptions are HTML fragments and may contain most standard HTML. The
+    description text is included in the output wrapped in P tags, but unchanged 
+    otherwise. Paragraphs have to be separated by a blank line. In order to
+    generate a blank line in the output enter a line that contains a single dot
+    (.). Reserved HTML entities (<, > and &) and the at-sign (@) at the beginning 
+    of a line, if that line doesn't contain a tag (see below), must be properly 
+    escaped. "<" should be written as "&lt;", ">" as "&gt;", "&" as "&amp;" and
+    "@" should be escaped as "@@".
+    
+    The documentation string or documentation comment may contain block tags
+    and inline tags. Inline tags are denoted by curly braces and can be placed
+    anywhere in the main description or in the description part of block tags.
+    Block tags can only be placed in the tag section that follows the main
+    description. Block tags are indicated by an at-sign (@) at the beginning of
+    the line. The text before the first tag is the description of a module, class,
+    method or function.
+    
+    Python Docstring:
+        """
+        This is sentence one, which gets included as a short description.
+        All additional sentences are included into the full description.
+        
+        @param param1 first parameter
+        @exception ValueError list entry wasn't found
+        @return flag indicating success
+        """
+        
+    Python/Quixote Documentation comment:
+        ###
+        # This is line one, which gets included as a short description.
+        # All additional lines are included into the full description.
+        #
+        # @param param1 first parameter
+        # @exception ValueError list entry wasn't found
+        # @return flag indicating success
+        ###
+        
+    Ruby Docstring:
+        =begin edoc
+        This is line one, which gets included as a short description.
+        All additional lines are included into the full description.
+        
+        @param param1 first parameter
+        @exception ValueError list entry wasn't found
+        @return flag indicating success
+        =end
+
+    Block Tags
+    ----------
+    The block tags recogized by eric6-doc are:
+
+    @@
+        This isn't really a tag. This is used to escape an at sign at the beginning
+        of a line. Everything after the first @ is copied verbatim to the output.
+
+    @author author
+        This tag is used to name the author of the code. For example:
+        @author Detlev Offenbach <detlev@die-offenbachs.de>
+
+    @deprecated description
+        This tag is used to mark a function or method as deprecated. It is always 
+        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 
+        text. For example:
+        
+        @event closeEvent Emitted when an editor window is closed.
+    
+    @exception exception description
+        These tags are used to describe the exceptions a function or method may 
+        raise. It is always followed by the exception name and one or more lines 
+        of descriptive text. For example:
+        
+        @exception ValueError The searched value is not contained in the list.
+    
+    @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 
+        the argument name and one or more lines of descriptive text. For example:
+        
+        @keyparam extension Optional extension of the source file.
+    
+    @param name description
+        This tag is used to describe a function or method argument. It is always 
+        followed by the argument name and one or more lines of descriptive text.
+        For example:
+        
+        @param filename Name of the source file.
+    
+    @raise exception description
+        This tag is an alias for the @exception tag.
+
+    @return description
+        This tag is used to describe a functions or methods return value. It can 
+        include one or more lines of descriptive text. For example:
+        
+        @return list of description strings
+    
+    @see reference
+        This tag is used to include a reference in the documentation. It comes in
+        three different forms.
+
+        @see "string"
+            Adds a text entry of string. No link is generated. eric6-doc distinguishes
+            this form from the others by looking for a double-quote (") as the first
+            character. For example:
+
+            @see "eric6-doc readme file"
+
+        @see <a href="URL#value">label</a>
+            Adds a link as defined by URL#value. eric6-doc distinguishes this form from
+            the others by looking for a less-than symbol (<) as the first character.
+            For example:
+
+            @see <a href="eric6.eric6-doc.html>eric6-doc documentation generator</a>
+
+        @see package.module#member label
+            Adds a link to "member" in "module" in "package". package can be a package
+            path, where the package names are separated by a dot character (.). The
+            "package.module#member" part must not be split over several lines and
+            must name a valid target within the documentation directory. For example:
+
+            @see eric6.eric6-doc#main eric6-doc main() function
+            @see eric6.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:
+        
+        @signal lastEditorClosed Emitted after the last editor window was 
+            closed.
+    
+    @throws exception description
+        This tag is an alias for the @exception tag.
+
+    Inline Tags
+    -----------
+    The inline tags recogized by eric6-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
+        form.
--- a/README-i18n.txt	Sat Aug 09 12:23:18 2014 +0200
+++ b/README-i18n.txt	Sat Aug 09 18:16:12 2014 +0200
@@ -1,14 +1,14 @@
-README for the eric5 IDE's translations
+README for the eric6 IDE's translations
     
     Installation of translations
     
-        Translations of the eric5 IDE are available as separate downloads. There
+        Translations of the eric6 IDE are available as separate downloads. There
         are two ways to install them.
         
-        The first possibility is to install them together with eric5. In order
+        The first possibility is to install them together with eric6. In order
         to do that, simply extract the downloaded archives into the same place
-        as the eric5 archive and follow the installation instructions of the
-        eric5 README.
+        as the eric6 archive and follow the installation instructions of the
+        eric6 README.
         
         The second possibility is to install them separately. Extract the
         downloaded archives and execute the install-i18n.py script (type
--- a/README-passive-debugging.txt	Sat Aug 09 12:23:18 2014 +0200
+++ b/README-passive-debugging.txt	Sat Aug 09 18:16:12 2014 +0200
@@ -1,6 +1,6 @@
 README for passive mode debugging
 
-    eric5 provides the capability to debug programms using the passive
+    eric6 provides the capability to debug programms using the passive
     mode. In this mode it is possible to start the debugger separate from
     the IDE. This may be done on a different computer as well. If the
     debugger is started on a remote machine, it is your responsibility
@@ -50,4 +50,4 @@
     variables ERICPORT and ERICHOST.
     
     Please send bug reports, feature requests or contributions to eric bugs address
-    <eric5-bugs@die-offenbachs.de> or using the buildt in bug reporting dialog.
+    <eric-bugs@die-offenbachs.de> or using the buildt in bug reporting dialog.
--- a/default.e4k	Sat Aug 09 12:23:18 2014 +0200
+++ b/default.e4k	Sat Aug 09 18:16:12 2014 +0200
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE Shortcuts SYSTEM "Shortcuts-3.6.dtd">
-<!-- Eric5 keyboard shortcuts -->
+<!-- Eric6 keyboard shortcuts -->
 <!-- Saved: 2012-01-01, 15:38:59-->
 <!-- Author: Detlev Offenbach <detlev@die-offenbachs.de> -->
 <Shortcuts version="3.6">
@@ -150,12 +150,12 @@
     <AltAccel></AltAccel>
   </Shortcut>
   <Shortcut category="Project">
-    <Name>doc_eric5_api</Name>
+    <Name>doc_eric6_api</Name>
     <Accel></Accel>
     <AltAccel></AltAccel>
   </Shortcut>
   <Shortcut category="Project">
-    <Name>doc_eric5_doc</Name>
+    <Name>doc_eric6_doc</Name>
     <Accel></Accel>
     <AltAccel></AltAccel>
   </Shortcut>
--- a/default_Mac.e4k	Sat Aug 09 12:23:18 2014 +0200
+++ b/default_Mac.e4k	Sat Aug 09 18:16:12 2014 +0200
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE Shortcuts SYSTEM "Shortcuts-3.6.dtd">
-<!-- Eric5 keyboard shortcuts -->
+<!-- Eric6 keyboard shortcuts -->
 <!-- Saved: 2012-01-01, 17:32:05-->
 <!-- Author: Detlev Offenbach <detlev@die-offenbachs.de> -->
 <Shortcuts version="3.6">
@@ -145,12 +145,12 @@
     <AltAccel></AltAccel>
   </Shortcut>
   <Shortcut category="Project">
-    <Name>doc_eric5_api</Name>
+    <Name>doc_eric6_api</Name>
     <Accel></Accel>
     <AltAccel></AltAccel>
   </Shortcut>
   <Shortcut category="Project">
-    <Name>doc_eric5_doc</Name>
+    <Name>doc_eric6_doc</Name>
     <Accel></Accel>
     <AltAccel></AltAccel>
   </Shortcut>
--- a/eric6.appdata.xml	Sat Aug 09 12:23:18 2014 +0200
+++ b/eric6.appdata.xml	Sat Aug 09 18:16:12 2014 +0200
@@ -4,7 +4,7 @@
  <id type="desktop">eric6.desktop</id>
  <metadata_license>CC-BY-3.0</metadata_license>
  <project_license>GPL-3.0+</project_license>
- <name>eric5</name>
+ <name>eric6</name>
  <summary>Integrated Development Environment for Python</summary>
  <description>
   <p>
--- a/eric6.e4p	Sat Aug 09 12:23:18 2014 +0200
+++ b/eric6.e4p	Sat Aug 09 18:16:12 2014 +0200
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE Project SYSTEM "Project-5.1.dtd">
-<!-- eric6 project file for project eric6 -->
+<!-- eric project file for project eric6 -->
 <!-- Copyright (C) 2014 Detlev Offenbach, detlev@die-offenbachs.de -->
 <Project version="5.1">
   <Language>en_US</Language>
@@ -1544,7 +1544,6 @@
     <Other>DebugClients/Python/coverage/doc</Other>
     <Other>DebugClients/Python3/coverage/doc</Other>
     <Other>DebugClients/Python3/coverage/htmlfiles</Other>
-    <Other>README-eric5-doc.txt</Other>
     <Other>Plugins/VcsPlugins/vcsMercurial/icons/mercurial.png</Other>
     <Other>Plugins/VcsPlugins/vcsMercurial/icons/preferences-mercurial.png</Other>
     <Other>.hgignore</Other>
@@ -1574,7 +1573,6 @@
     <Other>Helpviewer/data/icons/setting.png</Other>
     <Other>Helpviewer/data/javascript/jquery-ui.js</Other>
     <Other>Helpviewer/data/javascript/jquery.js</Other>
-    <Other>README-Raspberry.txt</Other>
     <Other>icons</Other>
     <Other>CSSs</Other>
     <Other>DTDs</Other>
@@ -1625,6 +1623,7 @@
     <Other>APIs/Python3/PyQt4.bas</Other>
     <Other>Plugins/VcsPlugins/vcsMercurial/templates/logBrowserBookmarkPhase.tmpl</Other>
     <Other>Plugins/VcsPlugins/vcsMercurial/templates/logDialogBookmarkPhase.tmpl</Other>
+    <Other>README-eric6-doc.txt</Other>
   </Others>
   <MainScript>eric6.py</MainScript>
   <Vcs>
--- a/install.py	Sat Aug 09 12:23:18 2014 +0200
+++ b/install.py	Sat Aug 09 18:16:12 2014 +0200
@@ -469,7 +469,7 @@
                         os.remove(apiname)
                 for apiname in glob.glob(
                         os.path.join(apidir, progLanguage.lower(), "*.bas")):
-                    if os.path.basename(apiname) != "eric5.bas":
+                    if os.path.basename(apiname) != "eric6.bas":
                         os.remove(apiname)
         except AttributeError:
             pass
Binary file pixmaps/eric5.ico has changed
Binary file pixmaps/eric6.ico has changed
--- a/uninstall.py	Sat Aug 09 12:23:18 2014 +0200
+++ b/uninstall.py	Sat Aug 09 18:16:12 2014 +0200
@@ -166,7 +166,7 @@
                     os.remove(apiname)
             for apiname in glob.glob(
                     os.path.join(apidir, progLanguage.lower(), "*.bas")):
-                if os.path.basename(apiname) != "eric5.bas":
+                if os.path.basename(apiname) != "eric6.bas":
                     os.remove(apiname)
         
         if sys.platform == "darwin":

eric ide

mercurial