ndoc3-users Mailing List for NDoc3

The following forum message was posted by ekwus at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

Hey guys

Thanks for making this work with 4.0 saved my sooo much time.

Cheers

Dave

The following forum message was posted by  at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

Install svn.
Run following in commandline to check out the latest source:
svn co https://ndoc3.svn.sourceforge.net/svnroot/ndoc3 ndoc3 

You could browse latest source code after login source
forge:https://sourceforge.net/projects/ndoc3/develop

The following forum message was posted by postonoh at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

Where can I find the source files

The following forum message was posted by m4rc3lo at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4544161:

I don't know if this is the best place to talk about it, but ... lets go...

When I try to create a documentation for my project I get an erro (nullrefernce)
in his line ~\trunk\src\Core\Core\Reflection\ExternalXmlSummaryCache.cs : 308
This occur because the fullname is null.
I changed this line: 

string key = memberType + declaringType.FullName.Replace("+", ".") + "."
+ memberName;

for this.

string key = "";
            if (string.IsNullOrEmpty(declaringType.FullName))
                key = memberType + (declaringType.Namespace + "."
+ declaringType.Name).Replace("+", ".") + "." + memberName;
            else
                key = memberType + declaringType.FullName.Replace("+", ".")
+ "." + memberName;

And this worked for me

Thanks


-------------------------------------
http://desenvolvedores.net

The following forum message was posted by  at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

Thanks @travor2006 - that fixed one issue for me.

Also running on 64 bit Win 7 and found i had to change "ProgramFiles" to
"ProgramFilesX86" in HtmlHelp.cs in the HtmlHelpCompiler method.

The following forum message was posted by trevor2006 at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

Update:
I got the latest sources and compiled, using 2010. This needed fixing:
in ExternalXmlSummaryCache:
Note the "??string.Empty" added in the final line, to fix a NULL ref error.
Maybe an active developer can add that fix?

	public string GetSummary(string memberID, Type declaringType) {
			//extract member type (T:, P:, etc.)
			string memberType = memberID.Substring(0, 2);

			//extract member name
			int i = memberID.IndexOf('(');
			string memberName = i > -1 ? memberID.Substring(memberID.LastIndexOf('.',
i) + 1)
				: memberID.Substring(memberID.LastIndexOf('.') + 1);

			//the member id in the declaring assembly
			string key = memberType + declaringType.FullName??string.Empty.Replace("+",
".") + "." + memberName;

With this fix, I documented aboout 25 dlls in 10 minutes, all of which are .net
4.0.

The following forum message was posted by trevor2006 at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

Same here.
It looks like a test was done on "recompiling a .net 3.5 app with VS2010", which
would work, as the framework is the same.
However, the latest published beta only permits frameworks up to 3.5 to be selected,
and was most likely compiled against the 3.5 framework, so: It is not able to
"reflect" into the .net 4.0 code.
If the sources are recompiled against framework 4, and framework 4 is added
to the list in configuration, this may go a long way to addressing this.
There is clearly other work (needed or in progress) for new features in .net
4, but:
Can we please have a build which at least loads .net 4 dlls?

The following forum message was posted by jefftheaton at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/4004885:

I am trying to use NDoc on a project that I upgraded from Visual Studio 2008
to 2010.  Everything worked find on 2008, but with 2010, I get:

Could not load file or assembly
'c:\tools\cruisecontrol\projects\cs-encog-core\stage\src\encog-core-cs\bin\relea
se\encog-core-cs.dll' or one of its dependencies. This assembly is built by
a runtime newer than the currently loaded runtime and cannot be loaded.



Exception: NDoc3.Core.DocumenterException

Could not load file or assembly
'c:\tools\cruisecontrol\projects\cs-encog-core\stage\src\encog-core-cs\bin\relea
se\encog-core-cs.dll' or one of its dependencies. This assembly is built by
a runtime newer than the currently loaded runtime and cannot be loaded.



Exception: System.BadImageFormatException

Could not load file or assembly
'c:\tools\cruisecontrol\projects\cs-encog-core\stage\src\encog-core-cs\bin\relea
se\encog-core-cs.dll' or one of its dependencies. This assembly is built by
a runtime newer than the currently loaded runtime and cannot be loaded.

The following forum message was posted by xharzej at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3917830:

Sorry for the late reply currently the only way to get the source is to download
it from the Subversion repository

The following forum message was posted by shato69 at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3917830:

Hi, is there any wey I can get my hands on the source code? or get some kind
of support to compile the help in another language for example spanish? this
is exactly the tool I need, but my clients want the help files in spanish, so
I would like to replace the words Methods, classes, Properties etc to spanish

The following forum message was posted by xharzej at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3727655:

The suggestion made by devbasta would work. But a more clean approach would to to the following:
/// <exclude />
public class ToBeExcluded

The following forum message was posted by devbasta at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3727655:

add this attribute to the class
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]

The following forum message was posted by Anonymous at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3727655:

HI,

I must say, this is a great tool. 

I have 4 classes in my assembly, how ever, I just want documentation for one class. Is there a way I can hide the other classes or maybe i could generate the documentation for the one class only.

Regards

The following forum message was posted by xharzej at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3691258:

The XmlDoc files aren\'t necessary, but it will only provided you with minimal documentation.

The following forum message was posted by Anonymous at http://sourceforge.net/projects/ndoc3/forums/forum/763824/topic/3691258:

I experimented with generating documentation for a project that does not have a doc.xml file (the code base is lacking over 5000 xml help comments and I don\'t have time/permission to add them ).  I created a minimal file with just the name of the assembly.  NDoc3 did a Stirling job of creating the required help. 

I'm looking at install automation of my project, and I have ndoc generating the .chm file as well as the MSDN style.  The question is, how do I integrate the MSDN style into the MSDN library on the end computer (i.e. what native VS2008 shell command do I need to run to merge these libraries)?

Gary Smith

Hello, 

I've been using ndoc3 for a short while to generate our help files and it seems to work great.  What I would like to do is add some additional content as part of the documentation build process.  For example, more complete samples, maybe some developer nodes (for the overall documentation).  The only way I have found to do this is to stuff all of it in the comments for one of the top level classes/namespaces, but for this to be effective, the user must know its there.

Is there a way to squeeze addition non-documentation related items into the process?

Gary Smith

Read and respond to this message at: 
https://sourceforge.net/forum/message.php?msg_id=5754123
By: xharzej

Hi Steven,

I've added you as a developer. We are glad to have any help we can get. Please
send me an email, please post what you will work on in the developers forum,
or make a post and we can discuss "assignments"

______________________________________________________________________
You are receiving this email because you elected to monitor this forum.
To stop monitoring this forum, login to SourceForge.net and visit: 
https://sourceforge.net/forum/unmonitor.php?forum_id=763824

Read and respond to this message at: 
https://sourceforge.net/forum/message.php?msg_id=5752916
By: sthiakos

I have the exact same sentiments - waiting on update, wanting to help out.

I can't believe you 9 guys developed a useful tool that an MS team convoluted.

I'll contrib where I can


______________________________________________________________________
You are receiving this email because you elected to monitor this forum.
To stop monitoring this forum, login to SourceForge.net and visit: 
https://sourceforge.net/forum/unmonitor.php?forum_id=763824

Read and respond to this message at: 
https://sourceforge.net/forum/message.php?msg_id=5318487
By: xharzej

Hi Thierry

It great to see that there is an interest in the project. Unfortunately I can
tell you that there is a couple of things which does not work. Fx. nullable
types aren't implemented fully yet, also only C# syntax are supported. But it
will be a great way to get feedback. If you will try to use NDoc3 to do this,
you should get the current trunk from SVN, as some serious problems have been
discovered in Beta 1. One of the problems include an error when all methods,
fields, properties, etc. haven't been documented.
I'll expected Beta 2 will be released in a couple of weeks, this release should
include full support for C# syntax, and partial support for VB syntax.

______________________________________________________________________
You are receiving this email because you elected to monitor this forum.
To stop monitoring this forum, login to SourceForge.net and visit: 
https://sourceforge.net/forum/unmonitor.php?forum_id=763824

Read and respond to this message at: 
https://sourceforge.net/forum/message.php?msg_id=5318430
By: tparis

I have a very big project, developped by tenth of peoples, with thousands of
code files, two solutions of more than one hundred of projects, managed or not.
I will try to generate the doc with NDoc3. If its pass the test, it will be
a great step !

______________________________________________________________________
You are receiving this email because you elected to monitor this forum.
To stop monitoring this forum, login to SourceForge.net and visit: 
https://sourceforge.net/forum/unmonitor.php?forum_id=763824