tagged [documentation]

Program for documenting a C struct?

Program for documenting a C struct? If you have a binary file format (or packet format) which is described as a C structure, are there any programs which will parse the structure and turn it into neat...

15 Dec at 22:8

Best way to document WCF interface?

Best way to document WCF interface? So I'm using WCF, and want to document my interface(s) and services to give to another company for an internal app. What's the best way to document those interface...

5 Aug at 06:34

reference to generic type in XML code comment

reference to generic type in XML code comment As I know, in a XML comment for a C# type/method, it is possible to reference a generic type in a tag like so: But I think, there was another syntax, whic...

Documenting ServiceStack web services

Documenting ServiceStack web services What are the options for documenting a ServiceStack bases web services and I'm not talking about a one line string. I would like to be able to document, in detail...

auto-document exceptions on methods in C#/.NET

auto-document exceptions on methods in C#/.NET I would like some tool, preferably one that plugs into VS 2008/2010, that will go through my methods and add XML comments about the possible exceptions t...

C# xml documentation: How to create Notes?

C# xml documentation: How to create Notes? I want to achieve a similar thing to the yellow 'Note:' box in the remarks section on [this MSDN page](http://msdn.microsoft.com/en-US/library/ms132164%28v=v...

26 Mar at 19:58

VS2010: Autogenerated XML documentation file does not update

VS2010: Autogenerated XML documentation file does not update I have a C# project in vs2010 that generates a XML documentation file, where I have set the output path of the generated file to the projec...

How do I export the code documentation in C# / VisualStudio 2008?

How do I export the code documentation in C# / VisualStudio 2008? I have always made a point of writing nice code comments for classes and methods with the C# xml syntax. I always expected to easily b...

How to refer to array types in documentation comments

How to refer to array types in documentation comments [I just posted this question](https://stackoverflow.com/questions/2367357/how-to-add-items-enclosed-by-to-documentation-comments) and learned abou...

How do I reference method parameters in a method summary when writing XML documentation?

How do I reference method parameters in a method summary when writing XML documentation? Suppose I have a method as follows: ``` /// /// Here I want to reference the parameter . /// /// /// Th...

Using Markdown for source code documentation

Using Markdown for source code documentation I am looking for an alternative to C#'s XML source code documentation which introduced by the very nature of XML a lot of noise that is heavy on the eye an...

How to make a cref to method overloads in a <seealso> tag in C#?

How to make a cref to method overloads in a tag in C#? I see in MSDN links such as "CompareOrdinal Overloads". How can I write such a link in C#? I tried: But the compiler gives me a warning about bei...

7 Jan at 09:26

How to document Python code using Doxygen

How to document Python code using Doxygen I like Doxygen to create documentation of C or PHP code. I have an upcoming Python project and I think I remember that Python doesn't have `/* .. */` comments...

Is there a specification of Java's threading model running under Windows XP available anywhere?

Is there a specification of Java's threading model running under Windows XP available anywhere? There are various documents describing threading on Solaris/Linux, but nowwhere describing the Windows i...

15 Sep at 21:29

jQuery UI Color Picker

jQuery UI Color Picker I have heard that jQuery UI includes a Color Picker but could find little documentation regarding it. Does it exist? Any decent documentation on how to implement it? I found thi...

What's the proper way to comment a constructor in a generic class?

What's the proper way to comment a constructor in a generic class? What's the proper way to comment this? VS complains about it: > Warning 11 XML commen

Using doxygen to create documentation for existing C# code with XML comments

Using doxygen to create documentation for existing C# code with XML comments I've read that doxygen is the way to go for generating documentation for C# code. I've got a single interface that I want t...

C#, XmlDoc: How to reference method overloads

C#, XmlDoc: How to reference method overloads If I have these two methods And write this piece of xml documentation on a different method I get a blue squiggly under `Get`, saying that it is an . whic...

18 Aug at 12:42

XML-documentation for a namespace

XML-documentation for a namespace Would you write xml-doc for a namespace? And if yes, how and where? I would think, if it is possible, maybe an almost empty file like this: But will that work? Since ...

1 May at 19:20

How to localize the documentation of a .NET library

How to localize the documentation of a .NET library I have an open-source project ([here](http://dvp-net.developpez.com/)) whose [documentation](http://dvp-net.developpez.com/doc/) is currently in Fre...

Document response classes with Swagger and ServiceStack

Document response classes with Swagger and ServiceStack In the [petstore example](http://petstore.swagger.wordnik.com/#!/pet/getPetById_get_0) from wordnik they have provided documentation for their r...

Unresolved assembly reference with sandcastle

Unresolved assembly reference with sandcastle I am trying to generate documentation with sandcastle help file builder. While building the project in the sandcastle i am getting the following error. ``...

23 Mar at 06:54

Xml string in a C# summary comment

Xml string in a C# summary comment I'm documenting a few methods I wrote in C# that deal with parsing tokens. Due to some technical restraints in other areas of the system, these tokens need to take t...

3 Mar at 16:25

using see cref with < > characters in XML Documentation?

using see cref with characters in XML Documentation? > [How to reference generic classes and methods in xml documentation](https://stackoverflow.com/questions/532166/how-to-reference-generic-classes-...

Summary is not showing in the assembly if it is added as a reference

Summary is not showing in the assembly if it is added as a reference I've created a 'Class Library' in C#, which has many functions with summary (XML documentation comments). For example if i use the ...