[FRPythoneers] Lumberjack: Sample Markup

Sean Reifschneider jafo at tummy.com
Sat May 6 14:01:03 MDT 2000


Here are some markup samples.

Sean
==============
def function(foo, bar = None):
   '''
   First line is short description.
   Additional lines up to first line starting with @ are longer description
   text.
   NOTE: Initial text line indicate indentation which will be stripped from
      remaining lines.

   @author Sean Reifschneider
   @version $Revision: 1.4 $
   @see otherFunction (http://localhost/thispath/thisfile.html#otherFunction)
   @see string.split (http://localhost/thispath/string.html#split)
   @see os.path.join (http://localhost/thispath/os/path.html#join)
   @see <A HREF="http://www.tummy.com/">link text</A>
   @deprecated Replaced by otherFunction()
   @param foo Description of what foo is.
   @param bar (mutable, default=None, type=int/string/None) Description
       Additional specifications in the parens, mutable means that the
       value may be changed in this scope, default=<value> specifies the
       default value as in "bar = None" above.  type=<value> specifies
       the valid types, / separates the allowed types.
   @private
   @return (type=Integer/string/None) Description
      The optional "type=<value>" specifies returned types.
   @raise Exception
   @raise os.error
   '''

What markup would we need in the header blocks.
   Parameters and other names: <code>param</code>
   <A HREF="http://www.tummy.com/">link text</A>
-- 
 Home is where your source is.  -- Sean Reifschneider, 1999
Sean Reifschneider, Inimitably Superfluous <jafo at tummy.com>
URL: <http://www.tummy.com/xvscan> HP-UX/Linux/FreeBSD/BSDOS scanning software.




More information about the FRPythoneers mailing list