classdoc1.py

Go to the documentation of this file.
00001 
00002 ## Documentation for a class.
00003 #
00004 #  This should work but doesn't.
00005 class PyClass2:
00006     ## The constructor is not usually documented itself.
00007     #
00008     # Aha!
00009     def __init__(self):
00010         ## An instance variable. It is private so we need <tt>EXTRACT_PRIVATE = YES</tt>.
00011         #
00012         # How's about here?
00013         self._memVar = 0
00014     ## Documentation for a method.
00015     #  @param[in,out] self The object pointer isn't usually documented.
00016     def PyMethod(self):
00017         pass
00018     ## A class' variable.
00019     #
00020     # Not documentable without using a comment block.
00021     classVar = 0
00022 
00023 
00024 ## Isn't this a function?
00025 #
00026 # Whee!
00027 def func():
00028     pass

Generated on Tue Jan 31 17:46:56 2006 for Class Doc-Comment Bug by  doxygen 1.4.6