[ndoc-tracker] [ ndoc-Feature Requests-1656680 ] Hidden methods not to be documented

[SourceForge.net <no...@so...>]

Feature Requests item #1656680, was opened at 2007-02-10 12:47
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=416081&aid=1656680&group_id=36057

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: NDoc Core Features
Group: None
Status: Open
Priority: 5
Private: No
Submitted By: Jochen Wezel (jochenwezel)
Assigned to: Nobody/Anonymous (nobody)
Summary: Hidden methods not to be documented

Initial Comment:
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

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=416081&aid=1656680&group_id=36057