Table of Contents

Module: test HappyDoc-r0_7_1/TestCases/test.py

Simple test file for HappyDoc.

This module contains various test cases for testing the HappyDoc documentation generator.

Imported modules   
from CommandLineApp import TestApp
from a.b import c, d
import one.two
import os
import string
from sys import path
from token import *
import types
Functions   
example_function_with_args
example_function_with_kwargs
example_function_with_varargs
example_function_without_args
  example_function_with_args 
example_function_with_args (
        arg1,
        arg2,
        arg3withDefault='hi there',
        arg3aWithDefault="'hi again'",
        arg3bWithDefault='"hi there again"',
        arg4DefaultInt=101,
        arg5DefaultTuple=( 1, 2 ),
        arg6DefaultList=[ 3, 4 ],
        arg7DefaultNone=None,
        arg8DefaultName=foo,
        arg9DefaultInstance=DefaultClassInst(),
        arg10DefaultInstanceWithParams=DefaultClassInstWithParams(1, 2, ( 'tuple', 'param' ), [ 'list', 'param' ] ),
        stringArgWithHTML='<h1>Hi, Dick & Jane!</h1>',
        )

This is an example function for testing purposes.

Exceptions   
'RAISE_blah2'
'RAISE_loop'
'RAISE_main_level'
IOError( 'RAISE_class' )

  example_function_with_kwargs 
example_function_with_kwargs ( **kw )

This example function takes variable keyword arguments.

  example_function_with_varargs 
example_function_with_varargs ( *args )

This example function takes a variable number of arguments.

  example_function_without_args 
example_function_without_args ()

This example function has no arguments.

Classes   
BaseClass1

First base class.

BaseClass2

Second base class.

DefaultClassInst

Class used for default parameter with a class instance.

DefaultClassInstWithParams

Class used for default parameter with a class instance taking parameters.

DottedBaseClass

Class to test subclassing from a base class with dots in the name.

MultipleBaseClasses

Class testing multiple inheritence.

OverRecursion
SubClass1

First subclass of BaseClass1.

SubClass2

Second subclass of BaseClass1 and BaseClass2.

SubClass3

Class documentation for SubClass3.

SubClass4

Class documentation for SubClass4 after the name

five

internal docs for five


Table of Contents

This document was automatically generated on Sat Sep 9 20:27:32 2000 by HappyDoc version r0_7_1