Changeset 267

Timestamp:

02/14/06 11:38:53

Author:

fenix

Message:

added documentation

Files:

• qPloneEpydoc/trunk/HISTORY.txt (modified) (1 diff)
• qPloneEpydoc/trunk/PloneEpydoc.py (modified) (6 diffs)
• qPloneEpydoc/trunk/epydoc_patch.py (modified) (1 diff)
• qPloneEpydoc/trunk/version.txt (modified) (1 diff)

qPloneEpydoc/trunk/HISTORY.txt

@@ +1 @@
+0.1.3 2006-02-14
+================
+
+  - documentation added
+
-0.1.2 2006-02-10
-================

qPloneEpydoc/trunk/PloneEpydoc.py

@@ -4 +4 @@
-# Copyright: quintagroup.com
-
+"""
+This tool lets you generate API documentation of any product in Products directory.
+It use epydoc for generating API documentation based on docstrings.
+This module defines the following classes:
+
+     - `PloneEpydoc`, this is the class that carries responsibility
+                      for generating product documentation.
+
+             Methods:
+
+                  - `PloneEpydoc.getProductModules`: return list of all documented modules in product package
+                  - `PloneEpydoc.createDocumentationDirectoryViews`: create file system directory views for generated documentation
+                  - `PloneEpydoc.generate`: generate documentation for product
+                  - `PloneEpydoc.write_object_type`: write pairs 'file':'type' for all generated files in directory contained in 'path'
+                  - `PloneEpydoc.write_content_file_types`: write file type for all files in subdirectories
+"""
-from Products.CMFCore.DirectoryView import DirectoryView, registerDirectory, createDirectoryView
-from Products.Archetypes.public import *
@@ -28 +44 @@
-
-    def getProductModules(self, path):
-
+
+
+
+
+
+
-        modules = []
-        for root, dirs, files in walk(path):
@@ -42 +63 @@
-
-    def createDocumentationDirectoryViews(self, product):
-
+
+
+
+
+
+
-        try:
-            registerDirectory(DOCUMENTATION_DIR, GLOBALS)
@@ -54 +80 @@
-
-    def generate(self, product, **properties):
-
+
+
+
+
+
+
+
-        sys.argv = []
-        modules = []
@@ -72 +104 @@
-
-    def write_object_type(self, path, obj_name, obj_type):
-
+
+
+
+
+
+
+
+
-        file = open(path+'/.objects', 'a')
-        data = obj_name+' : '+obj_type+'\n'
@@ -78 +117 @@
-
-    def write_content_file_types(self, path):
-
+
+
+
+
+
+
-        for obj in listdir(path):
-            if isdir(path+'/'+obj):

qPloneEpydoc/trunk/epydoc_patch.py

@@ -4 +4 @@
-# Copyright: quintagroup.com
-
+"""
+This module contain fixed functions from epydoc classes that have to replace original.
+"""
-from epydoc.uid import UID, Link, make_uid, findUID
-from epydoc.objdoc import ObjDoc, _find_base_order, _lookup_class_field, Var

qPloneEpydoc/trunk/version.txt

@@ -1 @@
-2
+3