ndoc-users — Discussions about using NDoc

[Ndoc-users] Custom tags

[Julien S. <ju...@so...>]

Hello,
Does this file that defines custom tags look OK to you? I create errors
when I use it with NDoc running as a NAnt task under Mono/Linux:
Error building documentation.
    Error compiling the namespace stylesheet
        Error compiling the namespace stylesheet
            Can not access URI res:/tmp/CustomTags.xslt res:tags.xslt
line 5, position 3 res:tags.xslt line 5, position 3


<?xml version="1.0" encoding="UTF-8" ?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

	<xsl:template match="ndoc" mode="header-section">
              <style type="text/css">
                     .red
                     {
                            color:red;
                     }
              </style>
    </xsl:template>



    <!--
		Original writer of the class
	-->
    <xsl:template match="owner" mode="seealso-section">
			<h4 class="dtH4">Original writer:</h4>
				<p><a href="mailto:{.}@xxxx"><xsl:value-of select="."/></a></p>		
	</xsl:template>
	
	
	<!--
		Current maintainer of the class
	-->
    <xsl:template match="maintainer" mode="seealso-section">
			<h4 class="dtH4">Maintainer:</h4>
				<p><a href="mailto:{.}@xxxx"><xsl:value-of select="."/></a></p>
	</xsl:template>
	
	
	<!--
		People who reviewed this class
	-->
    <xsl:template match="reviewer" mode="seealso-section">
			<h4 class="dtH4">Reviewer:</h4>
				<p><xsl:choose>
					<xsl:when test="string-length( . ) = 0">none</xsl:when>
					<xsl:otherwise><a href="mailto:{.}@xxxxx"><xsl:value-of
select="."/></a></xsl:otherwise>
				</xsl:choose></p>
	</xsl:template>
	
	
	<!--
		To do
	-->
    <xsl:template match="todo" mode="seealso-section">
			<h4 class="dtH4">Todo:</h4>
				<p class="red"><xsl:value-of select="."/></p>
	</xsl:template>
	
	
	<!--
		References: URLs, book, wiki, etc.
	-->
    <xsl:template match="reference" mode="seealso-section">
			<h4 class="dtH4">Reference:</h4>
				<p><xsl:value-of select="."/></p>
	</xsl:template>

</xsl:stylesheet>


Thank you
Julien

[Ndoc-users] Please ignore

[Jeremiah V. <jer...@gm...>]

Just a test ping to the list to see what the headers will look like. :)

--
533777336444244

[Ndoc-users] javadoc support for ndoc

[Ter E. <mt...@gm...>]

Hi

I am quite new to NDoc and would like to know if it supports "javadoc" for
C# Project (which i am developing on .NET 2003).
I found it in the option, but whenever i build, i got this error....

Building documentation...
Building documentation...
An error occured while trying to build the documentation.



Exception: System.Xml.Xsl.XsltCompileException
file:///D:/Workspace/VisualStudio/ConsoleApplication1/NDoc.Core/JavaDoc/ndo=
c_javadoc_temp/ndoc_resources/xslt/overview-summary.xslt(4,3):


Exception: System.Xml.XmlException
'doc' is an undeclared namespace. Line 551, position 43.



Exception: System.Xml.Xsl.XsltCompileException
   at System.Xml.Xsl.Compiler.Compile(NavigatorInput input, XmlResolver
xmlResolver, Evidence evidence)
   at System.Xml.Xsl.XslTransform.Compile(XPathNavigator stylesheet,
XmlResolver resolver, Evidence evidence)
   at System.Xml.Xsl.XslTransform.Load(String url, XmlResolver resolver)
   at System.Xml.Xsl.XslTransform.Load(String url)
   at NDoc.Documenter.JavaDoc.JavaDocDocumenter.TransformAndWriteResult(Str=
ing
transformFilename, XsltArgumentList args, String resultDirectory, String
resultFilename)
   at NDoc.Documenter.JavaDoc.JavaDocDocumenter.WriteOverviewSummary()
   at NDoc.Documenter.JavaDoc.JavaDocDocumenter.Build(Project project)
   at NDoc.Gui.BuildWorker.ThreadProc()

Exception: System.Xml.XmlException
   at System.Xml.XmlNSAttributeTokenInfo.FixNames()
   at System.Xml.XmlTextReader.ParseElement()
   at System.Xml.XmlTextReader.Read()
   at System.Xml.XmlValidatingReader.ReadNoCollectTextToken()
   at System.Xml.XmlValidatingReader.Read()
   at System.Xml.XPath.XPathDocument.ReadChildNodes(XPathContainer parent,
String parentBaseUri, XmlReader reader, PositionInfo positionInfo)
   at System.Xml.XPath.XPathDocument.ReadChildNodes(XPathContainer parent,
String parentBaseUri, XmlReader reader, PositionInfo positionInfo)
   at System.Xml.XPath.XPathDocument.Load(XmlReader reader)
   at System.Xml.Xsl.Compiler.LoadDocument(XmlTextReader reader)
   at System.Xml.Xsl.Compiler.ResolveDocument(Uri absoluteUri)
   at System.Xml.Xsl.ContainerAction.CompileInclude(Compiler compiler)
   at System.Xml.Xsl.ContainerAction.CompileTopLevelElements(Compiler
compiler)
   at System.Xml.Xsl.ContainerAction.CompileDocument(Compiler compiler,
Boolean inInclude)
   at System.Xml.Xsl.RootAction.Compile(Compiler compiler)
   at System.Xml.Xsl.Compiler.CreateRootAction()
   at System.Xml.Xsl.Compiler.Compile(NavigatorInput input, XmlResolver
xmlResolver, Evidence evidence)


Regards
Terence

Re: [Ndoc-users] NDoc and VS2005

[si <ssh...@gm...>]

Hi again,

> Regarding CVS/Subversion, well, I guess I come from the old school, and I=
'm
> quite happy with CVS.  I've looked at Subversion before, and the setup /
> figuring out how it works seems a bit daunting--I'd rather figure out how=
 to
> get NDoc working than spend time shifting to SVN

Fair enough, I guess I come from the other way around
(lots of SVN work in the last 2-3 years, little CVS work),
but who cares so long as we can have NDoc generics! :)

> I'm also not sure the SVN add-in for VS works with VS2005.

It does, but you have to use a recent build:

http://ankhsvn.tigris.org/servlets/ProjectDocumentList?folderID=3D4013

It's not as mature as TortoiseSVN though.

> So....I'll poke around the NDoc code and wait until I here from Kevin and
> hopefully get added to the devs list.

Sounds good, please let us know when you need extra hands.

peace
si

Re: [Ndoc-users] NDoc and VS2005

[Marc C. <mar...@gm...>]

Hello si,

Hmmm.  I didn't even realize there was an NDoc2!  I looked at the files in
the CVS tree, and the project seems incomplete, or I'm missing
something--maybe the NDoc2 solution links back to NDoc files.

In any case, I sent an email to Kevin requesting to be a developer so I can
work on the project with an official account.

Regarding CVS/Subversion, well, I guess I come from the old school, and I'm
quite happy with CVS.  I've looked at Subversion before, and the setup /
figuring out how it works seems a bit daunting--I'd rather figure out how t=
o
get NDoc working than spend time shifting to SVN, as it definitely is not m=
y
expertise.  I'm also not sure the SVN add-in for VS works with VS2005.  The
last time I tried it for VS2003, it pretty much didn't work--I ended up
using TortoiseSVN, which was great, and at least somewhat familiar ground,
as I use TortoiseCVS for all my projects (personal and client's).

So....I'll poke around the NDoc code and wait until I here from Kevin and
hopefully get added to the devs list.

Marc


On 1/9/06, si <ssh...@gm...> wrote:
>
> Hi Marc,
>
> Firstly, i'm sure i'm not alone in saying thank you for picking up the
> NDoc2 ball!
>
> I can't offer guidance on CVS tree structure, but have you read this?
>
>
> http://sourceforge.net/mailarchive/forum.php?thread_id=3D8415964&forum_id=
=3D38707
>
> It may save time if Kevin already has some code in the pipeline
> that he could handball.
>
> If there's an VS2005 version of NDoc2 (I don't own VS2003), i'll try and
> help out where possible.  Can't promise too much of my time (my 4 month
> old son gobbles most of it!) but if there's someone willing to co-ordinat=
e
> the workload, perhaps others who have a vested interest in NDoc2 might
> also stick there hands up to help out?
>
> Finally, if you're starting up a new branch/tree of CVS, is it worth
> considering
> a move to Subversion if Sourceforge will let us?  TortoiseSVN is great,
> and the
> VS addin Ankh (using the recent dev build) seems okay.  Looking forward,
> CVS is on the wane and SVN on the rise, so the timing might be right?
>
> Thanks again.
>
> peace
> si
>



--
Marc
www.marcclifton.com

Re: [Ndoc-users] NDoc and VS2005

[si <ssh...@gm...>]

Hi Marc,

Firstly, i'm sure i'm not alone in saying thank you for picking up the
NDoc2 ball!

I can't offer guidance on CVS tree structure, but have you read this?

http://sourceforge.net/mailarchive/forum.php?thread_id=3D8415964&forum_id=
=3D38707

It may save time if Kevin already has some code in the pipeline
that he could handball.

If there's an VS2005 version of NDoc2 (I don't own VS2003), i'll try and
help out where possible.  Can't promise too much of my time (my 4 month
old son gobbles most of it!) but if there's someone willing to co-ordinate
the workload, perhaps others who have a vested interest in NDoc2 might
also stick there hands up to help out?

Finally, if you're starting up a new branch/tree of CVS, is it worth consid=
ering
a move to Subversion if Sourceforge will let us?  TortoiseSVN is great, and=
 the
VS addin Ankh (using the recent dev build) seems okay.  Looking forward,
CVS is on the wane and SVN on the rise, so the timing might be right?

Thanks again.

peace
si

Re: [Ndoc-users] compiled help format on linux

[simon g. <sg...@gm...>]

OK - got the source checked out, but it could be a while before I can look
at this.

I guess it's the stuff in ndoc I need to look at, rather than ndoc2?

On 1/7/06, Kevin Downs <nd...@kd...> wrote:
>
> This is very cool news :-)
>
> I'm probably not the best person to make the desired modifications as my
> unix skills are *very* rusty (I think the last time I did any serious wor=
k
> on a *nix variant was AIX 4 back in about 1993!), and I wouldn't be able =
to
> test the changes... but if someone does the coding/testing I'll be happy =
to
> drop the changes into the CVS.
>
> The documenter currently uses both the registry and the "program files"
> special folder path to locate the hhc exe on windows system (in
> HtmlHelp.cs). This code would obviously need to be conditionally removed
> for mono builds, as it doesn't support either method! NDoc does support t=
he
> use of a config file as a 'fall-back' option if the previous two methods
> fail. In the current implementation, this config file would
> be called something like "/usr/shared/NDoc.1.3/settings.xml" and should b=
e
> fairly easy to set-up, given the appropriate instructions :-)
>
> The config file should look like this,
>
> <?xml version=3D"1.0"?>
> <setttings SchemaVersion=3D"1.3">
>   <compilers>
>     <htmlHelpWorkshopLocation>*full path to hhc path goes here*
> </htmlHelpWorkshopLocation>
>   </compilers>
> </setttings>
>
> [note the current mis-spelling of the 'settings' tag! :-( ]
>
> hope this helps,
> Kevin
>
>
>  ------------------------------
> *From:* ndo...@li... [mailto:
> ndo...@li...] *On Behalf Of *simon godden
> *Sent:* Sunday, 8 January 2006 8:47 AM
> *To:* ndo...@li...
> *Subject:* [Ndoc-users] compiled help format on linux
>
> Hi,
>
> The compiled help format bombs out on linux saying that it is not
> available on unix platforms.
>
> Fairly understandable.
>
> But actually, HTML Help Workshop works fine under linux (at least on FC4)=
,
> using wine.  See the instructions at
>
> http://htmlhelp.berlios.de/howto/mshh4wine.php
>
> I followed these without problems, and compiled a project successfully.
>
> In addition, there is a GTK-based .chm viewer which also works fine.  See
> the instructions at
>
> http://fedoranews.org/mediawiki/index.php/Setting_up_GnoCHM_reader_on_FC4
>
> Can I suggest that the msdn documentation generator is changed to simply
> check for the existence of a command ' hhc.exe' and, if it exists,
> continue with the generation, and not bomb out?
>
> Then, all the linux user has todo is to set up an alias of 'hhc.exe' to
> the necessary wine invocation.
>
> If necessary, I'll look into doing this myself, but it would be luvverly
> if the maintainer would just pop it in :)
>
> --
> Simon Godden
>
>


--
Simon Godden

[Ndoc-users] NDoc and VS2005

[Marc C. <mar...@gm...>]

Hi all,

I have version of NDoc compiled and running under VS2005.  That wasn't the
hard part.  :)

As I'd like to contribute to NDoc, I have two questions:  first, should
there be a separate CVS tree for the VS2005 version?  Besides the csproj an=
d
sln files not being VS2003 compatible, there are deprecated/obsoleted
methods that need to be upgraded to VS2005.

Second, I'd like to see what's involved in adding support for generics.
Again, this is .C# 2.0 specific, so it seems a separate CVS tree is in
order.

Can someone provide me with some guidance on how they'd like the CVS tree
set up for VS2005 development?

Thanks!

--
Marc
www.marcclifton.com

RE: [Ndoc-users] compiled help format on linux

[Kevin D. <nd...@kd...>]

This is very cool news :-)
 
I'm probably not the best person to make the desired modifications as my
unix skills are *very* rusty (I think the last time I did any serious work
on a *nix variant was AIX 4 back in about 1993!), and I wouldn't be able to
test the changes... but if someone does the coding/testing I'll be happy to
drop the changes into the CVS.
 
The documenter currently uses both the registry and the "program files"
special folder path to locate the hhc exe on windows system (in
HtmlHelp.cs). This code would obviously need to be conditionally removed for
mono builds, as it doesn't support either method! NDoc does support the use
of a config file as a 'fall-back' option if the previous two methods fail.
In the current implementation, this config file would be called something
like "/usr/shared/NDoc.1.3/settings.xml" and should be fairly easy to
set-up, given the appropriate instructions :-)
 
The config file should look like this,
 
<?xml version="1.0"?>
<setttings SchemaVersion="1.3">
  <compilers>
    <htmlHelpWorkshopLocation>full path to hhc path goes
here</htmlHelpWorkshopLocation>
  </compilers>
</setttings>
 
[note the current mis-spelling of the 'settings' tag! :-( ]
 
hope this helps,
Kevin
 


  _____  

From: ndo...@li...
[mailto:ndo...@li...] On Behalf Of simon godden
Sent: Sunday, 8 January 2006 8:47 AM
To: ndo...@li...
Subject: [Ndoc-users] compiled help format on linux


Hi,

The compiled help format bombs out on linux saying that it is not available
on unix platforms.

Fairly understandable.

But actually, HTML Help Workshop works fine under linux (at least on FC4),
using wine.  See the instructions at 

http://htmlhelp.berlios.de/howto/mshh4wine.php

I followed these without problems, and compiled a project successfully.

In addition, there is a GTK-based .chm viewer which also works fine.  See
the instructions at 

http://fedoranews.org/mediawiki/index.php/Setting_up_GnoCHM_reader_on_FC4

Can I suggest that the msdn documentation generator is changed to simply
check for the existence of a command ' hhc.exe' and, if it exists, continue
with the generation, and not bomb out?

Then, all the linux user has todo is to set up an alias of 'hhc.exe' to the
necessary wine invocation.

If necessary, I'll look into doing this myself, but it would be luvverly if
the maintainer would just pop it in :) 

-- 
Simon Godden 

[Ndoc-users] compiled help format on linux

[simon g. <sg...@gm...>]

Hi,

The compiled help format bombs out on linux saying that it is not available
on unix platforms.

Fairly understandable.

But actually, HTML Help Workshop works fine under linux (at least on FC4),
using wine.  See the instructions at

http://htmlhelp.berlios.de/howto/mshh4wine.php

I followed these without problems, and compiled a project successfully.

In addition, there is a GTK-based .chm viewer which also works fine.  See
the instructions at

http://fedoranews.org/mediawiki/index.php/Setting_up_GnoCHM_reader_on_FC4

Can I suggest that the msdn documentation generator is changed to simply
check for the existence of a command 'hhc.exe' and, if it exists, continue
with the generation, and not bomb out?

Then, all the linux user has todo is to set up an alias of 'hhc.exe' to the
necessary wine invocation.

If necessary, I'll look into doing this myself, but it would be luvverly if
the maintainer would just pop it in :)

--
Simon Godden

[Ndoc-users] NDoc2?

[Derrick, S. <Sal...@su...>]

	Kevin,=20

	I was wondering if you might be able to give me (us) an update
on the status of NDoc2.  I don't want to put more pressure on you (even
you deserve a life). ;-)=20

	I have a major release of our product scheduled for end of
March. We've used Ndoc to create the API docs for the last three
releases, but we upgraded to .NET 2.0 this time.  If NDoc2 is not going
to be ready in time, I need to start looking for an alternative. =20

	Sally
=09

[Ndoc-users] problems with add xslt file to the ndoc project

[Francisco J. M. R. <mar...@hi...>]

=20

Hi=20

=20

I am working with ndoc, and I want to implement a XSLT file to my ndoc
Project, but when I build the project is show me the next error:

=20

=93The wrong namespace was used for XSL. Use
'http://www.w3.org/1999/XSL/Transform'.=94

=20

My xslt file has the name space for the xsl:

<stylesheet version=3D"1.0" =
xmlns:xsl=3D'http://www.w3.org/1999/XSL/Transform'=20

      xmlns:MSHelp=3D'http://msdn.microsoft.com/mshelp' >

=20

=20

So I don=92t know what could be the problem. I hope you can help me.

=20

Thank you in advance.

Best regards.

Francisco Javier M=E1rquez Reyna
Hildebrando Software Factory

Sierra de las Palomas 101-101
Col. Bosques del Prado
20127 Aguascalientes, Ags.
Tel +52 449 996-1500=20
Fax +52 449 996-3666
Email:  <mailto:mar...@hi...> mar...@hi...

msn:  <mailto:ale...@ho...> fco...@ho...

=20

=20

Re: [Ndoc-users] Is NDoc Alive?

[Cory N. <ph...@gm...>]

ndoc should work with vs2003.  afaik the devs are too swamped with
Real Life to add support for vs2005 right now.

On 12/29/05, Bradley Ward <bw...@co...> wrote:
>
>
>
> Hello,
>
>
>
> I downloaded NDoc a couple of days back and tried to use it with Visual
> Studio 2003, but it did not seem to work (no add-in to VS appeared, the
> *.exe that you run did not exist, etc.). Then I studied ndoc.sourceforge.=
net
> for cluse on use with VS 2003 and VS 2005/.Net 2.0, and did not find any
> recent postings or news of anything.
>
>
>  Is this project still alive?
>
>
>
> Any idea of when NDoc might work with current technologies (VS 2005, .Net
> 2.0, etc.)
>
>
>
> Thanks,
>
>
>  Brad
>
>


--
Cory Nelson
http://www.int64.org

[Ndoc-users] Is NDoc Alive?

[Bradley W. <bw...@co...>]

Hello,

=20

I downloaded NDoc a couple of days back and tried to use it with Visual
Studio 2003, but it did not seem to work (no add-in to VS appeared, the
*.exe that you run did not exist, etc.). Then I studied
ndoc.sourceforge.net for cluse on use with VS 2003 and VS 2005/.Net 2.0,
and did not find any recent postings or news of anything.


Is this project still alive?

=20

Any idea of when NDoc might work with current technologies (VS 2005,
.Net 2.0, etc.)

=20

Thanks,


Brad

=20

[Ndoc-users] ndoc support for dotnet 2.0

[Paul W. <pw...@lo...>]

Hi,

=20

What is the status of support for dotnet 2.0 in NDoc?  Is there a todo
list?  I'm willing to contribute time to the project to get support for
2.0 going.

=20

Thanks

~ Paul

=20

[Ndoc-users] NDoc failing with 2005 GA assemblies

[<mar...@sy...>]

Hi

I'm using NDoc 1.3.1 to build .HxS and .chm files from VS .NET 2005
assemblies (using a config file to set the supportedRuntime version to
v2.0.50727). It was working well during the .NET beta, but when we switched
from the .NET beta build to the GA build, NDoc started failing when it
reached the sixth topic in the file with the following error:

   Generating HTML...
   ndocSybaseDataWindowWeb_90235722.html
   ndocSybaseDataWindowWebHierarchy_90235722.html
   ndocSybaseDataWindowWebAfterPerformActionEventArgsClassTopic_857bee76.html
   ndocSybaseDataWindowWebAfterPerformActionEventArgsClassMembersTopic_857bee76.html
   ndocSybaseDataWindowWebAfterPerformActionEventArgsClassPropertiesTopic_857bee76.html
   ndocSybaseDataWindowWebAfterPerformActionEventArgsClassActionTopic_4f1189e2.html
   Error: NDoc.Core.DocumenterException
   An error occured while creating the documentation
   Error: System.Xml.XPath.XPathException
   Expression must evaluate to a node-set.

      at
   NDoc.Documenter.NativeHtmlHelp2.NativeHtmlHelp2Documenter.Build(Project
   project)
      at NDoc.ConsoleApplication.EntryPoint.Main(String[] args)
   Error: NDoc.Core.DocumenterException
   An error occured while creating the documentation
   Error: System.Xml.XPath.XPathException
   Expression must evaluate to a node-set.

      at
   NDoc.Documenter.NativeHtmlHelp2.NativeHtmlHelp2Documenter.Build(Project
   project)
      at NDoc.ConsoleApplication.EntryPoint.Main(String[] args)

I have tried this on two separate assemblies, and modified the comments
file to exclude the topics on which the failure occurred, but it always
fails on the sixth topic, whatever its content. The CHM build runs to
completion. Does anyone have any suggestions?

Thanks
Marilyn

[Ndoc-users] Custom tags

[Julien S. <ju...@so...>]

Hello,
Does this file that defines custom tags look OK to you? I create errors
when I use it with NDoc running as a NAnt task under Mono/Linux:

<?xml version="1.0" encoding="UTF-8" ?>
<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

	<xsl:template match="ndoc" mode="header-section">
              <style type="text/css">
                     .red
                     {
                            color:red;
                     }
              </style>
    </xsl:template>



    <!--
		Original writer of the class
	-->
    <xsl:template match="owner" mode="seealso-section">
			<h4 class="dtH4">Original writer:</h4>
				<p><a href="mailto:{.}@xxxx"><xsl:value-of select="."/></a></p>		
	</xsl:template>
	
	
	<!--
		Current maintainer of the class
	-->
    <xsl:template match="maintainer" mode="seealso-section">
			<h4 class="dtH4">Maintainer:</h4>
				<p><a href="mailto:{.}@xxxx"><xsl:value-of select="."/></a></p>
	</xsl:template>
	
	
	<!--
		People who reviewed this class
	-->
    <xsl:template match="reviewer" mode="seealso-section">
			<h4 class="dtH4">Reviewer:</h4>
				<p><xsl:choose>
					<xsl:when test="string-length( . ) = 0">none</xsl:when>
					<xsl:otherwise><a href="mailto:{.}@xxxxx"><xsl:value-of
select="."/></a></xsl:otherwise>
				</xsl:choose></p>
	</xsl:template>
	
	
	<!--
		To do
	-->
    <xsl:template match="todo" mode="seealso-section">
			<h4 class="dtH4">Todo:</h4>
				<p class="red"><xsl:value-of select="."/></p>
	</xsl:template>
	
	
	<!--
		References: URLs, book, wiki, etc.
	-->
    <xsl:template match="reference" mode="seealso-section">
			<h4 class="dtH4">Reference:</h4>
				<p><xsl:value-of select="."/></p>
	</xsl:template>

</xsl:stylesheet>


Thank you
Julien

[Ndoc-users] Namespaces in a tree

[Julien S. <ju...@so...>]

Hello,
right now, all my namespaces are displayed in a flat list:
+ A
+ A.B
+ A.B.C
+ A.C
+ B

How can I display them in a tree like this:
+ A
  + A.B
    + A.B.C
  + A.C
+ B


Thank you

[Ndoc-users] How was the NDoc user guide created?

[Nofelt, P. \(US - N. York\) <pn...@de...>]

Hey All,

I'm a bit new to Ndoc, but very excited about its potential.=20

My question is regarding the Ndoc User Guide
(http://ndoc.sourceforge.net/usersguide.html). Was this documentation
created using Ndoc? And if so, how?=20

I ask because would love to use Dnoc not just for documenting code, but
also to include other documentation (like coding standards, to use
version control software X, ...).

Thanks,
Peter=20


This message (including any attachments) contains confidential =
information intended for a specific individual and purpose, and is =
protected by law.  If you are not the intended recipient, you should =
delete this message.=20


Any disclosure, copying, or distribution of this message, or the taking =
of any action based on it, is strictly prohibited. [v.E.1]

RE: [Ndoc-users] Problem with Ndoc

[Schouten R. <ry...@ya...>]

I am using version 1.2.5 and I noticed that as well
and I changed the xml to add in the namespace and NDoc
still doesn't pick it up.

Ryan

--- Kevin Downs <kd...@op...> wrote:

> The xml is wrong - looks like a classic VBCommenter
> problem :-(
> 
> The parameters in the method signature should
> include the namespace. For
> example, System.String rather than just String.
> 
> I thought this had been sorted out in VBCommenter
> v1.2.5 - make sure you are
> using the latest version!
> 
> 
> Regards,
> Kevin
>  
> 
> -----Original Message-----
> From: ndo...@li...
> [mailto:ndo...@li...] On
> Behalf Of Bill Swallow
> Sent: Thursday, 17 November 2005 10:43 AM
> To: Schouten Ryan
> Cc: ndo...@li...
> Subject: Re: [Ndoc-users] Problem with Ndoc
> 
> The XML looks fine. Perhaps these methods are
> private and you have Ndoc set
> to not document private code? What does the source
> code for these methods
> look like?
> 
> On 11/16/05, Schouten Ryan <ry...@ya...>
> wrote:
> > I am using Ndoc to document my vb code and I am
> running into problems 
> > with a couple of methods. The xml code is there
> for the methods but 
> > for some reason Ndoc never picks up the
> documentation for these 
> > methods. The sections in question are included
> below.
> > Thank you for your help.
> >
> >
> >
> > <member
> >
>
name="M:eWork.Action.SubmitRequest(String,String,Boolean,String,Hashtable,St
> ring,String)">
> >      <summary>
> >  Submit request with hash.
> >  </summary>
> >  <param name="folderIDStr" />
> >  <param name="actionStr" />
> >  <param name="noLayout" />
> >  <param name="version" />
> >  <param name="fields" />
> >  <param name="serverData" />
> >  <param name="formStr" />
> >  <param name="FldInputData" />
> >  <remarks>
> >  </remarks>
> >  <history>
> >        [rschoute]      11/16/2005      Created
> >  </history></member>
> > <member
> >
>
name="M:eWork.List.getList(String,String,Integer,Integer)">
> >      <summary>
> >  GetList
> >  </summary>
> >  <param name="listType" />
> >  <param name="orderby" />
> >  <param name="whereStr" />
> >  <param name="page" />
> >  <param name="pagesize" />
> >  <returns />
> >  <remarks>
> >  </remarks>
> >  <history>
> >        [rschoute]      11/16/2005      Created
> >  </history></member>
> >
> >
> >
> >
> > __________________________________
> > Yahoo! Mail - PC Magazine Editors' Choice 2005
> http://mail.yahoo.com
> >
> >
> >
>
-------------------------------------------------------
> > This SF.Net email is sponsored by the JBoss Inc. 
> Get Certified Today
> > Register for a JBoss Training Course.  Free
> Certification Exam
> > for All Training Attendees Through End of 2005.
> For more info visit:
> >
>
http://ads.osdn.com/?ad_id=7628&alloc_id=16845&op=click
> > _______________________________________________
> > Ndoc-users mailing list
> > Ndo...@li...
> >
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
> >
> 
> 
> --
> Bill Swallow
> HATT List Owner
> WWP-Users List Owner
> 42.8162,-73.7736
> http://techcommdood.blogspot.com
> 
> 
>
-------------------------------------------------------
> This SF.Net email is sponsored by the JBoss Inc. 
> Get Certified Today
> Register for a JBoss Training Course.  Free
> Certification Exam
> for All Training Attendees Through End of 2005. For
> more info visit:
> http://ads.osdn.com/?ad_idv28&alloc_id845&opÌk
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
> 
> 



		
__________________________________ 
Yahoo! FareChase: Search multiple travel sites in one click.
http://farechase.yahoo.com

RE: [Ndoc-users] Problem with Ndoc

[Kevin D. <kd...@op...>]

The xml is wrong - looks like a classic VBCommenter problem :-(

The parameters in the method signature should include the namespace. For
example, System.String rather than just String.

I thought this had been sorted out in VBCommenter v1.2.5 - make sure you =
are
using the latest version!


Regards,
Kevin
=20

-----Original Message-----
From: ndo...@li...
[mailto:ndo...@li...] On Behalf Of Bill =
Swallow
Sent: Thursday, 17 November 2005 10:43 AM
To: Schouten Ryan
Cc: ndo...@li...
Subject: Re: [Ndoc-users] Problem with Ndoc

The XML looks fine. Perhaps these methods are private and you have Ndoc =
set
to not document private code? What does the source code for these =
methods
look like?

On 11/16/05, Schouten Ryan <ry...@ya...> wrote:
> I am using Ndoc to document my vb code and I am running into problems=20
> with a couple of methods. The xml code is there for the methods but=20
> for some reason Ndoc never picks up the documentation for these=20
> methods. The sections in question are included below.
> Thank you for your help.
>
>
>
> <member
>
name=3D"M:eWork.Action.SubmitRequest(String,String,Boolean,String,Hashtab=
le,St
ring,String)">
>      <summary>
>  Submit request with hash.
>  </summary>
>  <param name=3D"folderIDStr" />
>  <param name=3D"actionStr" />
>  <param name=3D"noLayout" />
>  <param name=3D"version" />
>  <param name=3D"fields" />
>  <param name=3D"serverData" />
>  <param name=3D"formStr" />
>  <param name=3D"FldInputData" />
>  <remarks>
>  </remarks>
>  <history>
>        [rschoute]      11/16/2005      Created
>  </history></member>
> <member
> name=3D"M:eWork.List.getList(String,String,Integer,Integer)">
>      <summary>
>  GetList
>  </summary>
>  <param name=3D"listType" />
>  <param name=3D"orderby" />
>  <param name=3D"whereStr" />
>  <param name=3D"page" />
>  <param name=3D"pagesize" />
>  <returns />
>  <remarks>
>  </remarks>
>  <history>
>        [rschoute]      11/16/2005      Created
>  </history></member>
>
>
>
>
> __________________________________
> Yahoo! Mail - PC Magazine Editors' Choice 2005 http://mail.yahoo.com
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by the JBoss Inc.  Get Certified Today
> Register for a JBoss Training Course.  Free Certification Exam
> for All Training Attendees Through End of 2005. For more info visit:
> http://ads.osdn.com/?ad_id=3D7628&alloc_id=3D16845&op=3Dclick
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
> https://lists.sourceforge.net/lists/listinfo/ndoc-users
>


--
Bill Swallow
HATT List Owner
WWP-Users List Owner
42.8162,-73.7736
http://techcommdood.blogspot.com


-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc.  Get Certified Today
Register for a JBoss Training Course.  Free Certification Exam
for All Training Attendees Through End of 2005. For more info visit:
http://ads.osdn.com/?ad_idv28&alloc_id=16845&op=CCk
_______________________________________________
Ndoc-users mailing list
Ndo...@li...
https://lists.sourceforge.net/lists/listinfo/ndoc-users

Re: [Ndoc-users] Problem with Ndoc

[Schouten R. <ry...@ya...>]

Here is the code in question for one of the methods.

'''
-----------------------------------------------------------------------------
    ''' <summary>
    ''' This is a test to see if this will document.
    ''' </summary>
    ''' <param name="folderID"></param>
    ''' <param name="action"></param>
    ''' <param name="layout"></param>
    ''' <param name="version"></param>
    ''' <param name="serverdata"></param>
    ''' <param name="formstr"></param>
    ''' <param name="inputData"></param>
    ''' <param name="field"></param>
    ''' <remarks>
    ''' </remarks>
    ''' <history>
    ''' 	[rschoute]	11/16/2005	Created
    ''' </history>
    '''
-----------------------------------------------------------------------------
    Public Sub SubmitRequest(ByVal folderIDStr As
String, ByVal actionStr As String, ByVal noLayout As
Boolean, ByVal version As String, Optional ByVal
serverData As String = "", Optional ByVal formStr As
String = "", Optional ByVal FldInputData As String =
"", Optional ByVal fields() As String = Nothing,
Optional ByVal vals() As String = Nothing)
        Dim response() As Object
        If fields.Length > 0 AndAlso FldInputData.Trim
= "" Then
            Array.Clear(fields, 0, fields.Length)
            Array.Clear(vals, 0, fields.Length)
        End If
        response = wf.SubmitRequest(session.sessionID,
folderIDStr, actionStr, serverData, noLayout, version,
formStr, FldInputData, fields, vals)

        folderID = folderIDStr
        map = response(0)
        stage = response(1)
        action = response(2)
        folderName = response(3)
        chainedAction = response(5)

        If response(4) <> "" Then
            errEncountered = True
            errStr = response(4)
        End If
        If errEncountered Then
            Try
                wf.CancelRequest(session.sessionID,
folderIDStr, actionStr)
            Catch ex As Exception

            End Try
        End If
    End Sub

    '''
-----------------------------------------------------------------------------
    ''' <summary>
    ''' Submit request with hash.
    ''' </summary>
    ''' <param name="folderIDStr">1</param>
    ''' <param name="actionStr">2</param>
    ''' <param name="noLayout">3</param>
    ''' <param name="version">4</param>
    ''' <param name="fields">5</param>
    ''' <param name="serverData">6</param>
    ''' <param name="formStr">7</param>
    ''' <param name="FldInputData">8</param>
    ''' <remarks>
    ''' </remarks>
    '''
-----------------------------------------------------------------------------
    Public Sub SubmitRequest(ByVal folderIDStr As
String, ByVal actionStr As String, ByVal noLayout As
Boolean, ByVal version As String, ByVal fields As
Hashtable, Optional ByVal serverData As String = "",
Optional ByVal formStr As String = "", Optional ByVal
FldInputData As String = "")
        If fields Is Nothing Then
            fields = New Hashtable
        End If
        Dim fieldList(fields.Count - 1) As String
        Dim valueList(fields.Count - 1) As String

        fields.Keys.CopyTo(fieldList, 0)
        fields.Values.CopyTo(valueList, 0)
        SubmitRequest(folderIDStr, actionStr,
noLayout, version, serverData, formStr, FldInputData,
fieldList, valueList)
    End Sub

--- Bill Swallow <tec...@gm...> wrote:

> The XML looks fine. Perhaps these methods are
> private and you have
> Ndoc set to not document private code? What does the
> source code for
> these methods look like?
> 
> On 11/16/05, Schouten Ryan <ry...@ya...>
> wrote:
> > I am using Ndoc to document my vb code and I am
> > running into problems with a couple of methods.
> The
> > xml code is there for the methods but for some
> reason
> > Ndoc never picks up the documentation for these
> > methods. The sections in question are included
> below.
> > Thank you for your help.
> >
> >
> >
> > <member
> >
>
name="M:eWork.Action.SubmitRequest(String,String,Boolean,String,Hashtable,String,String)">
> >      <summary>
> >  Submit request with hash.
> >  </summary>
> >  <param name="folderIDStr" />
> >  <param name="actionStr" />
> >  <param name="noLayout" />
> >  <param name="version" />
> >  <param name="fields" />
> >  <param name="serverData" />
> >  <param name="formStr" />
> >  <param name="FldInputData" />
> >  <remarks>
> >  </remarks>
> >  <history>
> >        [rschoute]      11/16/2005      Created
> >  </history></member>
> > <member
> >
>
name="M:eWork.List.getList(String,String,Integer,Integer)">
> >      <summary>
> >  GetList
> >  </summary>
> >  <param name="listType" />
> >  <param name="orderby" />
> >  <param name="whereStr" />
> >  <param name="page" />
> >  <param name="pagesize" />
> >  <returns />
> >  <remarks>
> >  </remarks>
> >  <history>
> >        [rschoute]      11/16/2005      Created
> >  </history></member>
> >
> >
> >
> >
> > __________________________________
> > Yahoo! Mail - PC Magazine Editors' Choice 2005
> > http://mail.yahoo.com
> >
> >
> >
>
-------------------------------------------------------
> > This SF.Net email is sponsored by the JBoss Inc. 
> Get Certified Today
> > Register for a JBoss Training Course.  Free
> Certification Exam
> > for All Training Attendees Through End of 2005.
> For more info visit:
> >
>
http://ads.osdn.com/?ad_id=7628&alloc_id=16845&op=click
> > _______________________________________________
> > Ndoc-users mailing list
> > Ndo...@li...
> >
>
https://lists.sourceforge.net/lists/listinfo/ndoc-users
> >
> 
> 
> --
> Bill Swallow
> HATT List Owner
> WWP-Users List Owner
> 42.8162,-73.7736
> http://techcommdood.blogspot.com
> 



		
__________________________________ 
Start your day with Yahoo! - Make it your home page! 
http://www.yahoo.com/r/hs

Re: [Ndoc-users] Problem with Ndoc

[Bill S. <tec...@gm...>]

The XML looks fine. Perhaps these methods are private and you have
Ndoc set to not document private code? What does the source code for
these methods look like?

On 11/16/05, Schouten Ryan <ry...@ya...> wrote:
> I am using Ndoc to document my vb code and I am
> running into problems with a couple of methods. The
> xml code is there for the methods but for some reason
> Ndoc never picks up the documentation for these
> methods. The sections in question are included below.
> Thank you for your help.
>
>
>
> <member
> name=3D"M:eWork.Action.SubmitRequest(String,String,Boolean,String,Hashtab=
le,String,String)">
>      <summary>
>  Submit request with hash.
>  </summary>
>  <param name=3D"folderIDStr" />
>  <param name=3D"actionStr" />
>  <param name=3D"noLayout" />
>  <param name=3D"version" />
>  <param name=3D"fields" />
>  <param name=3D"serverData" />
>  <param name=3D"formStr" />
>  <param name=3D"FldInputData" />
>  <remarks>
>  </remarks>
>  <history>
>        [rschoute]      11/16/2005      Created
>  </history></member>
> <member
> name=3D"M:eWork.List.getList(String,String,Integer,Integer)">
>      <summary>
>  GetList
>  </summary>
>  <param name=3D"listType" />
>  <param name=3D"orderby" />
>  <param name=3D"whereStr" />
>  <param name=3D"page" />
>  <param name=3D"pagesize" />
>  <returns />
>  <remarks>
>  </remarks>
>  <history>
>        [rschoute]      11/16/2005      Created
>  </history></member>
>
>
>
>
> __________________________________
> Yahoo! Mail - PC Magazine Editors' Choice 2005
> http://mail.yahoo.com
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by the JBoss Inc.  Get Certified Today
> Register for a JBoss Training Course.  Free Certification Exam
> for All Training Attendees Through End of 2005. For more info visit:
> http://ads.osdn.com/?ad_id=3D7628&alloc_id=3D16845&op=3Dclick
> _______________________________________________
> Ndoc-users mailing list
> Ndo...@li...
> https://lists.sourceforge.net/lists/listinfo/ndoc-users
>


--
Bill Swallow
HATT List Owner
WWP-Users List Owner
42.8162,-73.7736
http://techcommdood.blogspot.com

[Ndoc-users] Problem with Ndoc

[Schouten R. <ry...@ya...>]

I am using Ndoc to document my vb code and I am
running into problems with a couple of methods. The
xml code is there for the methods but for some reason
Ndoc never picks up the documentation for these
methods. The sections in question are included below.
Thank you for your help.



<member
name="M:eWork.Action.SubmitRequest(String,String,Boolean,String,Hashtable,String,String)">
      <summary>
 Submit request with hash. 
 </summary>
 <param name="folderIDStr" />
 <param name="actionStr" />
 <param name="noLayout" />
 <param name="version" />
 <param name="fields" />
 <param name="serverData" />
 <param name="formStr" />
 <param name="FldInputData" />
 <remarks>
 </remarks>
 <history>
 	[rschoute]	11/16/2005	Created 
 </history></member>
<member
name="M:eWork.List.getList(String,String,Integer,Integer)">
      <summary>
 GetList 
 </summary>
 <param name="listType" />
 <param name="orderby" />
 <param name="whereStr" />
 <param name="page" />
 <param name="pagesize" />
 <returns />
 <remarks>
 </remarks>
 <history>
 	[rschoute]	11/16/2005	Created 
 </history></member>


	
		
__________________________________ 
Yahoo! Mail - PC Magazine Editors' Choice 2005 
http://mail.yahoo.com

[Ndoc-users] Anyone using innovasys?

[David T. <da...@wi...>]

Hi;

 

With ndoc not yet ready for .net 2.0 and I need something today, I looked at
innovasys on Friday. It looks good but I sent some email questions to them
and no answer. Are they still in business? Any comments about their
documentation product?

 

Thanks - dave

 

 

 

David Thielen

www.windwardreports.com

303-499-2544