Stack Overflow
Stack Overflow

Questions tagged [xml-documentation]

XML documentation is the way to generate automatic documentation from comments inside the code, to an XML formatted file that can be shown with any method, for e.g. a web page.

XML documentation are comments that form the documentation for C# programs. They are so called because they contain nested XML fragments. See Microsoft's XML Documentation Comments (C# Programming Guide) for more details.

391 questions
0
votes
1 answer

Multi-line style comments causing XML documentation warning

I have many multi-line style comments in a C# project and when the project option is set to output a XML documentation file they all trigger the warning XML comment is not placed on a valid language element. This behaviour is observed in Visual…
Altair
  • 304
  • 2
  • 9
0
votes
2 answers

Simplest way to add XML doc to a WinRT project

We have a group of developers moving from C++ to C# and WinRT. We used D'Oxygen as part of our C++ developer builds, and I'd like to continue to have document generation as part of the developer build in C#/WinRT. It's easy to turn on XML Doc…
Scott Smith
  • 3,900
  • 2
  • 31
  • 63
0
votes
2 answers

How to specify navtitle for table of contents in web output but NOT in pdf output?

Given that the table-of-contents area for web output is rather narrow I would like to assume smaller navigation titles for web, but continue to present long topic titles in PDF output. The following markup does not seem to work at all (with or…
Lea Hayes
  • 62,536
  • 16
  • 62
  • 111
0
votes
1 answer

IronPython: How to obtain XML documentation strings from .NET assemblies

How do you get the XML documentation strings from .NET assemblies using IronPython? Using '_doc_' doesn't seem to be the way. MessageBox.Show(Label().Bottom.__doc__) returns "Represents a 32bit signed integer." How do I get the actual doc string,…
John_Sheares
  • 1,404
  • 2
  • 21
  • 34
0
votes
1 answer

Are there any standards for visually depicting XML file structures or schemas?

I have some XML files and schemas that I would like to document. Everything for this project is documented using NetBeans UML models, Microsoft Word documents, Microsoft Excel spreadsheets, and Microsoft Visio drawings. I'm a fan of…
Thomas Owens
  • 114,398
  • 98
  • 311
  • 431
0
votes
1 answer

Where can I find the Xml Documentation files for the .NET 4.0 or 4.5 framework?

for .NET 2.0, the xml documentation files for the framework assemblies where located at this position: C:\Windows\Microsoft.NET\Framework\v2.0.50727\en I can't find a corresponding folder for .NET 3.5, 4 or even 4.5. So, where, by default, are the…
Sebastian P.R. Gingter
  • 5,955
  • 3
  • 31
  • 73
0
votes
1 answer

Comments from accompanying XML documentation file aren't shown in VS 2010/2012

At some point we detected that the comments from the XML documentation files for our .NET assemblies (DLL components) are neither displayed in VS 2010 nor in VS 2012. What could be the reason? Do we need some special settings (in the registry, etc)…
TecMan
  • 2,743
  • 2
  • 30
  • 64
0
votes
1 answer

Include common content from xml documentation file

I am using Sandcastle to generate documentation for a project. In order to reference xml documentation file include tag is used. /// public class Test And I would like…
k0stya
  • 4,267
  • 32
  • 41
0
votes
1 answer

Is there any way to have Visual Studio ignore the tag when compiling?

Basically, I was attempting to keep all of my documentation in a separate file and use the tag. This would let me keep my source code free of documentation clutter. I still wanted a way to have some developer notes about classes and…
myermian
  • 31,823
  • 24
  • 123
  • 215
0
votes
1 answer

How to combine DITA topics AND have nested topics in HTML output?

This is similar to a previous question that I asked, with one variation. I would like to know how to merge multiple topics into one (using @chunk) and then have other child topics that can be navigated to in the HTML output: Real-world example:…
Lea Hayes
  • 62,536
  • 16
  • 62
  • 111
-1
votes
1 answer

How to refer to class properties in XML docs C#?

Suppose I have a method in a class public class MyClass{ public int MyInt; /// /// Prints out the value of /// public void PrintValueOfMyInt() { ... } } Is this the correct way…
anaotha
  • 552
  • 6
  • 15
-1
votes
1 answer

Retrieve DocFx metadata from NuGet packages

I have a product with multiple repositories, each distributed as a NuGet package. I would like to establish a separate repository for DocFx, which generates the documentation from the NuGet packages. That way, it can consolidate the documentation…
Jeremy Caney
  • 7,102
  • 69
  • 48
  • 77
-1
votes
1 answer

Why is it so difficult to exclude XML documentation from a Release build?

Every time I Publish a Web Deployment Package using a Release Build I get this error once I call the Web API; HTTP 500 Internal Server Error Could not find file 'C:\SolutionDir\ProjectDir\bin\AssemblyName.xml' Here is the steps I perform when…
user692942
  • 16,398
  • 7
  • 76
  • 175
-1
votes
2 answers

Creating XML document with Two root nodes

I want to create XML with two root nodes, like this 6004 HTH testing 20 2/3/2015 12:00:00 AM …
user3073993
  • 17
  • 6
-2
votes
2 answers

C# : How to modify the structure of my xml?

I am trying to modify the structure of an very extended xml by first adding one more child and afterwards trying to change the parent of the node .I am not very experienced in XML so I was able to add the one child , but it seems that when i'm…
Livia Pascu
  • 1
  • 1
1 2 3
…
26
27