Как мне сконфигурировать docfx для включения делегатов обработчика событий C # в документ? - PullRequest
Новая
       9

Как мне сконфигурировать docfx для включения делегатов обработчика событий C # в документ?

0 голосов
/ 11 апреля 2019

В моем проекте есть несколько делегатов обработчиков событий, и я хочу включить их в мой автоматически сгенерированный документ с помощью docfx.

Я знаю, что в docfx.json> metadata есть опция фильтра, но как мне ее настроить? Есть идеи?

Я пытаюсь добавить filterConfig.yml и изменить docfx.json, ошибок нет, но это не работает.

C # код: 

/// <summary>
/// Double click on one row of the search result, this should open the detail form of it
/// </summary>
/// <param name="sender">Default_GridView</param>
/// <param name="e">EventArgs</param>
private void Default_GridView_DoubleClick(object sender, EventArgs e)
{
    //open the detail form here
}

docfx.json: 

{
  "metadata": [
    {
      "src": [
        {
          "files": [
            "*.csproj"
          ],
          "cwd": ".",
          "exclude": [
            "**/obj/**",
            "**/bin/**",
            "_site/**"
          ]
        }
      ],
      "dest": "obj/api",
      "filter": "filterConfig.yml"
    }
  ],

filterConfig.yml: 

apiRules:
- include:
    uidRegex: ^System\.EventHandler
    type: Type

1 Ответ

0 голосов
/ 11 апреля 2019

Вы должны будете сделать свой метод обработчика событий public, protected или protected internal. Как правило, невозможно включить private методы в документацию по API, что имеет смысл, поскольку частные методы не являются частью вашего API.

Как только вы это сделаете, вы можете удалить этот фильтр API. Это просто сработает.

...