Как пометить устаревшие классы / методы в выводе с помощью sandcastle - PullRequest
Новая
       42

Как пометить устаревшие классы / методы в выводе с помощью sandcastle

2 голосов
/ 08 февраля 2011

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

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

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

1 Ответ

2 голосов
/ 11 февраля 2011

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

Поэтому я добавил пространство имен System к своим фильтрам API, чтобы оно включало атрибут Obsolete-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

...