DocProject Forum Rss Feed

New Post: no summary, param, remarks, etc. in the generated chm file

bobbyfu — Thu, 19 Nov 2009 23:00:42 GMT

Hi Dave,

I got it. I was looking at a class with no summary. Thanks. Nice tool.

- Bobby

New Post: no summary, param, remarks, etc. in the generated chm file

bobbyfu — Thu, 19 Nov 2009 22:49:26 GMT

Thanks Dave for pointing out my mistake. I enabled the XML document output for the source project, rebuilt the entire solution (including the DocSite). The /// <summery> tag and other tags are still not showing up in the CHM file and in the HTM files.

What's else I forget? Thanks.

- Bobby

New Post: Progress Status of your MAML-Editor

davedev — Thu, 19 Nov 2009 15:07:18 GMT

Hi Michael,

I work on it when I can find the time. I've been on a crazy project and work schedule for several months now, so that isn't helping either :) Also, I've begun updating DocProject to support Visual Studio 2010, so that's going to take up a couple of months as well.

You may want to take a look at DocTools in the mean time. I haven't tried it myself, but I suspect that it produces HTML output. If you could somehow configure it to save the HTML into the Help\Topics\HTML\ folder of your DocProject or DocSite, then you can import the HTML files into Topic Explorer and build your documentation as normal.

Of course, I recommend MAML over HTML, but without a nice WYSIWYG experience you may prefer the DocTools approach for now.

Alternatively, you could have the team author HTML topics in Visual Studio using the built-in HTML designer. It works well with CSS references too, so that might make it a bit easier to keep the documents uniform without having all of the benefits that MAML provides.

- Dave

New Post: Obsolete methods/classes/properties

davedev — Thu, 19 Nov 2009 14:52:24 GMT

Hi,

What versions of DocProject and Sandcastle are you using?

It's working for me. In the list topics (such as Types and Members) there's text that reads, "Obsolete.". It renders in red and appears next to types and members that are marked with System.ObsoleteAttribute in code.

It seems that the output of the MRefBuilder program includes the message argument as well. I was able to improve the documentation by updating the XSL a bit so that it includes the message value. To do that, and also to verify whether your XSL files are the same as mine, follow these steps:

Open your project's Help\Presentation\Style\Transforms\utilities_reference.xsl file.
1. Alternatively, you can make the necessary changes directly to the file in Sandcastle's installation folder so that it applies to all new DocProjects and DocSites.
Find all occurrences of the following sequence of elements:

<xsl:text> </xsl:text> <include item="obsoleteRed" />

Replace each occurrence with the following element:

<xsl:call-template name="obsolete" />

At the bottom of the file, before the closing </xsl:stylesheet> tag, insert the following XSL:

 <xsl:template name="obsolete"> <xsl:text> </xsl:text> <include item="obsoleteRed" /> <xsl:if test="normalize-space(attributes/attribute[type/@api='T:System.ObsoleteAttribute']/argument/value)"> <xsl:value-of select="attributes/attribute[type/@api='T:System.ObsoleteAttribute']/argument/value" /> </xsl:if> </xsl:template>

Let me know if you still need assistance.

- Dave

New Post: Progress Status of your MAML-Editor

MyKey0815 — Thu, 19 Nov 2009 13:35:17 GMT

Hello Dave,

for a long time ago you write about a MAML-Editor. I want to ask you what is the status of the Editor? Is it possible that you send me a Beta-Version of your application? I´m using your DocProject 1.11.0 in a huge application. Someone of my Teammembers should assit me to make the documentation but he didn´t familiry with HTML, Tags and so one. I think it would be a big help for me and him, if I can use your Editor.

Thanks for your answer

Michael

New Post: no summary, param, remarks, etc. in the generated chm file

davedev — Thu, 19 Nov 2009 02:35:41 GMT

Hi Bobbyfu,

You've almost got it right. You have to enable XML documentation output for the source projects, not the DocSite project.

DocProject gathers all of the XML documentation output from each of the source projects and passes them to Sandcastle. The XML documentation output for the DocSite project itself, if you've enabled it, is entirely ignored.

- Dave

New Post: no summary, param, remarks, etc. in the generated chm file

bobbyfu — Thu, 19 Nov 2009 01:16:30 GMT

Additional information.

1. I have enabled generating XML Document option from the DocSite project. The XML file is in the bin\DocSite.XML.

2. DocProject version is 1.11.0.0 and Sandcastle is 2.4.10520.1

Now what?

New Post: no summary, param, remarks, etc. in the generated chm file

bobbyfu — Thu, 19 Nov 2009 00:13:30 GMT

Hi,

I finally get the Sandcastle and DocProject working in the Visual Studio 2008. The CHM file or the web site (DocSite) is generated. But there is a small problem. None of the class, property, or method has summary, param, remarks that I added in my C# source code with /// <summary> <param> or <remarks>.

Is there anything missing in my configuration file? Please help.

Best,

bobbyfu

New Post: DocProject projects in Team Build definition

Vossekop — Fri, 13 Nov 2009 21:53:07 GMT

I have never found a resolution for the problem, and i since moved to another documentation solution (also not running them during builds).

New Post: DocProject projects in Team Build definition

_Trip — Thu, 12 Nov 2009 17:11:19 GMT

Bummer - I've just run across this exact same issue. As soon as the Docs project completes its processing, it doesn't move on to the next item in the process (in my case, it just isn't running the "AfterDropBuild" items it needs to in order for my copy to work on my published site.

Has there been any others with this issue? I can't seem to find a resolution on the Net anywhere.

Tim

New Post: Obsolete methods/classes/properties

nomy — Tue, 10 Nov 2009 23:00:14 GMT

I'm marking classes/methods/properties as obsolete using the ObsoleteAttribute in my source code. I would like similar behavior to the MSDN documentation, where obsolete methods/classes/properties are clearly shown using red text.

Unfortunately, this just doesn't happen for me. I've checked the XML output from VisualStudio, and it looks like this XML is feeding the appropriate obsolete markers into DocProject/Sandcastle... but I'm not getting anything in the CHM to suggest that stuff is being marked as obsolete.

Any ideas/suggestions?

New Post: A property cannot be set while building

davedev — Sat, 03 Oct 2009 15:52:52 GMT

This discussion has been copied to a work item. Click here to go to the work item and continue the discussion.

New Post: A property cannot be set while building

davedev — Sat, 03 Oct 2009 15:47:03 GMT

Hi Jan-Peter,

Thanks for following-up with this. From your analysis it seems that the issue is caused when build output is included as project items that appear in Solution Explorer.

I'll try to repro again when I get some time and see if I can fix the problem.

Thanks,
Dave

New Post: Descriptions not showing up

davedev — Fri, 02 Oct 2009 18:26:31 GMT

Hi,

As for your second question, the members you are seeing in the documentation for your class are inherited from base types, such as System.Object. You can tell Sandcastle to remove them by adding the Inheritance Filter to your DocProject or DocSite. See the following article for more information (look for the section that contains the Inheritance Filter subsection).

http://docproject.codeplex.com/Wiki/View.aspx?title=How%20To%20Use%20The%20Topic%20Management%20Dialog#Saved

- Dave

New Post: Descriptions not showing up

davedev — Fri, 02 Oct 2009 18:02:03 GMT

Hi,

Did you enable XML documentation output for your project? See the following article for more information.

http://docproject.codeplex.com/Wiki/View.aspx?title=Sandcastle%20Help#xmldoc

And here's a troubleshooting article for other common issues:

http://docproject.codeplex.com/Wiki/View.aspx?title=How%20to%20Diagnose%20and%20Resolve%20Issues

- Dave

New Post: Descriptions not showing up

catlook — Thu, 01 Oct 2009 18:55:08 GMT

Ok, I'm using Doc Project for the first time. In my code I have all sorts of /// comments on classes, methods and variables. When I compiled my doc project, it listed my classes, class variables, properties, and methods, but for all of them the "description" field is blank when I'm looking at the .chm file. What do I need to do to get descriptions entered for all these items?

As a side note, when i list the methods in one of my classes, I see all my methods. However, I also see a bunch of methods that don't appear in the code. For example, my Utility class has one method "ConvertArrayListToTable". The chm file lists that and "Equals", "Finalize", "GetHashCode", "GetType", "MemberwiseClone" and "ToStiring". Can I get those extraneous methods that don't even show up in the class code to not show up in the documentation?

New Post: A property cannot be set while building

Raeled — Wed, 30 Sep 2009 22:09:08 GMT

Hi,

I found a way to make the problem disappear by changing some DocProject properties and excluding some files from the project.

I changed the "Include Project Output Dialog" settings to the following:
Apply to all default: True
Include project output default: False
Don't ask me this again: True

Next i excluded the "/bin" folder, the "/Help/html" and all the non folder items in "/Help" folder from the project.
I also deleted these files and folders from the filesystem itself, but i don't think this was really needed as DocProject just puts them back and nothing bad comes from that.

It won't add the generated content to the project anymore now, but i actually like it that way so for me theres no problem there.

A new issue did appear where conime.exe kept a lock on the "/buildhelp" folder (turned out the issue was there all along, but suppressed by the method i used to let it manually remove this folder).
This turned out to be a bug of Windows Vista and i managed to "fix" this by removing all the languages in the windows language toolbar ( http://social.msdn.microsoft.com/Forums/en-US/windowscompatibility/thread/c609f41a-e78c-43e6-81fd-1cf76384bb01 ).

Hope this helps,
Jan-Peter

New Post: C# Property Attributes not showing correctly

dbonnett — Tue, 29 Sep 2009 17:12:59 GMT

that form isn't working. I can't type into any of the fields except for the captcha field at the bottom.

Here, just email me your contact info at this email address:

dbonneca@yahoo.com

Thanks.

New Post: C# Property Attributes not showing correctly

davedev — Tue, 29 Sep 2009 16:40:36 GMT

Hi,

Sorry I didn't receive it, thanks for following-up. Please try my CodePlex contact form instead.

- Dave

New Post: C# Property Attributes not showing correctly

dbonnett — Tue, 29 Sep 2009 14:21:14 GMT

Dave,

I sent you my contact info the other day, so just wanted to make sure you received it.

Thanks.