开发者

Documenting using Sandcastle: Refering to enum value using <see>

开发者 https://www.devze.com 2022-12-29 00:42 出处:网络
I\'m using Sandcastle 2.4.10520 and Sandcastle Help File Builder 1.8.0 to generate a .chm help file. In my documentation, I\'m using <see> tags.

I'm using Sandcastle 2.4.10520 and Sandcastle Help File Builder 1.8.0 to generate a .chm help file.

In my documentation, I'm using <see> tags.

If I try to refer an enum like <see cref="NumberStyles"/> it works perfectly.

If I try to refer an enum value like <see cref="NumberStyles.AllowTrailingWhite"/> I get a link in the documentation file, but the link leads me to an MSDN Page not found

I don't get any warnings - my xml documentation is correct.

I've noticed that MSDN pages that refer to an enum value also have a Page not found link. For example: UI开发者_开发百科nt64.Parse Method (String, NumberStyles, IFormatProvider) refers to NumberStyles.AllowHexSpecifier and this leads to another MSDN Page not found.

Should I refer to the enum instead of the enum value?

What should I do to refer an enum? Is it even possible?


The fact that it's happening on MSDN doesn't bode well. Do the enum values have XML documentation?

If I remember correctly, there should be settings in SHFB that will let you force generation of documentation for members that don't have XML - or maybe it's a setting that lets you exclude members that don't have XML doc. Regardless, give the settings a good once over to make sure you aren't excluding the enum members that way.

Otherwise, it should generate documentation for every member, and enum values are members of types the same as a const or static field would be.

EDIT: It looks like at least on the newer MSDN site, individual enum values aren't given their own page. For example, take a look at the NumberStyles enum. In that case, you might not have a better option than just linking to the enum.

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号