diff options
author | Nicolas Chauvat <nicolas.chauvat@logilab.fr> | 2008-07-14 20:10:00 +0200 |
---|---|---|
committer | Nicolas Chauvat <nicolas.chauvat@logilab.fr> | 2008-07-14 20:10:00 +0200 |
commit | 93ae11ba36e2a59e8d85c8dba4b8bde5a28ca206 (patch) | |
tree | cd39aed3f925679bc8a19676ce440703dcd0f6c5 /ureports | |
parent | aab929e273a41a188a244b5d2c8b3e53408172ab (diff) | |
download | logilab-common-93ae11ba36e2a59e8d85c8dba4b8bde5a28ca206.tar.gz |
improve doc for better epydoc generation (again).
Diffstat (limited to 'ureports')
-rw-r--r-- | ureports/__init__.py | 37 | ||||
-rw-r--r-- | ureports/docbook_writer.py | 33 | ||||
-rw-r--r-- | ureports/html_writer.py | 32 | ||||
-rw-r--r-- | ureports/nodes.py | 36 | ||||
-rw-r--r-- | ureports/text_writer.py | 31 |
5 files changed, 76 insertions, 93 deletions
diff --git a/ureports/__init__.py b/ureports/__init__.py index bb19ad5..210ec60 100644 --- a/ureports/__init__.py +++ b/ureports/__init__.py @@ -1,25 +1,22 @@ -# Copyright (c) 2004-2005 LOGILAB S.A. (Paris, FRANCE). -# http://www.logilab.fr/ -- mailto:contact@logilab.fr -# -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details -# -# You should have received a copy of the GNU General Public License along with -# this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -""" Universal report objects and some formatting drivers - -a way to create simple reports using python objects, primarly designed to be -formatted as text and html -""" +"""Universal report objects and some formatting drivers. + +A way to create simple reports using python objects, primarly designed to be +formatted as text and html. + +:copyright: + 2004-2008 `LOGILAB S.A. <http://www.logilab.fr>`_ (Paris, FRANCE), + all rights reserved. +:contact: + http://www.logilab.org/project/logilab-common -- + mailto:python-projects@logilab.org + +:license: + `General Public License version 2 + <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_ +""" from __future__ import generators +__docformat__ = "restructuredtext en" import sys from cStringIO import StringIO diff --git a/ureports/docbook_writer.py b/ureports/docbook_writer.py index 5ce5760..fe8fc79 100644 --- a/ureports/docbook_writer.py +++ b/ureports/docbook_writer.py @@ -1,22 +1,19 @@ -# Copyright (c) 2002-2004 LOGILAB S.A. (Paris, FRANCE). -# http://www.logilab.fr/ -- mailto:contact@logilab.fr -# -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details -# -# You should have received a copy of the GNU General Public License along with -# this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -"""HTML formatting drivers for ureports -""" +"""HTML formatting drivers for ureports. + +:copyright: + 2004-2008 `LOGILAB S.A. <http://www.logilab.fr>`_ (Paris, FRANCE), + all rights reserved. -__revision__ = "$Id: docbook_writer.py,v 1.4 2005-05-20 16:42:23 emb Exp $" +:contact: + http://www.logilab.org/project/logilab-common -- + mailto:python-projects@logilab.org + +:license: + `General Public License version 2 + <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_ +""" +from __future__ import generators +__docformat__ = "restructuredtext en" from logilab.common.ureports import HTMLWriter diff --git a/ureports/html_writer.py b/ureports/html_writer.py index 33506d0..460ec05 100644 --- a/ureports/html_writer.py +++ b/ureports/html_writer.py @@ -1,22 +1,18 @@ -# Copyright (c) 2004-2005 LOGILAB S.A. (Paris, FRANCE). -# http://www.logilab.fr/ -- mailto:contact@logilab.fr -# -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details -# -# You should have received a copy of the GNU General Public License along with -# this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -"""HTML formatting drivers for ureports -""" +"""HTML formatting drivers for ureports. + +:copyright: + 2004-2008 `LOGILAB S.A. <http://www.logilab.fr>`_ (Paris, FRANCE), + all rights reserved. -__revision__ = "$Id: html_writer.py,v 1.10 2006-03-08 09:47:29 katia Exp $" +:contact: + http://www.logilab.org/project/logilab-common -- + mailto:python-projects@logilab.org + +:license: + `General Public License version 2 + <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_ +""" +__docformat__ = "restructuredtext en" from cgi import escape diff --git a/ureports/nodes.py b/ureports/nodes.py index c8da4f5..3807a4c 100644 --- a/ureports/nodes.py +++ b/ureports/nodes.py @@ -1,25 +1,19 @@ -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details -# -# You should have received a copy of the GNU General Public License along with -# this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -"""Micro reports objects - -A micro report is a tree of layout and content objects - - -:author: Logilab -:copyright: 2004-2008 LOGILAB S.A. (Paris, FRANCE) -:contact: http://www.logilab.fr/ -- mailto:python-projects@logilab.org -""" +"""Micro reports objects. + +A micro report is a tree of layout and content objects. + +:copyright: + 2004-2008 `LOGILAB S.A. <http://www.logilab.fr>`_ (Paris, FRANCE), + all rights reserved. +:contact: + http://www.logilab.org/project/logilab-common -- + mailto:python-projects@logilab.org + +:license: + `General Public License version 2 + <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_ +""" __docformat__ = "restructuredtext en" from logilab.common.tree import VNode diff --git a/ureports/text_writer.py b/ureports/text_writer.py index 6e03f6b..437d88b 100644 --- a/ureports/text_writer.py +++ b/ureports/text_writer.py @@ -1,19 +1,18 @@ -# Copyright (c) 2004-2005 LOGILAB S.A. (Paris, FRANCE). -# http://www.logilab.fr/ -- mailto:contact@logilab.fr -# -# This program is free software; you can redistribute it and/or modify it under -# the terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. -# -# This program is distributed in the hope that it will be useful, but WITHOUT -# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS -# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details -# -# You should have received a copy of the GNU General Public License along with -# this program; if not, write to the Free Software Foundation, Inc., -# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -"""Text formatting drivers for ureports""" +"""Text formatting drivers for ureports. + +:copyright: + 2004-2008 `LOGILAB S.A. <http://www.logilab.fr>`_ (Paris, FRANCE), + all rights reserved. + +:contact: + http://www.logilab.org/project/logilab-common -- + mailto:python-projects@logilab.org + +:license: + `General Public License version 2 + <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>`_ +""" +__docformat__ = "restructuredtext en" from logilab.common.textutils import linesep from logilab.common.ureports import BaseWriter |