mixed managed and unmanaged code (c++)

Topics: User Forum
Jan 10, 2007 at 1:51 PM
- Can "Sandcastle Help File Builder" build documentation from unmanaged/managed source?
(in my case documentatinon file contains only tags inside namespaces and ignores unmanaged part.)

- Is possible to unconsidering/excluding specific method ("void paramInvisibleInDocumentation() {}" ...in example) from creating documentation?

example.h:
----------------------
#pragma once

using namespace System;
using namespace System::IO;

//#pragma managed(push, off)
#pragma unmanaged

/// <summary>
/// This is a summary tag for the UnmanTest struct
/// </summary>
struct UnmanTest {
/// <summary>
/// This is a summary tag for the summaryTag() method
/// </summary>
void summaryTag() {}
};
#pragma managed
//#pragma managed(pop)

namespace AllTags
{
public ref class AClass {
public:
/// <param name="param1">The first int parameter</param>
/// <param name="param2">The second String^ parameter</param>
void paramTag(int param1, String ^param2) {}

void paramInvisibleInDocumentation() {}
};
}
----------------
Coordinator
Jan 10, 2007 at 4:00 PM
You'd have to try it to see if Sandcastle, specifically MRefBuilder, can load and parse an assembly with managed and unmanaged code. The XML comments shouldn't be an issue if it can get past that. To ignore methods, just add an <exclude/> tag to the XML comments on a method.

Eric
Jan 11, 2007 at 10:25 AM
I already try it... SandCastle ignores my unmanaged code part.

thanks for <exclude/> info;