I had a few minutes so I thought it would be productive to start to make a list of problems in the documentation. I was looking at the current doxygen pages (e.g. <a href="http://www.vtk.org/doc/nightly/html/classvtkLandmarkTransform.html">http://www.vtk.org/doc/nightly/html/classvtkLandmarkTransform.html</a>) I will maintain the list here:<br>
<a href="http://www.vtk.org/Wiki/VTK#Documentation_Improvement">http://www.vtk.org/Wiki/VTK#Documentation_Improvement</a><br><br>After not very long, I realized that this was not such a productive exercise (see below). We really need to just go through class by class and make sure every function has at least a brief/correct description for now (and that the doxygen syntax is correct). We can go back and fill in the real meat/good descriptions slowly.<br>
<br>Here is what I came up with after only going through 3 classes...<br><br>===vtkMath===<br>* Pi, DoubleTwoPi, DoublePi all just say "useful constants. Maybe they could say something like "2 * 3.14159..." or 2 *\pi or something like that?<br>
* DegreesFromRadians says "Useful constants". This is incorrect. It should explain the conversion along with specify if there are/aren't bound on the input.<br>* DoubleDegreesToRadians says "useful constants". This is incorrect.<br>
* DoubleRadiansToDegrees says "useful constants". This is incorrect.<br>* Round(double) says "useful constants". This is incorrect.<br>* Floor() has no documentation at all.<br>* Outer(double, double, double) says "useful constants". This is incorrect.<br>
* Norm(double, int) says "useful constants". This is incorrect.<br>* Perpendiculars(double, double, double, double) says "useful constants". This is incorrect. x,y,z, and theta must be explained.<br>* Outer2D says "useful constants". This is incorrect.<br>
* Determinant2x2(double, double) says "Useful constants". This is incorrect.<br>* LUFactor3x3(double, int) says "useful constants". This is incorrect.<br>* LUSolve3x3(double, int,double) says "useful constants". This is incorrect.<br>
* LinearSolve3x3(double,double,double) says "useful constants". This is incorrect.<br>The list goes on....<br><br>===vtkKdTree===<br>* TimingOff() says "turn ON timing"<br>* SetTiming(int) says "turn on timing". It should say "turn on timing and set the interval (of what?) to the input X (the input variable is not named - also a problem).<br>
* GetTiming says "turn on timing". This is incorrect.<br>* GetMinCells() says "turn on timing". This is incorrect.<br>* SetNumberOfRegionsOrLess has no documentation.<br>* SetNumberOfRegionsOrMore has no documentation.<br>
* SetFudgeFactor has no documentation.<br>* RemoveDataSet says "Turn on timing". This is incorrect.<br>* PrintVerboseTree says "Turn on timing"<br>* All CreateCellLists functions have no documentation.<br>
* GetIncludeRegionBoundaryCells/On/Off say "turn on timing". This is incorrect.<br>* GetCellLists functions say "turn on timing". This is incorrect.<br>* GetRegionContainingCell says "turn on timing". This is incorrect.<br>
* BuildLocatorFromPoints(vtkPoints) says "turn on timing". This is incorrect.<br>The list goes on...<br><br>===vtkLandmarkTransform===<br>* SetTargetLandmarks/SetSourceLandmarks - both of these have the same description. One should talk about the target only and the other should talk about the source only.<br>
* GetSource/TargetLandmarks - same description as the Set* methods. This is incorrect.<br>* SetModeToRigidBody has the same desciption as SetSourceLandmarks. This is incorrect.<br>* SetModeTo* has the same description as SetSourceLandmarks. This is incorrect.<br>
* GetMTime - says "Get the MTime". What is MTime? Modification time? Maybe "Get the time at which the object was last modified."<br><br>How can we start to divide/assign the work? This is what I would consider a lucky and unusual case - a HUGE problem with a VERY easy solution.<br>
<br clear="all">Thanks,<br><br>David<br>