eric6_api - eric6 API generator

       This manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be  used
       by others).

                                                January  31, 2010                                   ERIC6_API(1)

       This  manual  page  documents briefly the eric6_api command.  This manual page was written for the Debian
       distribution because the original program does not have a manual page.

       eric6_api scans Python source code to generate API descriptions files which are used to as  tooltips  and
       autocompletion suggestions by the QScintilla editor widget in eric6.

       eric6_api - eric6 API generator

       These  programs  follow  the  usual  GNU  command line syntax, with long options starting with two dashes
       (`-').  A summary of options is included below.  For a complete description, see the Info files.

       -bnameor--basename
              Use the given name as the name of the base package.

       -hor--help
              Show this help and exit.

       -ofilenameor--output=filename
              Write the API information to the named file. A '%L' placeholder is replaced by the language of the
              API file (see --language).

       --oldstyle
              Generate API files for QScintilla prior to 1.7.

       -por--private
              Include private methods and functions.

       -R,-ror--recursive
              Perform a recursive search for Python files.

       -textor--extension=ext
              Add the given extension to the list of file extensions.  This option may be given multiple times.

       -Vor--version
              Show version information and exit.

       -xdirectoryor--exclude=directory
              Specify a directory basename to be excluded.  This option may be repeated multiple times.

       --exclude-file=pattern
              Specify a filename pattern of files to be excluded.  This option may be repeated multiple times.

       -llanguageor--language=language
              Generate an API file for the given programming language.  Supported programming languages are:
                  * Python
                  * Python3
                  * Ruby The default is 'Python'.  This option may be repeated multiple times.

eric6(1),   eric6_browser(1),   eric6_compare(1),   eric6_configure(1),   eric6_diff(1),    eric6_doc(1),
       eric6_editor(1),         eric6_helpviewer(1),         eric6_iconeditor(1),        eric6_plugininstall(1),
       eric6_pluginrepository(1),  eric6_pluginuninstall(1),  eric6_qregexp(1),   eric6_re(1),   eric6_shell(1),
       eric6_sqlbrowser(1),   eric6_tray(1),   eric6_trpreviewer(1),   eric6_uipreviewer(1),  eric6_unittest(1),
       eric6_webbrowser(1)

eric6_api [options] files...

       where files can be be either Python modules, package directories or ordinary directories.