[Pymoul-svn] SF.net SVN: pymoul: [105] pymoul/trunk/doc

[<ti...@us...>]

Revision: 105
          http://pymoul.svn.sourceforge.net/pymoul/?rev=105&view=rev
Author:   tiran
Date:     2007-01-30 18:59:33 -0800 (Tue, 30 Jan 2007)

Log Message:
-----------
Added todo and coding text

Added Paths:
-----------
    pymoul/trunk/doc/CODING.txt
    pymoul/trunk/doc/TODO.txt

Added: pymoul/trunk/doc/CODING.txt
===================================================================
--- pymoul/trunk/doc/CODING.txt	                        (rev 0)
+++ pymoul/trunk/doc/CODING.txt	2007-01-31 02:59:33 UTC (rev 105)
@@ -0,0 +1,102 @@
+======
+epydoc
+======
+
+epydoc fields
+=============
+
+http://epydoc.sourceforge.net/fields.html
+
+Functions and Methods (function or method docstrings)
+-----------------------------------------------------
+@param p: ... 	A description of the parameter p for a function or method.
+@type p: ... 	The expected type for the parameter p.
+@return: ... 	The return value for a function or method.
+@rtype: ... 	The type of the return value for a function or method.
+@keyword p: ... A description of the keyword parameter p.
+@raise e: ... 	A description of the circumstances under which a function or
+                method raises exception e.
+
+Variables (module or class docstrings)
+--------------------------------------
+@ivar v: ... 	A description of the class instance variable v.
+@cvar v: ... 	A description of the static class variable v.
+@var v: ... 	A description of the module variable v.
+@type v: ... 	The type of the variable v.
+
+Properties (property docstrings)
+--------------------------------
+@type: ... 	The type of the property.
+
+Grouping and Sorting (module, class, function, or method docstrings)
+--------------------------------------------------------------------
+@group g: c1,...,cn Organizes a set of related children
+@sort: c1,...,cn 	Specifies the sort order for the children of a module or class
+
+Related Topics
+--------------
+@see: ... 	A description of a related topic.
+
+Notes and Warnings
+------------------
+@note: ... 	A note about an object. 
+@attention: ... 	An important note about an object. 
+@bug: ... 	A description of a bug in an object. 
+@warning: ... 	A warning about an object. 
+
+Status
+------
+@version: ... 	The current version of an object.
+@todo [ver]: ... 	A planned change to an object.
+@deprecated: ... 	Indicates that an object is deprecated.
+@since: ... 	The date or version when an object was first introduced.
+@status: ... 	The current status of an object.
+@change: ... 	A change log entry for this object.
+
+Formal Conditions
+-----------------
+@requires: ... 	A requirement for using an object. 
+@precondition: ... 	A condition that must be true before an object is used. 
+@postcondition: ... 	A condition that is guaranteed to be true after an object is used.
+@invariant: ... 	A condition which should always be true for an object.
+
+Bibliographic Information
+@author: ... 	The author(s) of an object. 
+@organiation: ... 	The organization that created or maintains an object.
+@copyright: ... 	The copyright information for an object.
+@license: ... 	The licensing information for an object.
+@contact: ... 	Contact information for the author or maintainer.
+
+Summarization
+-------------
+@summary: ... 	A summary description for an object. This description overrides the
+                default summary.
+
+New field
+---------
+@newfield tag: label [, plural]
+@newfield qtslot: Qt slot, Qt slots
+@newfield qtsignal: emits Qt signal, emit Qt signals
+
+
+epytext markup language
+=======================
+
+http://epydoc.sourceforge.net/epytext.html
+
+* literal: ::
+* I{...}: Italicized text.
+* B{...}: Bold-faced text.
+* C{...}: Source code or a Python identifier.
+* M{...}: A mathematical expression.
+* U{http://www.example.org/}: URL
+* U{Example<http://www.example.og/>}: URL
+* L{object dotted name}: Cross reference
+* L{text<dottedname>}: Cross reference
+* X{index term}: index
+* S{symbol}: http://epydoc.sourceforge.net/api/epydoc.markup.epytext-module.html#SYMBOLS
+* E{}: escape, E{lb}E{rb} for {}
+* G{classtree classes...}
+* G{packagetree modules...}
+* G{impotgraph modules...}
+* G{callgraph functions...}

Added: pymoul/trunk/doc/TODO.txt
===================================================================
--- pymoul/trunk/doc/TODO.txt	                        (rev 0)
+++ pymoul/trunk/doc/TODO.txt	2007-01-31 02:59:33 UTC (rev 105)
@@ -0,0 +1,14 @@
+==========
+To Do list
+==========
+
+version 0.1
+-----------
+
+ * get official OK from Chogon
+ * API for create Uru Live directory with config files with default values.
+ * integrate log zipper
+ * integrate chat archiver
+ * complete chatlog viewer
+ * more checks and exceptions! Never fail silentely
+ * update readme.txt


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.