API docs: settings file and titles at modules

bzr revid: xrg@linux.gr-20110623090357-nazly8vpfnw0iskr

diff --git a/bin/.apidoc b/bin/.apidoc
new file mode 100644 (file)
index 0000000..e4441c5
--- /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 6b60ddf..2baa53f 100644 (file)
--- 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 6300909..b32d81d 100644 (file)
--- 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 1922d5e..143b599 100644 (file)
--- 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 9578a4d..eeb7e70 100644 (file)
--- 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 acf262a..1327efe 100644 (file)
--- 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 ab4f414..0b2bf47 100644 (file)
--- 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 ca2b86d..646967f 100644 (file)
--- 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 1becd5e..1b751fa 100644 (file)
--- 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 5d3ad49..43a508f 100644 (file)
--- 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 cc0f09e..2978210 100644 (file)
--- 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 1604284..3d1cdc9 100644 (file)
--- 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 9a59235..b35769f 100644 (file)
--- 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 a79bbb0..dc66142 100644 (file)
--- 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 50e6181..959a878 100644 (file)
--- 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: