NDoc Replacement - C# / C Sharp

Brian Richards

I'm looking for a replacement to NDoc. to generate MSDN style HTML from xml
documentation. NDoc just doesn't support 2.0 very well and some things
(generics) at all.

Thanks

Brian

Aug 29 '06 #1

Subscribe Reply

3869

Brian Richards

I just read about Sandcastle MS's answer to NDoc. Unless anyone knows of any
other alternatives this should do what we need.

Thanks.

"Brian Richards" <br*******@gmai l.comwrote in message
news:O%******** *******@TK2MSFT NGP03.phx.gbl.. .

I'm looking for a replacement to NDoc. to generate MSDN style HTML from

xml

documentation. NDoc just doesn't support 2.0 very well and some things
(generics) at all.

Thanks

Brian

Aug 29 '06 #2

Mathieu Cartoixa

Brian Richards a écrit :

I just read about Sandcastle MS's answer to NDoc. Unless anyone knows of any
other alternatives this should do what we need.

"Brian Richards" <br*******@gmai l.comwrote in message
news:O%******** *******@TK2MSFT NGP03.phx.gbl.. .
>I'm looking for a replacement to NDoc. to generate MSDN style HTML from
xml
>documentatio n. NDoc just doesn't support 2.0 very well and some things
(generics) at all.

For the record : http://blogs.msdn.com/sandcastle/default.aspx
NDoc has been abandonned, and Sandcastle, though promising, has yet to
be officially released. I do not know of other aletrnatives.

Mathieu

Aug 30 '06 #3

William Stacey [MVP]

There is an NDoc build by another guy that does do 2.0 and generics pretty
well. I don't have the url at the moment.

--
William Stacey [MVP]

"Brian Richards" <br*******@gmai l.comwrote in message
news:O%******** *******@TK2MSFT NGP03.phx.gbl.. .
| I'm looking for a replacement to NDoc. to generate MSDN style HTML from
xml
| documentation. NDoc just doesn't support 2.0 very well and some things
| (generics) at all.
|
| Thanks
|
| Brian
|
|

Aug 30 '06 #4

Brian Gideon

All,

The url is <http://jonas.lagerblad .com/blog/?p=5>. Like you said it
does a pretty good job, but it's far from perfect. I've been using it.

Brian

William Stacey [MVP] wrote:

There is an NDoc build by another guy that does do 2.0 and generics pretty
well. I don't have the url at the moment.

--
William Stacey [MVP]

"Brian Richards" <br*******@gmai l.comwrote in message
news:O%******** *******@TK2MSFT NGP03.phx.gbl.. .
| I'm looking for a replacement to NDoc. to generate MSDN style HTML from
xml
| documentation. NDoc just doesn't support 2.0 very well and some things
| (generics) at all.
|
| Thanks
|
| Brian
|
|

Aug 30 '06 #5

Brian Gideon

Mathieu,

The last I heard there is an alpha version of NDoc 2.0, but that's been
awhile. I could be mistaken, but I don't think NDoc is abandoned.

Brian

Mathieu Cartoixa wrote:

For the record : http://blogs.msdn.com/sandcastle/default.aspx
NDoc has been abandonned, and Sandcastle, though promising, has yet to
be officially released. I do not know of other aletrnatives.

Mathieu

Aug 30 '06 #6

Mathieu Cartoixa

Brian Gideon a écrit :

The last I heard there is an alpha version of NDoc 2.0, but that's been
awhile. I could be mistaken, but I don't think NDoc is abandoned.

The only NDoc developer said "I have decided to discontinue work on
NDoc 2.0 and no longer participate in any open-source development work."
(source
http://www.charliedigital.com/PermaL...cde5df9c.aspx).

With Sandcastle on the way, I do not see a very bright future for NDoc.

Mathieu Cartoixa

Aug 30 '06 #7

Brian Gideon

Mathieu Cartoixa wrote:

The only NDoc developer said "I have decided to discontinue work on
NDoc 2.0 and no longer participate in any open-source development work."
(source
http://www.charliedigital.com/PermaL...cde5df9c.aspx).

With Sandcastle on the way, I do not see a very bright future for NDoc.

Mathieu Cartoixa

Well, I'm obviously mistaken. That's disappointing, but after reading
that I don't blame the guy at all. I guess I'll move to GhostDoc or
this Sandcastle thing. It looks like the CTP version of Sandcastle was
release a couple of days ago. I hadn't even heard anything about it
until you posted. Thanks for the tip.

Aug 30 '06 #8

William Stacey [MVP]

That is OS for you. All you get is the requests for new features and nobody
gives you anything. IMO, the guy should have charged $50 awhile back and
got a 2.0 version out a year ago. I would have bought it hands down. As it
stands, someone still needs to put a UI on Sandcastle and integrate it into
VS. That should not be too hard.

--
William Stacey [MVP]

"Brian Gideon" <br*********@ya hoo.comwrote in message
news:11******** *************@b 28g2000cwb.goog legroups.com...
|
| Mathieu Cartoixa wrote:
| The only NDoc developer said "I have decided to discontinue work on
| NDoc 2.0 and no longer participate in any open-source development work."
| (source
| >
http://www.charliedigital.com/PermaL...cde5df9c.aspx).
| >
| With Sandcastle on the way, I do not see a very bright future for NDoc.
| >
| Mathieu Cartoixa
|
| Well, I'm obviously mistaken. That's disappointing, but after reading
| that I don't blame the guy at all. I guess I'll move to GhostDoc or
| this Sandcastle thing. It looks like the CTP version of Sandcastle was
| release a couple of days ago. I hadn't even heard anything about it
| until you posted. Thanks for the tip.
|

Aug 30 '06 #9

Steve Barnett

Someone has built a UI. I've been using this one:
http://www.codeproject.com/useritems...tleBuilder.asp

It has a very "Ndoc" feel to it and seems to build very good help files.

Steve

"William Stacey [MVP]" <wi************ @gmail.comwrote in message
news:Of******** ******@TK2MSFTN GP02.phx.gbl...

That is OS for you. All you get is the requests for new features and
nobody
gives you anything. IMO, the guy should have charged $50 awhile back and
got a 2.0 version out a year ago. I would have bought it hands down. As
it
stands, someone still needs to put a UI on Sandcastle and integrate it
into
VS. That should not be too hard.

--
William Stacey [MVP]

"Brian Gideon" <br*********@ya hoo.comwrote in message
news:11******** *************@b 28g2000cwb.goog legroups.com...
|
| Mathieu Cartoixa wrote:
| The only NDoc developer said "I have decided to discontinue work on
| NDoc 2.0 and no longer participate in any open-source development
work."
| (source
| >
http://www.charliedigital.com/PermaL...cde5df9c.aspx).
| >
| With Sandcastle on the way, I do not see a very bright future for
NDoc.
| >
| Mathieu Cartoixa
|
| Well, I'm obviously mistaken. That's disappointing, but after reading
| that I don't blame the guy at all. I guess I'll move to GhostDoc or
| this Sandcastle thing. It looks like the CTP version of Sandcastle was
| release a couple of days ago. I hadn't even heard anything about it
| until you posted. Thanks for the tip.
|

Aug 31 '06 #10

Similar topics

1691

NDOC manual

by: Henrik Dahl | last post by:

Hello! I'm trying to use NDOC and definitely it seems like there are many comprehensible options to benefit from. Do some of you know if there is a manual for NDOC somewhere which makes it possible to actually understand and use the features of NDOC appropriately? Best regards,

C# / C Sharp

1619

NDoc - Hiding classes and members

by: David Anderson | last post by:

I'm using NDoc to generate help files from the C# code comments. I'm aware of the ability of NDoc to filter visibility by public/private/internal. My situation is that I'm generating doc for public members. However, I want to also exclude certain public classes and class members from the documentation file. Thanks in advance ...

C# / C Sharp

2602

Excluding some Public Classes in NDoc

by: Ash Moollan [InfoMaster] | last post by:

Hi there, I am using NDOC to generate docs for one C# project which I wrote. My assembly has some public classes that are not meant to be used by others and I have not documented them. I would like NDOC not to generate documentation for those public classes that do not have an XML documentation. Can anyone suggest how I do that? All help much appreciated

C# / C Sharp

1426

Ndoc: tags inside the methods

by: julien | last post by:

Hello, I posted this question on the NDoc-user mailing list, but it looks like a dead list (no messages for 10 days!). I'd like to use NDoc tags or custom tags inside methods like: void Mymethod() { ..... <mytag>...</mytag> .... }

C# / C Sharp

2241

Replacement for NDoc?

by: J.Marsch | last post by:

Hello: Since NDoc does not seem to support .Net 2.0, (and the project seems to be inactive), what are the other alternatives out there for producing HTML documents from XML Comments in C# 2.0 code?

C# / C Sharp

1573

ndoc and/or HTML help link to other chm

by: Pakmanoncrack | last post by:

The software company I work for creates 4 chm files from c# code with ndoc and then combines them into a fifth chm file by merging through html help. This is all done through a dos build and there are no manual steps between each process. We need it to stay that way. Here is the problem: a few classes found in one of the chm files (we will call it a.chm) use an object that is found in another chm file(b.chm). Since ndoc created the chm...

C# / C Sharp

3031

NDoc for .NET Framework 2.0

by: Lonifasiko | last post by:

I need something like NDoc that supports .NET Framework 2.0? I've downloaded last NDoc but did not work with 2.0 assemblies. Also googled deep enough to find this URL that seems to be down: http://ndoc.sourceforge.net/wiki/dotNet_2.0_Support Any other ideas?

C# / C Sharp

1859

NDoc in Visual Studio 2005

by: Kuldeep | last post by:

Framework: Visual Studio 2005 Technology: ASP.NET 2.0 Language: C#.NET 2.0 Hi All, Could any one of you please let me know how to use NDoc in Visual Studio 2005. If there is a source where I can find step by step information, I would be greatly obliged.

ASP.NET

4563

NDOC add-on for VB.NET

by: Peter Lykkegaard | last post by:

Hi gotdotnet is being phased out Anyone knows where I get a copy of the NDOC add-on for VB.NET? Yeah I know about time to move on and start using VS 2005 :) tia/Peter (repost from m.p.d.framework)

Visual Basic .NET

9621

What is ONU?

by: marktang | last post by:

ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...

General

10264

Problem With Comparison Operator <=> in G++

by: Oralloy | last post by:

Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...

C / C++

10106

Maximizing Business Potential: The Nexus of Website Design and Digital Marketing

by: jinu1996 | last post by:

In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...

Online Marketing

10039

The easy way to turn off automatic updates for Windows 10/11

by: Hystou | last post by:

Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...

Windows Server

9914

Discussion: How does Zigbee compare with other wireless protocols in smart home applications?

by: tracyyun | last post by:

Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...

General

8937

AI Job Threat for Devs

by: agi2029 | last post by:

Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...

Career Advice

5355

Trying to create a lan-to-lan vpn between two differents networks

by: TSSRALBI | last post by:

Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...

Networking - Hardware / Configuration

5484

Windows Forms - .Net 8.0

by: adsilva | last post by:

A Windows Forms form does not have the event Unload, like VB6. What one acts like?

Visual Basic .NET

2851

Comprehensive Guide to Website Development in Toronto: Expert Insights from BSMN Consultancy

by: bsmnconsultancy | last post by:

In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

General