并非所有的命名空间纳入沙堡建立的文档 [英] Not all namespaces are included into Sandcastle build for documentation
问题描述
我有一个解决方案两个命名空间C#项目。我已经记录所有的类/函数/成员的/ etc中的两个命名空间。由于这个项目是一个小的研究项目,该命名空间是 DocTestLibrary
和 DocTestLibrary.Events
。然而,当我尝试创建通过沙堡从它的文档,它只会创造了 DocTestLibrary
命名空间的文档。有没有办法,我需要在沙堡进行,使这项工作任何设置?我虽然怀疑这一点,因为我已经完成大部分的冲刷。
I have a C# project with two namespaces in one solution. I've documented all the classes/functions/members/etc in both namespaces. As this project is a small research project, the namespaces are DocTestLibrary
and DocTestLibrary.Events
. However, when I try to create documentation from it via Sandcastle, it will only create documentation for the DocTestLibrary
namespace. Is there any setting that I need to make in Sandcastle to make this work? I doubt it though, as I've scoured through most of them.
但奇怪的是,Doxygen的是能够生成文档就好了。
The strange thing is, Doxygen is able to generate documentation just fine.
由于提供一些信息,我已经检查了沙堡生产用于构建日志。
看来,这个项导致其余显示没有
As to provide some more information, I've checked the log that Sandcastle produces for the build. It seems that this entry is causing the rest not to be displayed.
Warn: ResolveReferenceLinksComponent2: Unknown reference link target 'T:DocTestLibrary.Events.DemoEvent'.
我也发现了别的东西。
I also found out something else.
在 DocTestLibrary
命名空间包含两个类:
The DocTestLibrary
namespace consists of two classes:
- 的TestClass
- StaticHelper
顾名思义,该StaticHelper是一个辅助类,只有静态方法。然而,沙堡还否认来处理这个文件。只有拿到的TestClass的处理。它只博格尔斯我,有没有关于这虽然在日志中的一个条目。
As the name implies, the StaticHelper is a helper-class with only static methods. Yet Sandcastle also denies to process this file. Only the TestClass get's processed. It only boggles me that there isn't an entry about this in the log though.
推荐答案
看来,这个问题是固定的由沙堡项目在能见度
属性部分设置 DocumentInternals
。我不知道这是为什么,因为没有编码声明的内部...
It seems that this issue is fixed by setting the DocumentInternals
in the Visibility
properties section in the Sandcastle project. I wonder why this is, as no code is declared internal...
我想我会打周围的一些更多...
I guess I'll be playing around some more...
这篇关于并非所有的命名空间纳入沙堡建立的文档的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!