Шаблон:ApiDoc: различия между версиями

Текущая версия от 19:27, 3 сентября 2024

Message_documentation_title[view] [edit] [history] [purge]

message_transclude_desc

{{#seo:

| type = website | description = Шаблон:ApiDoc is a template page used on the iCCup Wiki. Templates are pages that are embedded (transcluded) into other pages to allow for the repetition of information. | site_name = iCCup Wiki | locale = ru }}

@@ Строка 1: / Строка 1: @@
 <includeonly>
-<!-- Generate a documentation entry for a function with a link to a detailed subpage. -->
 <dt>
-    {{#if:{{#var:api_module_name|}}|
+  <!-- Отображение названия функции с ссылкой, если доступно имя модуля API -->
-        [[{{#var:api_module_name}}/doc/{{{1|}}}|{{{1|}}}]]|  <!-- Link to the detailed documentation subpage -->
+  {{#if:{{#var:api_module_name|}}|
-        [[/{{{1|}}}|{{{1|}}}]]
+    [[{{#var:api_module_name}}/doc/{{{1|}}}|{{{1|}}}]]|
-    }}
+    [[/{{{1|}}}|{{{1|}}}]]
-    {{#if:{{{params|}}|
+  }}
-        <span style="font-weight:400;">({{{params|}}})</span>  <!-- Display function parameters -->
+  <!-- Отображение параметров функции, если они предоставлены -->
-    }}
+  {{#if:{{{params|}}}|<span style="font-weight:400;">({{{params|}}})</span>}}
-    {{#if:{{{returns|}}|
+  <!-- Отображение возвращаемого типа, если он предоставлен -->
-        <span style="font-weight:400;"> → {{{returns|}}}</span>  <!-- Display return value of the function -->
+  {{#if:{{{returns|}}}|<span style="font-weight:400;"> → {{{returns|}}}</span>}}
-    }}
 </dt>
-<dd style="margin-left: 0;">
-    <p style="max-width: 990px;">{{{description|}}}</p>  <!-- Function description -->
+<!-- Описание API функции -->
-</dd>
+<dd style="margin-left: 0;"><p style="max-width: 990px;">{{{description|}}}</p></dd><br/>
-<br/>
-<!-- Conditional block for storing the data point in iccupdb if `api_store` is set and we're on a documentation page. -->
+<!-- Условный блок для сохранения точки данных в iccupdb, если условия 'api_store' и 'isDocPage' истинны -->
 {{#if:{{#var:api_store}}|
-    {{#if:{{#invoke:ApiDoc|isDocPage}}|
+  {{#if:{{#invoke:ApiDoc|isDocPage}}|
-        {{#iccupdb_datapoint:API_{{PAGENAME}}_{{{1|}}}
+    {{#iccupdb_datapoint:API_{{PAGENAME}}_{{{1|}}}
-            |type=api
+      |type=api
-            |name={{{1|}}}
+      |name={{{1|}}}
-            |information=
+      |information=
-            |image=
+      |image=
-            |date=
+      |date=
-            |extradata={{#iccupdb_create_json:
+      |extradata={{#iccupdb_create_json:
-                |description={{{description|}}}
+        |description={{{description|}}}
-                |params={{{params|}}}
+        |params={{{params|}}}
-                |returns={{{returns|}}}
+        |returns={{{returns|}}}
-                |module={{#var:api_module_name}}
+        |module={{#var:api_module_name}}
-            }} <!-- end of extradata -->
+      }}
-        }} <!-- End of iccupdb -->
+    }}
-    }} <!-- End of isDocPage conditional -->
+  }}
 }}
 </includeonly>
-<!-- Documentation block for usage and help, linking to iCCup-specific docs if available -->
 <noinclude>{{Documentation}}</noinclude>