Feature Requests item #542784, was opened at 2002-04-11 18:38
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=416081&aid=542784&group_id=36057
>Category: NDoc Core Features
Group: None
Status: Open
Priority: 5
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Nobody/Anonymous (nobody)
Summary: Ignore Base Class methods etc
Initial Comment:
This puppy rocks, you guys/gals have done a fantastic
job. I have one improvement that a number of other
developers I work with have also requested.
This is an option to not include any inherited
methods/properties etc when a class is derived from
any class within the frameworks System hierarchy.
For example a new class is created that inherits from
System.Windows.Forms.UserControl, and we add a couple
of new methods etc. The resultant members help page
generated then includes literally hundreds of methods,
properties, events, etc all indicating they have been
inherited, with a description "Select the method name
to go to the Microsoft documentation.". This makes it
then very difficult for a user of our documentation to
discover the new functionality; can't see the forest
for the trees!
So could these additional methods, properties, events,
etc not be output, but replaced with a single
reference to the base class
(System.Windows.Forms.UserControl in this example).
Then a user of the help file could navigate to this if
required.
This would also hopefully result in a smaller help
file.
Thanks.
----------------------------------------------------------------------
Comment By: Jean-Claude Manoli (jcman)
Date: 2002-05-31 06:36
Message:
Logged In: YES
user_id=235364
Jeremy Zongker sent me this:
In the mean time I just did a quick and sloppy fix to my copy
to remove it for all documents. If anyone else wants to,
here's what to change.
In Core.BaseDocumenter.cs
In WriteMethod
string memberName =
GetMemberName(method);
//Add this line
if (memberName.StartsWith
("System.")) return;
In WriteProperty
string memberName =
GetMemberName(property);
//Add this line
if (memberName.StartsWith
("System.")) return;
----------------------------------------------------------------------
Comment By: Kevin Dente (kevindente)
Date: 2002-05-01 11:07
Message:
Logged In: YES
user_id=503065
I'll add my vote for this feature. We would find it useful
for generation web service proxy class documentation, which
is slightly more generic and less .Net-ty. For an example,
check out the docs for MapPoint.Net:
http://msdn.microsoft.com/library/default.asp?
url=/library/en-us/mpn20/html/mpintServices.asp
----------------------------------------------------------------------
Comment By: John Burr (burrj)
Date: 2002-04-19 08:49
Message:
Logged In: YES
user_id=520424
I would like this feature as well. I would want the option
to recurse or not. Yes, there are two different views
already, but basically we have two different types of
people that want to view the documentation so we would like
to generate both the full docs and the short docs.
BTW, thanks for a GREAT product.
----------------------------------------------------------------------
Comment By: Eric (kiwidude)
Date: 2002-04-14 17:06
Message:
Logged In: YES
user_id=515410
Understand your response in that the TOC shows this, and
that at times it is good to have the big picture. What I
am suggesting is an option to not include the inherited
members etc. We are looking to distribute our
documentation as a pack that supports the development, and
show what extensions etc have been added. The development
users of this doco understand the base classes but want
the "whats new" stuff. The reason the TOC is not enough is
where they might want to print out the page as a reference.
----------------------------------------------------------------------
Comment By: Jean-Claude Manoli (jcman)
Date: 2002-04-12 14:28
Message:
Logged In: YES
user_id=235364
Do you really need that? NDoc already provides both views:
1. The class members page displays all members, including
inherited members, for people who want to see the big
picture.
2. The TOC tree on the left only displays new and
overrided members.
This is consistent with the .NET Framework class library
documentation format, and I think we should keep it like
that.
----------------------------------------------------------------------
You can respond by visiting:
https://sourceforge.net/tracker/?func=detail&atid=416081&aid=542784&group_id=36057
|