improved documentation

Author: ancat

python_pin.h

@@ -80,72 +80,71 @@ static PyMethodDef methods[] = {
     {"RTN_Name",
         Python_RTN_Name, 
         METH_VARARGS,
-      "fuck if I know dude"},
+      "Name of routine"},
     {"RTN_Address",
         Python_RTN_Address, 
         METH_VARARGS,
-      "fuck if I know dude"},
+      "Address in memory of rtn"},
     {"RTN_InsertCall",
         Python_RTN_InsertCall,
         METH_VARARGS,
-      "stop"},
-    /*AUTO GENERATED SKELETONS*/
+      "Insert call relative to a rtn."},
     {"RTN_Valid",
           Python_RTN_Valid , 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "True if x is not RTN_Invalid(). RTN_Valid() returns FALSE in certain cases when there is no static image of the code available, including dynamically generated code."},
    {"RTN_Id",
           Python_RTN_Id , 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "Pin assigns each routine a unique ID. The ID is globally unique, i.e. an ID will not appear in two images. If the same routine name exists in two different images (i.e. they are in different addresses), each will have a different ID. If an image is unloaded and then reloaded, the routines within it will most likely have different IDs than before."},
     {"RTN_Range",
           Python_RTN_Range , 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "range of routine in bytes (until the next known symbol or end of current code region)."},
     {"RTN_Size",
-          Python_RTN_Size , 
+          Python_RTN_Size, 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "size of routine in bytes"},
     {"RTN_IsDynamic",
           Python_RTN_IsDynamic , 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "TRUE if the routine is dynamically created"},
     {"RTN_IsSafeForProbedInsertion",
           Python_RTN_IsSafeForProbedInsertion , 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "Return TRUE if the given RTN is a candidate for function insertion using probes, and FALSE otherwise. This API should be called before attempting to insert a call to an analysis function using RTN_InsertCallProbed(). If you want to replace the given RTN with RTN_ReplaceSignatureProbed() or RTN_ReplaceProbed() you should use RTN_IsSafeForProbedReplacement()"},
     {"RTN_IsSafeForProbedReplacement",
           Python_RTN_IsSafeForProbedReplacement , 
           METH_VARARGS,
-       "fuck if I know dude"},
+       "Return TRUE if the given RTN is a candidate for probed function replacement, and FALSE otherwise. This API should be called before attempting to replace a function using RTN_ReplaceSignatureProbed() or RTN_ReplaceProbed(). Note that this routine does not guarantee it is safe to place a probe, it merely indicates that certain conditions are not present."},
     {"RTN_FindNameByAddress",
         Python_RTN_FindNameByAddress , 
         METH_VARARGS,
-     "fuck if I know dude"},
+     "Return the name of a function. If more than one name is associated with this address, the first name found is returned."},
     {"RTN_FindByName",
         Python_RTN_FindByName,
         METH_VARARGS,
-     "fuck if I know dude"},
+     "Handle to the RTN found. If not found returns RTN_Invalid()"},
      {"RTN_Open",
         Python_RTN_Open , 
         METH_VARARGS,
-     "fuck if I know dude"},
+     "Open the given rtn. This must be called before RTN_InsHead() or RTN_InsertCall() or RTN_InsHeadOnly()"},
      {"RTN_Close",
         Python_RTN_Close, 
         METH_VARARGS,
-     "fuck if I know dude"},
+     "Close the given rtn. This must be called before opening a new rtn."},
      {"RTN_InsHead",
         Python_RTN_InsHead , 
         METH_VARARGS,
-     "fuck if I know dude"},
+     "You must call RTN_Open() before the first time this is called for an rtn"},
      {"RTN_InsTail",
         Python_RTN_InsTail , 
         METH_VARARGS,
-     "fuck if I know dude"},
+     "You must call RTN_Open() before the first time this is called for an rtn"},
      {"RTN_NumIns",
         Python_RTN_NumIns , 
         METH_VARARGS,
-     "fuck if I know dude"},
+     "Compute number of static INSs inside RTN."},
     {"IMG_Next",
         Python_IMG_Next,
         METH_VARARGS,