More Doxygen.

svn path=/scripts/rpki/Doxyfile; revision=871

8 files changed, 36 insertions, 9 deletions

diff --git a/scripts/rpki/Doxyfile b/scripts/rpki/Doxyfile
index bb408fe5..fdc5a133 100644
--- a/scripts/rpki/Doxyfile
+++ b/scripts/rpki/Doxyfile
@@ -6,7 +6,7 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Resource PKI"
+PROJECT_NAME           = "Resource PKI Engine"
 PROJECT_NUMBER         = RPKI
 OUTPUT_DIRECTORY       = 
 CREATE_SUBDIRS         = NO
@@ -61,8 +61,8 @@ HIDE_SCOPE_NAMES       = NO
 SHOW_INCLUDE_FILES     = YES
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
-SORT_BRIEF_DOCS        = NO
-SORT_BY_SCOPE_NAME     = NO
+SORT_BRIEF_DOCS        = YES
+SORT_BY_SCOPE_NAME     = YES
 GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
 GENERATE_BUGLIST       = YES
@@ -75,7 +75,7 @@ FILE_VERSION_FILTER    =
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
-QUIET                  = NO
+QUIET                  = YES
 WARNINGS               = YES
 WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_DOC_ERROR      = YES
diff --git a/scripts/rpki/__init__.py b/scripts/rpki/__init__.py
index e69de29b..6913b3cc 100644
--- a/scripts/rpki/__init__.py
+++ b/scripts/rpki/__init__.py
@@ -0,0 +1,11 @@
+# $Id$
+
+## @mainpage
+##
+## This collection of Python modules implements a prototype of the
+## RPKI Engine.  Well, ok, it will when it's done, this is a work in
+## progress.
+##
+## See http://viewvc.hactrn.net/subvert-rpki.hactrn.net/ for code,
+## design documents, a text mirror of portions of APNIC's Wiki, etc.
+
diff --git a/scripts/rpki/https.py b/scripts/rpki/https.py
index 1faf2bc0..01b7849e 100644
--- a/scripts/rpki/https.py
+++ b/scripts/rpki/https.py
@@ -1,7 +1,5 @@
 # $Id$
 
-import httplib, BaseHTTPServer, tlslite.api, glob, rpki.x509
-
 """HTTPS utilities, both client and server.
 
 At the moment this only knows how to use the PEM certs in my
@@ -9,6 +7,8 @@ subversion repository; generalizing it would not be hard, but the more
 general version should use SQL anyway.
 """
 
+import httplib, BaseHTTPServer, tlslite.api, glob, rpki.x509
+
 rpki_content_type = "application/x-rpki"
 
 class CertInfo(object):
diff --git a/scripts/rpki/left_right.py b/scripts/rpki/left_right.py
index 0f1ba415..4b52a61b 100644
--- a/scripts/rpki/left_right.py
+++ b/scripts/rpki/left_right.py
@@ -1,5 +1,7 @@
 # $Id$
 
+"""RPKI "left-right" protocol."""
+
 import base64, sax_utils, resource_set, lxml.etree, POW, POW.pkix
 
 xmlns = "http://www.hactrn.net/uris/rpki/left-right-spec/"
diff --git a/scripts/rpki/manifest.py b/scripts/rpki/manifest.py
index ee6ba613..68cb1cce 100644
--- a/scripts/rpki/manifest.py
+++ b/scripts/rpki/manifest.py
@@ -1,5 +1,10 @@
 # $Id$
 
+"""Signed manifests.
+
+At the moment this is just the ASN.1 encoder.
+"""
+
 from POW._der import *
 
 class FileAndHash(Sequence):
diff --git a/scripts/rpki/roa.py b/scripts/rpki/roa.py
index f6996f4c..3ca6c154 100644
--- a/scripts/rpki/roa.py
+++ b/scripts/rpki/roa.py
@@ -1,9 +1,14 @@
 # $Id$
 
-from POW._der import *
+""" ROA (Route Origin Authorization).
+
+At the moment this is just the ASN.1 encoder.
 
-# This corresponds to draft-ietf-sidr-roa-format-01, which is a work
-# in progress, so this may need updating later.
+This corresponds to draft-ietf-sidr-roa-format-01, which is a work in
+progress, so this may need updating later.
+"""
+
+from POW._der import *
 
 class IPAddresses(SequenceOf):
   def __init__(self, optional=0, default=''):
diff --git a/scripts/rpki/sax_utils.py b/scripts/rpki/sax_utils.py
index acb7a5a9..06862524 100644
--- a/scripts/rpki/sax_utils.py
+++ b/scripts/rpki/sax_utils.py
@@ -1,5 +1,7 @@
 # $Id$
 
+"""SAX utilities."""
+
 import xml.sax
 
 class handler(xml.sax.handler.ContentHandler):
diff --git a/scripts/rpki/up_down.py b/scripts/rpki/up_down.py
index 84a76d32..28e801b8 100644
--- a/scripts/rpki/up_down.py
+++ b/scripts/rpki/up_down.py
@@ -1,5 +1,7 @@
 # $Id$
 
+"""RPKI "up-down" protocol."""
+
 import base64, sax_utils, resource_set, lxml.etree, POW, POW.pkix
 
 xmlns="http://www.apnic.net/specs/rescerts/up-down/"