浏览代码

docs: Add missing elements in Services API

(cherry picked from commit 3a16a6c8361d4c55369726663df083780ba01929)
tytan652 2 年之前
父节点
当前提交
e3ad8cb878
共有 1 个文件被更改,包括 6 次插入0 次删除
  1. 6 0
      docs/sphinx/reference-services.rst

+ 6 - 0
docs/sphinx/reference-services.rst

@@ -186,6 +186,8 @@ Service Definition Structure
 
 
 .. member:: bool (*obs_service_info.can_try_to_connect)(void *data)
 .. member:: bool (*obs_service_info.can_try_to_connect)(void *data)
 
 
+   (Optional)
+
    :return: If the service has all the needed connection info to be
    :return: If the service has all the needed connection info to be
             able to connect.
             able to connect.
 
 
@@ -380,12 +382,16 @@ General Service Functions
 
 
    :return: The output type that should be preferred with this service
    :return: The output type that should be preferred with this service
 
 
+---------------------
+
 .. function:: const char *obs_service_get_connect_info(const obs_service_t *service, uint32_t type)
 .. function:: const char *obs_service_get_connect_info(const obs_service_t *service, uint32_t type)
 
 
    :param type: Check :c:member:`obs_service_info.get_connect_info` for
    :param type: Check :c:member:`obs_service_info.get_connect_info` for
                 type values.
                 type values.
    :return: Connection info related to the type value.
    :return: Connection info related to the type value.
 
 
+---------------------
+
 .. function:: bool obs_service_can_try_to_connect(const obs_service_t *service)
 .. function:: bool obs_service_can_try_to_connect(const obs_service_t *service)
 
 
    :return: If the service has all the needed connection info to be
    :return: If the service has all the needed connection info to be