Python source code documentation Repost?

Sam Schulenburg sams at quinta.com
Fri Jun 18 19:27:45 CEST 1999


In article <7kdv0l$n0g$1 at nnrp1.deja.com>,
  Sam Schulenburg <sams at quinta.com> wrote:
> I have been using a freeware product called Autoduck to document my
> Python source code.
>
> =============== Example source ====================================
> # ######################################
> # DATE:         June 17,1999
> # PROGRAMMER:   Samuel W. Schulenburg
> # This function will print out the command time statistics from<nl>
> # getcommandtime(tid) function<nl>
> #
> #//@pyfunc void | printcommandtime | This function will take a <nl>
> #//                          tid and print out the following<nl>
> #//                          commandtime structure statictics:<nl>
> #//                          1) Total command time counts<nl>
> #//                          2) Start time for last command<nl>
> #//                          3) Minimum time for all commands<nl>
> #//                          4) Maximum time for all commands<nl>
> #//                          5) End time for last command<nl>
> #//                          6) Time for last command<nl>
> #//                          7) Total time for all commands<nl>
> #//                          8) Average time for all commands<nl>
> #//@parm   integer  | Tid | Target id to use
> #//@rdesc  void
> #
> #####################################################################
> def printcommandtime(tid):
>         s=getcommandtime(tid)
>         print "Total command time counts     = ",s[0]
>         print "Start time for last command   = ",s[1]
>         print "Minimum time for all commands = ",s[2]
>         print "Maximum time for all commands = ",s[3]
>         print "End time for last command     = ",s[4]
>         print "Time for last command         = ",s[5]
>         print "Total time for all commands   = ",s[6]
>         print "Average time for all commands = ",s[7]
> ================= End Example =====================================
> This product will then generate a windows help file based upon the
> information provided above.
>
> I would prefer to have a Python based solution that would generate
HTML
> files. Can anyone point me towards any information that may start me
> down this path, If a solution does not exist, then I may have to write
> my own Python parser to handle this.
>
> Sam Schulenburg
>
> Sent via Deja.com http://www.deja.com/
> Share what you know. Learn what you don't.

The previous post had formatting problems, If this post does not
correct it I give up on deja news.


Sent via Deja.com http://www.deja.com/
Share what you know. Learn what you don't.




More information about the Python-list mailing list