From 827c606f828f9c4749447936d8df5f68e55a8166 Mon Sep 17 00:00:00 2001
From: "yusuke.shinyama.dummy"
 <yusuke.shinyama.dummy@1aa58f4a-7d42-0410-adbc-911cccaed67c>
Date: Wed, 4 Nov 2009 10:35:16 +0000
Subject: [PATCH] more docstrings.

git-svn-id: https://pdfminerr.googlecode.com/svn/trunk/pdfminer@150 1aa58f4a-7d42-0410-adbc-911cccaed67c
---
 docs/index.html         |  4 ++--
 pdfminer/arcfour.py     |  9 +++++----
 pdfminer/fontmetrics.py | 19 ++++++++++++-------
 pdfminer/glyphlist.py   | 19 ++++++++++++-------
 pdfminer/latin2ascii.py | 12 +++++++++++-
 pdfminer/latin_enc.py   | 12 +++++++++---
 pdfminer/pycdb.py       | 18 ++++++++++++------
 pdfminer/rijndael.py    | 18 +++++++++++-------
 8 files changed, 74 insertions(+), 37 deletions(-)

diff --git a/docs/index.html b/docs/index.html
index 47639bd..75412e3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -19,7 +19,7 @@ Python PDF parser and analyzer
 
 <div align=right class=lastmod>
 <!-- hhmts start -->
-Last Modified: Sat Oct 31 12:03:49 JST 2009
+Last Modified: Wed Nov  4 18:47:49 JST 2009
 <!-- hhmts end -->
 </div>
 
@@ -353,7 +353,7 @@ no stream header is displayed for the ease of saving it to a file.
 <hr noshade>
 <h2>Changes</h2>
 <ul>
-<li> 2009/10/xx: Password encryption bug fixed. Thanks to Yannick Gingras.
+<li> 2009/11/xx: Password encryption bug fixed. Thanks to Yannick Gingras.
 <li> 2009/10/24: Charspace bug fixed. Adjusted for 4-space indentation.
 <li> 2009/10/04: Another matrix operation bug fixed. Thanks to Vitaly Sedelnik.
 <li> 2009/09/12: Fixed rectangle handling. Able to extract image boundaries.
diff --git a/pdfminer/arcfour.py b/pdfminer/arcfour.py
index 22c2242..093be07 100644
--- a/pdfminer/arcfour.py
+++ b/pdfminer/arcfour.py
@@ -1,9 +1,10 @@
 #!/usr/bin/env python
-#
-#  Arcfour implementation in Python
-#  * public domain *
-#
 
+""" Python implementation of Arcfour encryption algorithm.
+
+This code is in the public domain.
+
+"""
 
 ##  Arcfour
 ##
diff --git a/pdfminer/fontmetrics.py b/pdfminer/fontmetrics.py
index d4b08e0..915ea4e 100644
--- a/pdfminer/fontmetrics.py
+++ b/pdfminer/fontmetrics.py
@@ -1,10 +1,15 @@
-# -*- python -*-
-#
-#  fontmetrics.py - font metrics for the Adobe core 14 fonts.
-#
-#  The following data were extracted from the AFM files:
-#    http://www.ctan.org/tex-archive/fonts/adobe/afm/
-#
+#!/usr/bin/env python
+
+""" Font metrics for the Adobe core 14 fonts.
+
+Font metrics are used to compute the boundary of each character
+written with a proportional font.
+
+The following data were extracted from the AFM files:
+
+  http://www.ctan.org/tex-archive/fonts/adobe/afm/
+  
+"""
 
 ###  BEGIN Verbatim copy of the license part
 
diff --git a/pdfminer/glyphlist.py b/pdfminer/glyphlist.py
index c3ebfcd..13b044a 100644
--- a/pdfminer/glyphlist.py
+++ b/pdfminer/glyphlist.py
@@ -1,10 +1,15 @@
-# -*- python -*-
-#
-#  glyphlist.py - mappings from Adobe glyph name to unicode.
-#
-#  The following data was taken from
-#    http://www.adobe.com/devnet/opentype/archives/glyphlist.txt
-#
+#!/usr/bin/env python
+
+""" Mappings from Adobe glyph names to Unicode characters.
+
+In some CMap tables, Adobe glyph names are used for specifying
+Unicode characters instead of using decimal/hex character code.
+
+The following data was taken from
+
+  http://www.adobe.com/devnet/opentype/archives/glyphlist.txt
+
+"""
 
 ###  BEGIN Verbatim copy of the license part
 
diff --git a/pdfminer/latin2ascii.py b/pdfminer/latin2ascii.py
index f182d90..1bc196a 100644
--- a/pdfminer/latin2ascii.py
+++ b/pdfminer/latin2ascii.py
@@ -1,4 +1,14 @@
-# latin2ascii.py
+#!/usr/bin/env python
+
+""" Mappings from Latin-1 characters to ASCII.
+
+This is an in-house mapping table for some Latin-1 characters
+(acutes, umlauts, etc.) to ASCII strings.
+
+This file is *not* used currently.
+
+"""
+
 LATIN2ASCII = {
   # iso-8859-1
   0x00c0: 'A`',
diff --git a/pdfminer/latin_enc.py b/pdfminer/latin_enc.py
index d0da709..41d219c 100644
--- a/pdfminer/latin_enc.py
+++ b/pdfminer/latin_enc.py
@@ -1,6 +1,12 @@
-# latin_enc.py
-# Extracted from PDF Reference Manual 1.6, pp.925
-# "D.1 Latin Character Set and Encodings"
+#!/usr/bin/env python
+
+""" Standard encoding tables used in PDF.
+
+This table is extracted from PDF Reference Manual 1.6, pp.925
+  "D.1 Latin Character Set and Encodings"
+
+"""
+
 ENCODING = [
   # (name, std, mac, win, pdf)
   ('A', 65, 65, 65, 65),
diff --git a/pdfminer/pycdb.py b/pdfminer/pycdb.py
index 6663413..63319da 100755
--- a/pdfminer/pycdb.py
+++ b/pdfminer/pycdb.py
@@ -1,10 +1,16 @@
 #!/usr/bin/env python
-#
-# pycdb.py - Python implementation of cdb and tcdb
-#
-#   by Yusuke Shinyama
-#   * public domain *
-#
+
+""" pycdb - Python implementation of cdb and tcdb
+
+This code is in the public domain.
+
+cdb is a static data structure that was developed by
+D. J. Bernstein. It is suitable for storing a large number
+of items in a disk with efficient seeking.
+
+tcdb is an extention of cdb that support hierarchical lookup.
+
+"""
 
 import sys
 import os
diff --git a/pdfminer/rijndael.py b/pdfminer/rijndael.py
index 0d53334..2a1d3bf 100644
--- a/pdfminer/rijndael.py
+++ b/pdfminer/rijndael.py
@@ -1,11 +1,15 @@
 #!/usr/bin/env python
-##
-##  rijndael.py
-##  * public domain *
-##
-##  Based on a public domain C implementation by Philip J. Erdelsky
-##  http://www.efgh.com/software/rijndael.htm
-##
+
+""" Python implementation of Rijndael encryption algorithm.
+
+This code is in the public domain.
+
+This code is based on a public domain C implementation
+by Philip J. Erdelsky:
+  http://www.efgh.com/software/rijndael.htm
+
+"""
+
 import sys
 from struct import pack, unpack