Как сделать так, чтобы моя документация типов и функций появилась в Ballerina central? - PullRequest
Новая
       7

Как сделать так, чтобы моя документация типов и функций появилась в Ballerina central?

0 голосов
/ 25 сентября 2018

Я задокументировал общедоступные типы и функции моего кода Ballerina , используя синтаксис документации: 

documentation {
    Wordpress Client object
    E{{}}
    F{{wordpressApiConfig}} - Wordpress connector configurations
    F{{wordpressApiConnector}} - WordpressConnector Connector object
}

public type WordpressApiClient object {
    public WordpressApiConfiguration wordpressApiConfig = {};
    public WordpressApiConnector wordpressApiConnector = new;

    documentation {Wordpress connector endpoint initialization function
        P{{config}} - Wordpress connector configuration
    }
    public function init(WordpressApiConfiguration config);

    documentation {Return the Wordpress connector client
        R{{}} - Wordpress connector client
    }
    public function getCallerActions() returns WordpressApiConnector;

};

Однако эта документация не отображается на Ballerina Central описание пакета, как только я его нажму.Я проверил некоторые репозитории, которые действительно отображают документацию, и заметил, что они следуют другому синтаксису, который включает строковые комментарии и знаки +.

Не могли бы вы объяснить, какой стиль документации является текущим стандартом и нужно ли запускать другую команду?для генерации документов, чтобы он правильно отображался в Central.

1 Ответ

0 голосов
/ 25 сентября 2018

Синтаксис документации, который вы здесь использовали, является старым синтаксисом.Это было недавно обновлено, и теперь для документации используется синтаксис документации разметки Ballerina.Более подробную информацию можно найти по адресу https://ballerina.io/learn/by-example/documentation.html.

Поэтому документацию в ваших примерах следует изменить на - 

# Wordpress Client object
# + wordpressApiConfig - Wordpress connector configurations
# + wordpressApiConnector - WordpressConnector Connector object

public type WordpressApiClient object {
    public WordpressApiConfiguration wordpressApiConfig = {};
    public WordpressApiConnector wordpressApiConnector = new;

    # Wordpress connector endpoint initialization function
    # + config - Wordpress connector configuration
    public function init(WordpressApiConfiguration config);

    # Return the Wordpress connector client
    # + return - Wordpress connector client
    public function getCallerActions() returns WordpressApiConnector;

};

Это изменение еще не доступно в стабильной версии Ballerina, но будет доступнос v0.982.0, который будет выпущен позже на этой неделе.Также это изменение доступно для ночной сборки .Таким образом, вы можете использовать ночную сборку до выпуска стабильной версии.

...