Menu

#212 Hidden methods not to be documented

open
nobody
5
2007-02-10
2007-02-10
No

Hi!

I've got a method like the following:
<Obsolete("Use new function instead"), System.ComponentModel.EditorBrowsable(ComponentModel.EditorBrowsableState.Never)> _
Public Function MyOldFunction() As String
'some code here...
End Function

This method is obsolete and shouldn't be used any more. But can't be dropped since some older applications might rely on that method and I want to be backwards-compatible.

That's why I marked this method as
1. obsolete (to lead the programmer to use the new method if he's using it)
2. remove the method from the list of available methods in IntelliSense (so that a programmer who doesn't know the old method doesn't get confused by the old method)

Now, my request for NDoc is take care of this attribute System.ComponentModel.EditorBrowsable(ComponentModel.EditorBrowsableState.Never) as IntelliSense does, too: the documentation of the old/hidden method should not be visible.

Since the old/hidden method is still working and usable, my recommendation is to not drop this method from the documentation process but to drop the links referencing to documentation pages of this old method.

Thank you very much in advance!
Jochen

Discussion


Log in to post a comment.