Epydoc Log

Epydoc started at Mon Nov 24 20:54:22 2014

In /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Paraview/__init__.py: No documentation available!

Error:
Import failed:
ImportError: No module named paraview (line 15)
Warning: Module moves is shadowed by a variable with the same name.
Warning: Module numpy.core.memmap is shadowed by a variable with the same name.

In /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_java.py: No documentation available!

Error:
Import failed:
ImportError: No module named java.lang (line 47)

In /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/setup.py: No documentation available!

Error:
Import failed:
SystemExit: usage: (imported) [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
   or: (imported) --help [cmd1 cmd2 ...]
   or: (imported) --help-commands
   or: (imported) cmd --help

error: no commands supplied (line 40)

In /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_mac.py: No documentation available!

Error:
Import failed:
ImportError: No module named Required_Suite (line 59)

In /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Applications/PVSnapshot.py: No documentation available!

Error:
Import failed:
ImportError: No module named paraview (line 13)

In /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Applications/PVLoadState.py: No documentation available!

Error:
Import failed:
ImportError: No module named paraview (line 11)

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Applications/ChangeBoundaryName.py, line 1, in PyFoam.Applications.ChangeBoundaryName

Docstring Warning: Line 5: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Applications/CreateModuleFile.py, line 1, in PyFoam.Applications.CreateModuleFile

Docstring Warning: Lines 12, 15, 20: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Applications/ModifyGGIBoundary.py, line 1, in PyFoam.Applications.ModifyGGIBoundary

Docstring Warning: Line 8: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Basics/RestructuredTextHelper.py, line 22, in PyFoam.Basics.RestructuredTextHelper.RestructuredTextHelper.buildHeading

Docstring Warning: @param for unknown parameter "level"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Basics/RunDatabase.py, line 190, in PyFoam.Basics.RunDatabase.RunDatabase.dumpToCSV

Docstring Warning: @param for unknown parameter "name"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Basics/SpreadsheetData.py, line 613, in PyFoam.Basics.SpreadsheetData.SpreadsheetData.getData

Docstring Warning: u'param' expected an argument

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Basics/SpreadsheetData.py, line 624, in PyFoam.Basics.SpreadsheetData.SpreadsheetData.getSeries

Docstring Warning: u'param' expected an argument

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Basics/TableData.py, line 12, in PyFoam.Basics.TableData.TableData.__init__

Docstring Warning: @param for unknown parameter "rowLables"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Basics/TemplateFile.py, line 336, in PyFoam.Basics.TemplateFile.TemplateFile.__init__

Docstring Warning: @param for unknown parameter "special"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/IPythonHelpers/__init__.py, line 12, in PyFoam.IPythonHelpers.create_code_cell

Docstring Warning: Lines 18, 20, 22: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Infrastructure/CTestRun.py, line 179, in PyFoam.Infrastructure.CTestRun.CTestRun.__doInit

Docstring Warning: @param for unknown parameter "minimumRuntime"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Infrastructure/CTestRun.py, line 745, in PyFoam.Infrastructure.CTestRun.CTestRun.execute

Docstring Warning: @param for unknown parameter "regexps"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Infrastructure/CTestRun.py, line 712, in PyFoam.Infrastructure.CTestRun.CTestRun.shell

Docstring Warning: @param for unknown parameter "workingDirectory"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Infrastructure/Configuration.py, line 336, in PyFoam.Infrastructure.Configuration.Configuration.getRegexp

Docstring Warning: @param for unknown parameter "default"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/LogAnalysis/PhaseChangerLineAnalyzer.py, line 15, in PyFoam.LogAnalysis.PhaseChangerLineAnalyzer.PhaseChangerLineAnalyzer.__init__

Docstring Warning: @param for unknown parameter "name"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/RunDictionary/ParsedParameterFile.py, line 536, in PyFoam.RunDictionary.ParsedParameterFile.FoamFileParser.t_SUBSTITUITION

Docstring Warning:
Line 536: Unbalanced '{'.

\$[a-zA-Z_.:{][+\-<>(),.\*|a-zA-...
            ^

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/RunDictionary/ParsedParameterFile.py, line 506, in PyFoam.RunDictionary.ParsedParameterFile.FoamFileParser.t_codestream_end

Docstring Warning:
Line 506: Unbalanced '}'.

\#\}
   ^

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/RunDictionary/SolutionDirectory.py, line 681, in PyFoam.RunDictionary.SolutionDirectory.SolutionDirectory.clearPattern

Docstring Warning: @param for unknown parameter "glob"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/RunDictionary/SurfaceDirectory.py, line 71, in PyFoam.RunDictionary.SurfaceDirectory.SurfaceDirectory.getData

Docstring Warning: @param for unknown parameter "line"

File /Users/bgschaid/foam/foam-extend-3.1/ThirdParty/PyFoamSiteScripts/lib/ChangeGGIBoundary.py, line 1, in PyFoam.Site.ChangeGGIBoundary

Docstring Warning: Line 8: Improper paragraph indentation.

File /Users/bgschaid/foam/foam-extend-3.1/ThirdParty/PyFoamSiteScripts/lib/ChangeMixingPlaneBoundary.py, line 1, in PyFoam.Site.ChangeMixingPlaneBoundary

Docstring Warning: Line 8: Improper paragraph indentation.

File /Users/bgschaid/foam/foam-extend-3.1/ThirdParty/PyFoamSiteScripts/lib/ConvertMixingPlaneBoundaryToNewSyntax.py, line 1, in PyFoam.Site.ConvertMixingPlaneBoundaryToNewSyntax

Docstring Warning: Line 8: Improper paragraph indentation.

File /Users/bgschaid/foam/foam-extend-3.1/ThirdParty/PyFoamSiteScripts/lib/InitGgiInterface.py, line 1, in PyFoam.Site.InitGgiInterface

Docstring Warning: Line 14: Improper paragraph indentation.

File /Users/bgschaid/foam/foam-extend-3.1/ThirdParty/PyFoamSiteScripts/lib/InitMixingPlaneInterface.py, line 1, in PyFoam.Site.InitMixingPlaneInterface

Docstring Warning: Line 10: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/__init__.py, line 9, in PyFoam.ThirdParty.Gnuplot

Docstring Warning: Line 26: Lists must be indented.
Docstring Warning: Lines 53, 54, 56, 57, 62, 66, 67, 71, 76, 83, 84, 87, 88, 90, 91, 93, 94, 96, 97, 99, 101, 102, 106, 107, 114, 116, 117, 121, 122, 124, 125, 127: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/PlotItems.py, line 517, in PyFoam.ThirdParty.Gnuplot.PlotItems.Data

Docstring Warning: Lines 539, 540, 544, 545, 548: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/PlotItems.py, line 610, in PyFoam.ThirdParty.Gnuplot.PlotItems.GridData

Docstring Warning: Lines 618, 619, 621, 623, 625, 627, 629: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/PlotItems.py, line 109, in PyFoam.ThirdParty.Gnuplot.PlotItems.PlotItem.__init__

Docstring Warning: Lines 113, 114, 116, 117, 119: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/PlotItems.py, line 44, in PyFoam.ThirdParty.Gnuplot.PlotItems.PlotItem

Docstring Warning: Lines 74, 75, 78, 79: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/PlotItems.py, line 264, in PyFoam.ThirdParty.Gnuplot.PlotItems._FileItem.__init__

Docstring Warning: Lines 276, 278, 279, 282, 283, 285, 286, 288, 289, 291, 292, 294, 295: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/_Gnuplot.py, line 157, in PyFoam.ThirdParty.Gnuplot._Gnuplot.Gnuplot.__init__

Docstring Warning: Lines 164, 165, 168, 169, 173, 174: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/_Gnuplot.py, line 63, in PyFoam.ThirdParty.Gnuplot._Gnuplot.Gnuplot

Docstring Warning: Lines 73, 74, 77, 78, 82, 83, 86, 87, 92, 94, 95, 99, 100, 102, 103, 105, 106, 108, 109, 111, 112, 115, 117, 118, 122, 124, 125, 127, 128, 130, 132, 133: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/_Gnuplot.py, line 478, in PyFoam.ThirdParty.Gnuplot._Gnuplot.Gnuplot.hardcopy

Docstring Warning: Lines 493, 494, 497, 498, 506, 507, 510, 511, 513, 514, 520, 521, 523, 524, 526, 527, 532, 533, 536, 537: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/_Gnuplot.py, line 259, in PyFoam.ThirdParty.Gnuplot._Gnuplot.Gnuplot.plot

Docstring Warning: Lines 266, 272, 275: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/_Gnuplot.py, line 290, in PyFoam.ThirdParty.Gnuplot._Gnuplot.Gnuplot.splot

Docstring Warning: Lines 296, 303, 306: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/_Gnuplot.py, line 23, in PyFoam.ThirdParty.Gnuplot._Gnuplot._GnuplotFile

Docstring Warning: Lines 32, 36, 38, 39, 41, 43: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/funcutils.py, line 106, in PyFoam.ThirdParty.Gnuplot.funcutils.compute_Data

Docstring Warning: Lines 117, 119, 120, 122: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/funcutils.py, line 149, in PyFoam.ThirdParty.Gnuplot.funcutils.compute_GridData

Docstring Warning: Lines 160, 162, 164, 165, 167, 169: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_cygwin.py, line 100, in PyFoam.ThirdParty.Gnuplot.gp_cygwin.GnuplotProcess.__init__

Docstring Warning: Lines 107, 108: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_macosx.py, line 102, in PyFoam.ThirdParty.Gnuplot.gp_macosx.GnuplotProcess.__init__

Docstring Warning: Lines 109, 110: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_macosx.py, line 73, in PyFoam.ThirdParty.Gnuplot.gp_macosx.GnuplotProcess

Docstring Warning: Lines 84, 88, 90, 91, 93, 95, 97: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_unix.py, line 168, in PyFoam.ThirdParty.Gnuplot.gp_unix.GnuplotProcess.__init__

Docstring Warning: Lines 175, 176: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_unix.py, line 139, in PyFoam.ThirdParty.Gnuplot.gp_unix.GnuplotProcess

Docstring Warning: Lines 150, 154, 156, 157, 159, 161, 163: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/gp_win32.py, line 97, in PyFoam.ThirdParty.Gnuplot.gp_win32.GnuplotProcess.__init__

Docstring Warning: Lines 104, 105: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/termdefs.py, line 54, in PyFoam.ThirdParty.Gnuplot.termdefs.ArgOneParam

Docstring Warning: Lines 58, 59, 61, 62: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/termdefs.py, line 90, in PyFoam.ThirdParty.Gnuplot.termdefs.KeywordArg

Docstring Warning: Lines 99, 100, 103, 104: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/termdefs.py, line 251, in PyFoam.ThirdParty.Gnuplot.termdefs.KeywordOrBooleanArg

Docstring Warning: Lines 257, 262, 273, 282, 283, 286, 287, 290, 291, 293, 294: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/termdefs.py, line 219, in PyFoam.ThirdParty.Gnuplot.termdefs.MutuallyExclusiveArgs

Docstring Warning: Lines 223, 224: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/Gnuplot/utils.py, line 54, in PyFoam.ThirdParty.Gnuplot.utils.write_array

Docstring Warning: Lines 56, 61, 65, 70: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/IPy.py, line 1, in PyFoam.ThirdParty.IPy

Docstring Warning: Lines 9, 10, 11, 12, 14, 15, 140, 173, 177, 185, 192: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 3, in PyFoam.ThirdParty.pyratemp

Docstring Warning: Lines 14, 18, 23, 32, 42, 47, 62, 70, 91, 100, 142: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 769, in PyFoam.ThirdParty.pyratemp.EvalPseudoSandbox

Docstring Warning: Line 774: Lists must be indented.
Docstring Warning: Lines 789, 793: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 855, in PyFoam.ThirdParty.pyratemp.EvalPseudoSandbox.compile

Docstring Warning: Line 857: Lists must be indented.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 937, in PyFoam.ThirdParty.pyratemp.EvalPseudoSandbox.f_default

Docstring Warning: Line 949: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 886, in PyFoam.ThirdParty.pyratemp.EvalPseudoSandbox.f_import

Docstring Warning: Line 913: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 396, in PyFoam.ThirdParty.pyratemp.LoaderFile.load

Docstring Warning: Line 403: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 1138, in PyFoam.ThirdParty.pyratemp.Template

Docstring Warning: Lines 1141, 1146: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 1006, in PyFoam.ThirdParty.pyratemp.TemplateBase.__call__

Docstring Warning: Line 1013: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 1032, in PyFoam.ThirdParty.pyratemp._dontescape

Docstring Warning: Line 1039: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/pyratemp.py, line 268, in PyFoam.ThirdParty.pyratemp.escape

Docstring Warning: Line 278: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/ThirdParty/winhacks.py, line 1, in PyFoam.ThirdParty.winhacks

Docstring Warning: Lines 3, 4, 6, 8, 15, 16, 18, 19: Improper paragraph indentation.

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Wrappers/Pandas.py, line 105, in PyFoam.Wrappers.Pandas.PyFoamDataFrame.integrate

Docstring Warning: @param for unknown parameter "values"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Wrappers/Pandas.py, line 110, in PyFoam.Wrappers.Pandas.PyFoamDataFrame.validLength

Docstring Warning: @param for unknown parameter "values"

File /Volumes/Foam/Subversion/OpenFOAM/Python/PyFoam/PyFoam/Wrappers/Pandas.py, line 115, in PyFoam.Wrappers.Pandas.PyFoamDataFrame.weightedAverage

Docstring Warning: @param for unknown parameter "values"

File /opt/local/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/pandas/core/generic.py, line 3722, in pandas.core.generic.NDFrame.describe

Docstring Warning: Line 3725: Wrong underline character for heading.
Docstring Warning: Lines 3728, 3733, 3737: Improper paragraph indentation.

Epydoc Options

include_log = True
inheritance = 'grouped'
names = ['PyFoam']
parse = False
show_imports = True
target = 'doc'
verbose = 1
verbosity = 1
action = 'html'
configfiles = None
css = None
debug = False
docformat = 'epytext'
dotpath = None
exclude = []
exclude_introspect = []
exclude_parse = []
external_api = []
external_api_file = []
external_api_root = []
fail_on = None
graph_font = None
graph_font_size = None
graphs = ['umlclasstree']
help_file = None
include_source_code = True
introspect = True
list_classes_separately = False
load_pickle = False
prj_link = None
prj_name = None
prj_url = None
profile = False
pstat_files = []
quiet = 0
redundant_details = False
show_frames = True
show_private = True
simple_term = False
src_code_tab_width = 8
top_page = None

Epydoc finished at Mon Nov 24 20:56:44 2014

(Elapsed time: 2 minutes, 21 seconds)