2011-02-08 2 views
2

Я создаю документацию API с помощью Sandcastle. Код имеет несколько классов и методов, которые отмечены как устаревшие. Теперь я хочу, чтобы в выпуске API-документации эти методы были четко обозначены (перечеркнутый или другой маркер). Однако вывод Sandcastle не обозначает устаревшие методы/классы.Как отметить устаревшие классы/методы на выходе с sandcastle

Мой вопрос есть. Что мне нужно сделать, чтобы иметь устаревшие методы/классы, отмеченные Sandcastle.

Спасибо за любые советы/помощь.

ответ

2

Ну, я нашел проблему. Проблема заключается в сочетании фильтров API и атрибутов, которые у меня были на месте.

Так что я добавил System-пространство имен для моих API фильтров, так что она включает в себя устаревшую-Attribute:

<apiFilter> 
    <namespace name="System" expose="true"> 
    <type name="ObsoleteAttribute" expose="true" /> 
    <type name="SerializableAttribute" expose="false" /> 
    </namespace> 
    <!-- rest of the stuff --> 
</apiFilter> 

И добавил его также в список атрибутов Фильтры:

<attributeFilter expose="true"> 
    <namespace name="System" expose="false"> 
    <type name="ObsoleteAttribute" expose="true" /> 
    </namespace> 
    <!-- rest of the stuff --> 
</attributeFilter> 

У меня был атрибут ObsoleteAttribute в моем атрибутном фильтре, но не в API-фильтре.

Эта лента также была полезной: http://docproject.codeplex.com/discussions/74716?ProjectName=docproject

Смежные вопросы