Visual Studio SDK: Improve my productivity by removing some docs

Talking about obscure...

Take a quick look at the documentation for IVsTextManager.RegisterView method.

The main description for the method reads: "Method information is not provided."

Ok... there isn't much I can guess about the method from that so let's see what the arguments this method takes are about in order to help the guessing game. Its signature is:

int RegisterView (
	[InAttribute] IVsTextView pView,
	[InAttribute] IVsTextBuffer pBuffer
)

What are pView and pBuffer about? Let's check that doco again:

Parameters

pView

Do not use.

pBuffer

Do not use.

Does "do not use" really means "I've no idea what should go here"? Or is it more like "this is used internally by VS and maybe we should have said that at the method description where we originally said 'method information is not provided'"?

At this point you may be lead to believe whoever put this page online just doesn't care about your time. I mean, you took the time to search for this method, you were directed to MSDN, you open and read the help and you get zero information at all. I don't think this is the case. I'm guessing there is some automated tool that produces a million pages based on XML comments or something similar and that's the reason why some non-sense pages like this one end up online.

Based on this I can think of a way to automatically improve VSX developer's productivity out there: JUST remove pages like this one. You can save me a minute or two by doing so.

No Comments