8 comments

Add a comment…

Sign in

prestine

Your email address

Check!

invalid email

(thinking…)

Reset

or sign in with

• 
• 

UserVoice password

Forgot password?

Create a password

Your name

I agree to the terms of service

You'll receive a confirmation email with a link to create a password (optional).

Signed in as (Sign out)

Close

Close

Post comment Submitting...

• Vizcat commented  ·  Oct 28, 2011  ·  Flag as inappropriate  ·  Delete

  Heck, "better" isn't even necessary, crappy, but correct would be adequate. When the docs make multiple mutually disagreeing, statements regarding function parameter requirements, none of which are actually correct, and then point the reader to an example case at hasn't been valid for several releases, even /no/ documentation would be an improvement. At least then we wouldn't go down the garden path of thinking that it was possible to use, without more work than a complete rewrite.

• Ben Held commented  ·  Oct 31, 2009  ·  Flag as inappropriate  ·  Delete

  I think it would be very useful if the documentation was clear about the default values for the various flags one can set. Often we have to dig around in the source code to find this.

• daviddoria commented  ·  Oct 31, 2009  ·  Flag as inappropriate  ·  Delete

  The library that needs to be linked to to use a class is also an important part of the documentation that is missing.

• Tim Peeters commented  ·  Oct 24, 2009  ·  Flag as inappropriate  ·  Delete

  many VTK classes have a lot of functions that are used internally or by other classes, but which are not useful for the user. Maybe it is good to make a distinction between these different functions and, for example for each class have a short-list of variables that the user should set.

• daviddoria commented  ·  Oct 24, 2009  ·  Flag as inappropriate  ·  Delete

  Is there a way in UserVoice to make a "sub vote"? I am thinking of a list of classes that people can vote for to indicate which ones need the most improvement.

• daviddoria commented  ·  Oct 23, 2009  ·  Flag as inappropriate  ·  Delete

  Great! I think this is absolutely the most important thing for promoting usage of VTK. I think EVERY function needs to contain:
  1) What does the function do? This is currently usually stated, but the statements are usually quite brief and could use some expanding.
  2) What does EVERY variable in its argument list represent/mean? Which ones are inputs? Which ones are outputs? This is the most important thing for new users.

• Wagner Sales commented  ·  Oct 23, 2009  ·  Flag as inappropriate  ·  Delete

  Another problem in documentation: in a lot of cases we need to deeply inside the code to know if a method or class are, for example, thread-safe.

• drescherjm commented  ·  Oct 23, 2009  ·  Flag as inappropriate  ·  Delete

  The documentation deficiency is the most frustrating thing with with working with vtk. Neither of the books cover every vtk class and most of the doxygen documentation contains very little explanation.