[wpdev-commits] wolfpack/python pytooltip.cpp,1.19,1.20

[Sebastian H. <dar...@us...>]

Update of /cvsroot/wpdev/wolfpack/python
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29008/python

Modified Files:
	pytooltip.cpp 
Log Message:
New documentation

Index: pytooltip.cpp
===================================================================
RCS file: /cvsroot/wpdev/wolfpack/python/pytooltip.cpp,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -d -r1.19 -r1.20
*** pytooltip.cpp	15 Jun 2004 02:44:46 -0000	1.19
--- pytooltip.cpp	1 Jul 2004 16:30:55 -0000	1.20
***************
*** 35,38 ****
--- 35,43 ----
  #include "../player.h"
  
+ /*
+ 	\object tooltip
+ 	\description This object represents a tooltip for an object. It allows you to modify the tooltip sent to 
+ 	the client.
+ */
  typedef struct
  {
***************
*** 74,77 ****
--- 79,92 ----
  };
  
+ /*
+ 	\method tooltip.add
+ 	\param id The cliloc id of the text.
+ 	\param params Parameters for the cliloc text.
+ 	\description This method adds a line to the tooltip. The text is
+ 	determined by the given cliloc id and the parameters for it.
+ 	Please note that the first line is automatically colored by the
+ 	client. HTML is also allowed in tooltips. A cliloc id can only be used once 
+ 	in a tooltip.
+ */
  static PyObject* wpTooltip_add( wpTooltip* self, PyObject* args )
  {
***************
*** 89,92 ****
--- 104,111 ----
  }
  
+ /*
+ 	\method tooltip.reset
+ 	\description This method deletes all lines from the tooltip.
+ */
  static PyObject* wpTooltip_reset( wpTooltip* self, PyObject* args )
  {
***************
*** 119,124 ****
--- 138,149 ----
  static PyObject* wpTooltip_getAttr( wpTooltip* self, char* name )
  {
+ 	/*
+ 		\property tooltip.id This is the internal id of this tooltip.
+ 	*/
  	if ( !strcmp( name, "id" ) )
  		return PyInt_FromLong( self->list->getInt( 11 ) );
+ 	/*
+ 		\property tooltip.serial This is the serial of the object this tooltip is for.
+ 	*/
  	else if ( !strcmp( name, "serial" ) )
  		return PyInt_FromLong( self->list->getInt( 5 ) );