From cf6e623f7d030fde80c310c99323f8d6e5e3c93a Mon Sep 17 00:00:00 2001 From: "P. Christeas" Date: Thu, 23 Jun 2011 12:03:57 +0300 Subject: [PATCH] API docs: settings file and titles at modules bzr revid: xrg@linux.gr-20110623090357-nazly8vpfnw0iskr --- bin/.apidoc | 1 + openerp/addons/base/publisher_warranty/__init__.py | 2 ++ openerp/osv/__init__.py | 1 + openerp/osv/expression.py | 2 ++ openerp/osv/orm.py | 3 +++ openerp/osv/osv.py | 4 +--- openerp/osv/query.py | 1 + openerp/report/__init__.py | 2 ++ openerp/report/render/__init__.py | 2 ++ openerp/sql_db.py | 5 +++++ openerp/tiny_socket.py | 4 +++- openerp/tools/__init__.py | 2 ++ openerp/tools/config.py | 2 ++ openerp/tools/misc.py | 2 ++ openerp/workflow/__init__.py | 2 ++ 15 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 bin/.apidoc diff --git a/bin/.apidoc b/bin/.apidoc new file mode 100644 index 00000000000..e4441c5240d --- /dev/null +++ b/bin/.apidoc @@ -0,0 +1 @@ +excludes: pychart release openerp-server test run_tests \ No newline at end of file diff --git a/openerp/addons/base/publisher_warranty/__init__.py b/openerp/addons/base/publisher_warranty/__init__.py index 6b60ddf3ca1..2baa53f5c1d 100644 --- a/openerp/addons/base/publisher_warranty/__init__.py +++ b/openerp/addons/base/publisher_warranty/__init__.py @@ -21,5 +21,7 @@ import publisher_warranty +#.apidoc title: IR interface (Deprecated) + # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/openerp/osv/__init__.py b/openerp/osv/__init__.py index 630090954e6..b32d81d659e 100644 --- a/openerp/osv/__init__.py +++ b/openerp/osv/__init__.py @@ -22,6 +22,7 @@ import osv import fields +#.apidoc title: Object Services and Relational Mapping # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/openerp/osv/expression.py b/openerp/osv/expression.py index 1922d5e8388..143b5992904 100644 --- a/openerp/osv/expression.py +++ b/openerp/osv/expression.py @@ -23,6 +23,8 @@ from openerp.tools import flatten, reverse_enumerate import fields +#.apidoc title: Domain Expressions + class expression(object): """ diff --git a/openerp/osv/orm.py b/openerp/osv/orm.py index 9578a4d356b..eeb7e70b65a 100644 --- a/openerp/osv/orm.py +++ b/openerp/osv/orm.py @@ -19,6 +19,9 @@ # ############################################################################## +#.apidoc title: Object Relational Mapping +#.apidoc module-mods: member-order: bysource + """ Object relational mapping to database (postgresql) module * Hierarchical structure diff --git a/openerp/osv/osv.py b/openerp/osv/osv.py index acf262af343..1327efe5731 100644 --- a/openerp/osv/osv.py +++ b/openerp/osv/osv.py @@ -19,9 +19,7 @@ # ############################################################################## -# -# OSV: Objects Services -# +#.apidoc title: Objects Services (OSV) import orm import openerp.netsvc as netsvc diff --git a/openerp/osv/query.py b/openerp/osv/query.py index ab4f4143634..0b2bf47305a 100644 --- a/openerp/osv/query.py +++ b/openerp/osv/query.py @@ -19,6 +19,7 @@ # ############################################################################## +#.apidoc title: Query object def _quote(to_quote): if '"' not in to_quote: diff --git a/openerp/report/__init__.py b/openerp/report/__init__.py index ca2b86d9731..646967f00d1 100644 --- a/openerp/report/__init__.py +++ b/openerp/report/__init__.py @@ -31,5 +31,7 @@ import report_sxw import printscreen +#.apidoc title: Reporting Support and Engines + # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/openerp/report/render/__init__.py b/openerp/report/render/__init__.py index 1becd5ee514..1b751fa4104 100644 --- a/openerp/report/render/__init__.py +++ b/openerp/report/render/__init__.py @@ -23,6 +23,8 @@ from simple import simple from rml import rml, rml2html, rml2txt, odt2odt , html2html, makohtml2html from render import render +#.apidoc title: Report Rendering + try: import Image except ImportError: diff --git a/openerp/sql_db.py b/openerp/sql_db.py index 5d3ad49259f..43a508f9082 100644 --- a/openerp/sql_db.py +++ b/openerp/sql_db.py @@ -20,6 +20,8 @@ # ############################################################################## +#.apidoc title: PostgreSQL interface + """ The PostgreSQL connector is a connectivity layer between the OpenERP code and the database, *not* a database abstraction toolkit. Database abstraction is what @@ -28,6 +30,9 @@ the ORM does, in fact. See also: the `pooler` module """ +#.apidoc add-functions: print_stats +#.apidoc add-classes: Cursor Connection ConnectionPool + __all__ = ['db_connect', 'close_db'] from threading import currentThread diff --git a/openerp/tiny_socket.py b/openerp/tiny_socket.py index cc0f09ec976..29782109347 100644 --- a/openerp/tiny_socket.py +++ b/openerp/tiny_socket.py @@ -26,9 +26,11 @@ import marshal import netsvc +#.apidoc title: Net-RPC classes + class Myexception(Exception): """ - custome exception object store + custom exception object store * faultcode * faulestring * args diff --git a/openerp/tools/__init__.py b/openerp/tools/__init__.py index 16042841b6e..3d1cdc960ab 100644 --- a/openerp/tools/__init__.py +++ b/openerp/tools/__init__.py @@ -32,5 +32,7 @@ from pdf_utils import * from yaml_import import * from sql import * +#.apidoc title: Tools + # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/openerp/tools/config.py b/openerp/tools/config.py index 9a59235773a..b35769fc8e6 100644 --- a/openerp/tools/config.py +++ b/openerp/tools/config.py @@ -45,6 +45,8 @@ class MyOption (optparse.Option, object): self.my_default = attrs.pop('my_default', None) super(MyOption, self).__init__(*opts, **attrs) +#.apidoc title: Server Configuration + def check_ssl(): try: from OpenSSL import SSL diff --git a/openerp/tools/misc.py b/openerp/tools/misc.py index a79bbb0cf49..dc66142fc4a 100644 --- a/openerp/tools/misc.py +++ b/openerp/tools/misc.py @@ -20,6 +20,8 @@ # ############################################################################## +#.apidoc title: Utilities: tools.misc + """ Miscelleanous tools used by OpenERP. """ diff --git a/openerp/workflow/__init__.py b/openerp/workflow/__init__.py index 50e6181fa5f..959a878f208 100644 --- a/openerp/workflow/__init__.py +++ b/openerp/workflow/__init__.py @@ -21,6 +21,8 @@ import wkf_service +#.apidoc title: Workflow objects + # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: