GhostDoc

Static Info

markc — Wed, 08 Sep 2010 01:54:20 GMT

Hi,

Can we add whether a method or property is static to the generated XML ?

Thanks.

How to insert line breaks or limit the maximum number of characters per line?

gehho — Fri, 03 Sep 2010 10:24:00 GMT

I would like to insert line breaks in the generated XML comments, so that a long comment does not exceed my screen width. Is this possible somehow, e.g. $(NewLine)?! Or is it possible to tell GhostDoc to intelligently add line breaks after a maximum of x characters? With "intelligently" I mean that it should only insert line breaks at whitespace.

If neither of this is possible, could this please be added in the next release?!

Many thanks,
gehho.

Document This menu item disabled

wieganka — Thu, 02 Sep 2010 13:15:02 GMT

I've installed the latest release of GhostDoc, and the "Document This" menu item is disabled. i can get into the GhostDoc options just fine, and there are no errors. This is with Visual Studio 2008 only. I have 2005 and 2010 installed as well, and GhostDoc is working on those.

If I turn on logging, the last Event Log item I see is "Initializing DTE...", and that's it.

I am using Windows 7 x64.

Suggestions?

*edit*, yes I have re-installed, and that did not work.

Inherited documentation on classes

Romke — Wed, 01 Sep 2010 11:30:46 GMT

Is it possible to configure GhostDoc to inherit documentation on classes? It seems to me this is only possible for a class's constructors, events, indexers, methods and properties but not for the class itself (using GhostDoc v2.5.09166 with Visual Studio 2008 SP1).

Unable to install ghostdoc

paulsf — Thu, 26 Aug 2010 22:05:01 GMT

Hello,

I love ghostdoc but am unable to install it on a new machine.

The installer says that Visual Studio .NET is not installed. However, Visual Studio 2010 _is_ installed.

Is there a workaround?

Is there a way to install ghostdoc by hand?

Reduce "gets or sets" summary prefix to just "Gets" when setter is private

aarnott — Thu, 23 Jul 2009 16:56:39 GMT

StyleCop requires that for property accessors, if one accessor is less visible than the other that the summary statement start with just the more public operation. As a result, if GhostDoc is documenting this:

public string Name { get; internal set; }

It should generate this comment

/// <summary>
/// Gets ~~or sets~~ the name.
/// </summary>

Otherwise StyleCop complains and everything has to be fixed up manually.

Configuration file problem

sethn — Thu, 22 Jul 2010 09:30:22 GMT

I am getting this message when I am trying to create the configuration in GhostDoc:

'The configuration file cannot be saved: This operation is supported only when you are connected to the server.' and then I must select 'Abort', 'Retry', 'Ignore'. I have to do Ignore to get past the dialog and then I click 'Finish' and it tells me 'The configuration file could not be found. GhostDoc will use the default configuration.' Then, GhostDoc will not work and 'Configure GhostDoc' and 'Document This' in the tools menu are greyed out.

I did have some visual studio items saved onto a network share, which went down and I had to change where I saved my visual studio settings file onto my machine.

Is there somewhere in visual studio where I need to specify where to save the configuration file?

I have reinstalled multiple times.

Windows Server 7, GhostDoc 2.5.09166

BUG: GhostDoc doesn't document Extension Methods correctly

dblack — Fri, 12 Mar 2010 21:50:13 GMT

When creating an ExtensionMethod in .NET, GhostDoc doesn't correctly document the parameters. The first parameter representing the Type that the extension method is being extended shouldn't be included in the parameter list.

Example:

/// <summary>

/// Concatenates a <seealso cref="System.Collections.Generic.IEnumerable{string}"/> into a

/// single <seealso cref="System.String"/>.

/// </summary>

/// <param name="source">The source.</param>

/// <returns></returns>

public static string StringConcatenate( this IEnumerable<string> source )

{

StringBuilder sb = new StringBuilder();

foreach ( string s in source )

{

sb.Append( s );

}

return sb.ToString();

}

Supported filetypes

sandermarks — Thu, 29 Jul 2010 13:25:16 GMT

When working with asp.net some files do not use a separate code behind file because they exist 99% of code. For instance a Webservice (.asmx) or a handler (.ashx). Creating a code behind for these kind of files would be useless since you would have a file with one line defining the service/handler etc. and a .cs file containing the code.

In these files I do not have a right click 'Document this' option. Is it possible to enable the right click option in these files, or if not to take this under consideration for a future version?

Return type

Theraot — Tue, 20 Jul 2010 12:32:44 GMT

To define the type for the parameters and the return type, one has to write the full name of the type. It would be good to see System.Object in the combo list. But I needed to tell that a mehod returns nothing, that it's void, I did try System.Void (which would have been correct) and it didn't work, instead I have to leave it open to any return type.

What about adding a none for the return types, so when I want to match only method that doesn't return, I could tell GhostDoc that there is none return type. Also something similar, as I suggested in my previous post for the parameters would mean that explicitly there are no more paramters, and thus the rule should not match method with more parameters.

First and Last (parameters)

Theraot — Tue, 20 Jul 2010 10:44:32 GMT

Hello,

I just downloaded the last released GhostDoc atm. and started writting some custom configuration (I had played with old versions, before it was adquired by submain). I decided to write a custom rule for all the methods and properties in one of my solutions in Visual Studio 2010... I thought it was a good way to test both my naming convention and the power of GhostDoce while getting that (damn) solution documented. So far I've only skiped private members and certain method I will not mention (in fact I think that If I can't generalize it's naming maybe I've picked a bad naming to begin with).

The matter of this post is about a problem I found creating my rules, I have some methods of the shape:

bool Equals(any x, any y)

Where any mean any type, but I also have a few:

bool Equals(any<anotherany> x, any<anotherany> y, IEqualityComparer<anotherany> comparer)

Where anotherany is another any type differnet from any. (... you get the idea ...). Well GhostDoc decided to pick the second methods with the first rule, so I though that if I write an specific rule for the second GhostDoc will correctly pick that one (and it does it). But I have had to tell the type for the second parameter as the type of the first, while correct in my situation, I did left open the data type in the rule so it may come to be wrong for other methods.

So far It's not a problem, but the rule would have been better defined using like: $(Parameters.Current.TypeName.FullNameAsSee) instead of $(Parameters.First.TypeName.FullNameAsSee). Also It would be good if I can tell GhostDoc that a certain rule is closed or open for more parameters, that is, if it should or not match method with more than the parameters I specified (you have a combo where you say, <any>, equals... etc. for the parameters, add a none for that combo that will mean that there are no more parameters, at least that my suggestion).

For abstract: I requesting a way to refer the current parameter, and a way to tell GhostDoc to make a rule closed to more parameters.

By the way, I have a little journy ahead documenting this solution of mine... I'll post here any other bits of incompletenessI find.

Generic interfaces

Theraot — Tue, 20 Jul 2010 20:24:00 GMT

GhostDoc ignores generic interfaces, while non-generic ones are mapped correctly.

The following code ilustrates the issue:

using System;

using System.Collections.Generic;
using System.Linq;
using System.Text;
 
namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
        }
    }
 
    public interface ICustom<T>
    {
 
        /// <summary>
        /// Custom documentation.
        /// </summary>
        void something();
    }
 
    public class impl : ICustom<string>
    {
        /// <summary>
        /// Somethings this instance.
        /// </summary>
        public void something()
        {
            throw new NotImplementedException();
        }
    }
}

Feature Request: Add attributes to tags

Uncle Chutney — Wed, 30 Jun 2010 14:56:19 GMT

I use custom attributes in summary tags. For example:

I use the attributes in an XSLT I created for generating HTML documentation. It would be really nice if we could add User-defined rules that can add attributes to these tags.

thanks!

Documentation of properties

remio — Tue, 02 Mar 2010 10:28:16 GMT

Hi,

When a property, has no setter, or is an autoproperty, I always remove the <value> tags.

Maybe GhostDoc could avoid generating them?

Thanks.

Remio

GhostDoc button unclickable ...

simondugre — Tue, 13 Jul 2010 14:13:00 GMT

I must start by saying that I'm french so my english is bad but not enough bad to use a traducter...

Well, i'ts preaty simple but kind of weird at the same time ... I'm just comming back from 2 weeks of vacation. And, just before I left, we've install VS.net 2010 on my computer so I configure once it finish GhostDoc to make it works with 2010. I've also check if it were working this day on VS.net 2008 and it were working. But, now, 2 weeks later, GhostDoc appear in VS.net 2008 but the button isn't enabled. I can't click it. I've trying many time (about 5) to install, repair, etc. Ghostdoc and it still ain't working. Anyone can help me out with this?

Thank you and good luck to undestand me .

Note : I must say that it's working GREAT on .net 2010...

Questions About Return Types for Methods

Stan McGinnis — Thu, 15 Jul 2010 19:41:54 GMT

I couldn't find much on this topic, so maybe I'm doing something wrong. Shouldn't GhostDoc document return types in the comments? All of my generated comments seem to leave the return type blank "/// <returns></returns>". (see the generated comments below):

/// <summary>
/// Gets the end of last quarter.
/// </summary>
/// <returns></returns>

public static DateTime GetEndOfLastQuarter()
{
....
}

Do I have to modify the rules to calculate the return type text? I saw in a couple of the rules things like "A <see cref="System.String" /> that represents this instance." I guess I was expecting to get text similar to this, only specific to the actual return type. If there is a rule set that you may have come up with to address this, I would love to add it to my setup.

Thanks for your suggestions,
Stan

VS 2010 installation problems

SeanD — Wed, 23 Jun 2010 17:06:36 GMT

So, I've got a new development machine, yay! Time for a clean set of installs...

I've put Visual Studio 2010 and .Net 4 on it, no problem.

I've downloaded the latest GhostDoc (2.5), but when I try and install it I get the message "Visual Studio .Net is not installed on your machine"?

Why is the installer not picking the latest .Net, shouldn't that be backwards compatible? Does anyone have any suggestions how to install GhostDoc, preferably short of installing an earlier version of .Net! Thanks,

Sean

Customizing Indentation

alanspark — Mon, 28 Jun 2010 09:47:43 GMT

Hi,

I have just started using GhostDoc and must say that it is fantastic. Congratulations on such a simple but very useful tool.

The main benefit that I am getting from it at the moment is the ability to automatically produce xml comments for inherited members. I like to document my code as much as possible but found that I was neglecting documenting inherited members because it was so repetitive and tedious - now it is just a single shortcut key.

I have one question and it is probably a bit pernickety but when I write xml documentation, I usually like to indent the contents of the <summary> tab. For example:

<summary>
This method does something.
</summary>

But the default in GhostDoc does not indent the content and would produce the following:

<summary>
This method does something.
</summary>

As I said, this is a minor point but is there a way to change the style of the generated comments?

Thanks,
Alan

GhostDoc and Visual Studio 2010 RTM, any known issues?

gabriel.lozano-moran — Fri, 23 Apr 2010 06:45:01 GMT

I have noticed that the latest build for GhostDoc is from 15th June 2009, are there any known issues when issues with Visual Studio 2010 RTM?

Package load failure

picrap — Fri, 18 Jun 2010 12:35:03 GMT

Hi,

I proudly installed Windows 7 x64 edition on my PC today, reinstalled VS2010 and GhostDoc (amongst others), and came up with a very strange problem: Visual Studio 2010 can't load GhostDoc package.

It works well if I start VS2010 in admin mode, but fails when I run it as normal user.

Is this a know problem?

Thanks,

Pascal.

C#: Escaped parameter names keep the @ on the generated text.

Paulo Morgado — Sun, 06 Jun 2010 19:22:02 GMT

If I have a parameter named @event (@ required because event is a C# keyword), the generated documentation is this:

/// <param name="event">The @event.</param>

The paremeter name is right, but the text is wrong.

Change language of comments

labate — Thu, 29 Oct 2009 17:00:46 GMT

Hello,

I have my comments in french and I would like to get them in english so that we can generate documentation in english for non-french people.

I read from a previous post that the language of comments depends of the localized .NET framework language.

Actually in my installed programs, I see for example some additional language resources:

Module linguistique Microsoft .NET Framework 3.5 SP1 - fra
Microsoft .NET Framework 3.0 Service Pack 2 Language Pack - FRA
Module de prise en charge linguistique de Microsoft .NET Framework 2.0 - fra

Isn't it possible to have an option for choosing if GhostDoc has to use the localized version of .NET framework or the original english version?

If it not possible, could you provide the english support separately?

I know that it is a common issue for a lot of people and it could be great to find a solution apart the one consisting to uninstall the .NET language resources.

Thanks.

Regards,
Adriano

Change language of comments?

KB123 — Mon, 24 Aug 2009 06:55:33 GMT

How can I change the language the comments shall be in?

I have a german Visual Studio and get german comments, but I´m used to writing my comments in english.

Where can I change that?

GhostDoc First Time Configuration Problem

oddSprite — Fri, 25 Sep 2009 10:23:14 GMT

Hi Guys,

I've been using GhostDoc for a good number of months now since I discovered it and recently tried to upgrade to the latest version (2.5.09166). Installation completed successfully. The next time I ran visual studio I was presented with the GhostDoc setup dialog. During Step 2 (the creation of rule configuration) I clicked 'Create' rather than upgrading the previous version of the rules (as I use defaults anyway) and was presented with an error dialog containing the following text:

The configuration file cannot be saved:
There was an error generating the XML document.

Abort, Retry or Ignore.

Clicking Retry just displays the box again. Clicking Ignore completes the setup and then displays a further dialog:

Error loading the configuration file:
Error creating rule instance.

GhostDoc will use the default configuration.

The corrupted file will NOT be overwritten unless you commit changes in the configuration dialog.

This dialog appears every time I start visual studio. When I attempt to 'Configure GhostDoc' the configure dialog flashes up and then immediately disappears again.

My system is as follows:

Visual Studio 2008 v9.0.30729.1 SP1

Windows Vista 32-bit.

If you need more information to help solve this bug I will happily provide it.

Kind Regards,

oddSprite

GhostDoc Config & Importing Small Changes

jroberts — Tue, 27 Apr 2010 17:46:58 GMT

Seems the Import function only looks for 'major' changes at the rule level and ignores textual changes within an existing rule ?

Is this correct?