Skip to content

Commit ee1a844

Browse files
nixel2007nixel2007
committed
Добавление документации по annotations, разделение документации на разделы products и api, перенос документации ОСени, рерайты
1 parent a024568 commit ee1a844

38 files changed

+243
-11
lines changed

‎.vitepress/config.mts

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ export default defineConfig({
3838
base: "/docs",
3939

4040
rewrites(id) {
41-
return id.replace(/\d+-/, '').replaceAll('\\', '/')
41+
return id
42+
.replace(/\d+-/, '') // удаление префикса сортировки
43+
.replaceAll('\\', '/') // замена обратных виндовых слешей на прямые
44+
.replaceAll('products/autumn/', '') // подмена пути products/autumn на корень
45+
.replaceAll('products/', ''); // удаление префикса products
4246
},
4347

4448
cleanUrls: true,
@@ -69,6 +73,7 @@ export default defineConfig({
6973
items: [
7074
{ text: 'autumn', link: '/getting-started/about-autumn' },
7175
{ text: 'winow', link: '/winow/' },
76+
{ text: 'annotations', link: '/annotations/' },
7277
]
7378
},
7479
{
@@ -83,17 +88,24 @@ export default defineConfig({
8388
sidebar: {
8489
// products
8590
"/": getSidebar({
86-
contentRoot,
91+
contentRoot: contentRoot + 'products/autumn/',
8792
contentDirs: [
8893
{ text: 'Начало работы', dir: 'getting-started' },
8994
{ text: 'Использование фреймворка', dir: 'framework-elements' },
9095
],
9196
collapsed: false,
9297
}),
98+
"/annotations/": getSidebar({
99+
contentRoot: contentRoot + 'products/annotations/',
100+
contentDirs: [
101+
{ text: 'annotations', dir: '.' }
102+
],
103+
collapsed: false,
104+
}),
93105
"/winow/": getSidebar({
94-
contentRoot,
106+
contentRoot: contentRoot + 'products/winow/',
95107
contentDirs: [
96-
// { text: 'winow', dir: 'winow' }
108+
{ text: 'winow', dir: '.' }
97109
],
98110
collapsed: false,
99111
}),

‎docs/api/annotations/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@
88
* [КонтейнерАннотаций](Классы/КонтейнерАннотаций)
99
* [ОпределениеАннотации](Классы/ОпределениеАннотации)
1010
* [РазворачивательАннотаций](Классы/РазворачивательАннотаций)
11+
12+
## Модули
13+
* [РаботаСАннотациями](Модули/РаботаСАннотациями)

‎docs/api/annotations/Модули/РаботаСАннотациями.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# РаботаСАннотациями
2+
3+
## ПолучитьАннотации
4+
5+
```bsl
6+
// Получить все аннотации свойства с указанным именем аннотации.
7+
//
8+
// Параметры:
9+
// Свойство - СтрокаТабличнойЧасти, Структура - Описание свойства/метода:
10+
// * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства/метода:
11+
// * Имя - Строка - Имя аннотации.
12+
// ИмяАннотации - Строка - Имя аннотации.
13+
//
14+
// Возвращаемое значение:
15+
// Массив из СтрокаТабличнойЧасти - Массив найденных аннотаций.
16+
//
17+
Функция ПолучитьАннотации(Свойство, ИмяАннотации)
18+
```
19+
20+
## ПолучитьАннотацию
21+
22+
```bsl
23+
// Получить первую аннотацию свойства с указанным именем аннотации.
24+
//
25+
// Параметры:
26+
// Свойство - СтрокаТабличнойЧасти, Структура - Описание свойства/метода:
27+
// * Аннотации - ТаблицаЗначений - Таблица аннотаций свойства/метода:
28+
// * Имя - Строка - Имя аннотации.
29+
// ИмяАннотации - Строка - Имя аннотации.
30+
//
31+
// Возвращаемое значение:
32+
// СтрокаТабличнойЧасти - Найденная аннотация.
33+
//
34+
Функция ПолучитьАннотацию(Свойство, ИмяАннотации)
35+
```
36+
37+
## НайтиАннотации
38+
39+
```bsl
40+
// Получить все аннотации с указанным именем аннотации.
41+
//
42+
// Параметры:
43+
// Аннотации - ТаблицаЗначений - Таблица аннотаций:
44+
// * Имя - Строка - Имя аннотации.
45+
// ИмяАннотации - Строка - Имя аннотации.
46+
//
47+
// Возвращаемое значение:
48+
// Массив из СтрокаТабличнойЧасти - Массив найденных аннотаций.
49+
//
50+
Функция НайтиАннотации(Аннотации, ИмяАннотации)
51+
```
52+
53+
## НайтиАннотацию
54+
55+
```bsl
56+
// Получить первую аннотацию с указанным именем аннотации.
57+
//
58+
// Параметры:
59+
// Аннотации - ТаблицаЗначений - Таблица аннотаций:
60+
// * Имя - Строка - Имя аннотации.
61+
// ИмяАннотации - Строка - Имя аннотации.
62+
//
63+
// Возвращаемое значение:
64+
// СтрокаТабличнойЧасти - Найденная аннотация.
65+
//
66+
Функция НайтиАннотацию(Аннотации, ИмяАннотации)
67+
```
68+
69+
## НайтиМетодыСАннотацией
70+
71+
```bsl
72+
// Получить все методы с указанной аннотацией.
73+
//
74+
// Параметры:
75+
// Методы - ТаблицаЗначений, Массив - Список методов:
76+
// * Аннотации - ТаблицаЗначений - Таблица аннотаций метода:
77+
// * Имя - Строка - Имя аннотации.
78+
// ИмяАннотации - Строка - Имя аннотации.
79+
//
80+
// Возвращаемое значение:
81+
// Массив из СтрокаТабличнойЧасти - Массив найденных методов.
82+
//
83+
Функция НайтиМетодыСАннотацией(Методы, ИмяАннотации)
84+
```
85+
86+
## ПолучитьПараметрыАннотации
87+
88+
```bsl
89+
// Получить параметры аннотации с указанным именем параметра.
90+
//
91+
// Параметры:
92+
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
93+
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
94+
// * Имя - Строка - Имя параметра.
95+
// ИмяПараметра - Строка - Имя параметра.
96+
//
97+
// Возвращаемое значение:
98+
// Массив из СтрокаТабличнойЧасти - Массив найденных параметров.
99+
//
100+
Функция ПолучитьПараметрыАннотации(Аннотация, ИмяПараметра)
101+
```
102+
103+
## ПолучитьПараметрАннотации
104+
105+
```bsl
106+
// Получить параметр аннотации с указанным именем параметра.
107+
//
108+
// Параметры:
109+
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
110+
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
111+
// * Имя - Строка - Имя параметра.
112+
// ИмяПараметра - Строка - Имя параметра.
113+
//
114+
// Возвращаемое значение:
115+
// СтрокаТабличнойЧасти - Найденный параметр.
116+
//
117+
Функция ПолучитьПараметрАннотации(Аннотация, ИмяПараметра)
118+
```
119+
120+
## ПолучитьЗначенияПараметровАннотации
121+
122+
```bsl
123+
// Получить значения параметров аннотации с указанным именем параметра.
124+
//
125+
// Параметры:
126+
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
127+
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
128+
// * Имя - Строка - Имя параметра.
129+
// * Значение - Произвольный - Значение параметра.
130+
// ИмяПараметра - Строка - Имя параметра.
131+
//
132+
// Возвращаемое значение:
133+
// Массив из Произвольный - Массив найденных значений параметров.
134+
//
135+
Функция ПолучитьЗначенияПараметровАннотации(Аннотация, ИмяПараметра)
136+
```
137+
138+
## ПолучитьЗначениеПараметраАннотации
139+
140+
```bsl
141+
// Получить значение параметра аннотации с указанным именем параметра.
142+
//
143+
// Параметры:
144+
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
145+
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
146+
// * Имя - Строка - Имя параметра.
147+
// * Значение - Произвольный - Значение параметра.
148+
// ИмяПараметра - Строка - Имя параметра.
149+
// ЗначениеПоУмолчанию - Произвольный - Значение параметра по умолчанию.
150+
// НеопределеноЭтоКорректноеЗначениеПараметра - Булево - Признак того,
151+
// что Неопределено является корректным значением параметра.
152+
//
153+
// Возвращаемое значение:
154+
// Произвольный - Значение параметра.
155+
//
156+
Функция ПолучитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра = "Значение", ЗначениеПоУмолчанию = Неопределено, НеопределеноЭтоКорректноеЗначениеПараметра = Ложь)
157+
```
158+
159+
## УстановитьЗначениеПараметраАннотации
160+
161+
```bsl
162+
// Установить значение параметра аннотации с указанным именем параметра.
163+
//
164+
// Параметры:
165+
// Аннотация - СтрокаТабличнойЧасти,Структура - Аннотация:
166+
// * Параметры - ТаблицаЗначений - Таблица параметров аннотации:
167+
// * Имя - Строка - Имя параметра.
168+
// * Значение - Произвольный - Значение параметра.
169+
// ИмяПараметра - Строка - Имя параметра.
170+
// ЗначениеПараметра - Произвольный - Значение параметра.
171+
//
172+
Процедура УстановитьЗначениеПараметраАннотации(Аннотация, ИмяПараметра, ЗначениеПараметра)
173+
```

‎docs/api/autumn/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Завязь](Классы/Завязь.md)
88
* [Табакерка](Классы/Табакерка.md)
99
* [ОпределениеЖелудя](Классы/ОпределениеЖелудя.md)
10+
* [ОпределениеАннотации](Классы/ОпределениеАннотации.md)
1011
* [ПрилепляемаяЧастица](Классы/ПрилепляемаяЧастица.md)
1112

1213
## Перечисления

‎docs/api/autumn/Аннотации/Аннотация.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
> [!INFO]
2+
> Документация из библиотеки [annotations](../../annotations/index.md).
3+
14
<!--@include: @/api/annotations/Аннотации/Аннотация.md-->

‎docs/api/autumn/Желуди/КонтейнерАннотаций.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
> [!INFO]
2+
> Документация из библиотеки [annotations](../../annotations/index.md).
3+
14
<!--@include: @/api/annotations/Классы/КонтейнерАннотаций.md-->

‎docs/api/autumn/Желуди/РазворачивательАннотаций.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1+
> [!INFO]
2+
> Документация из библиотеки [annotations](../../annotations/index.md).
3+
14
<!--@include: @/api/annotations/Классы/РазворачивательАннотаций.md-->

‎docs/api/autumn/Классы/60-ОпределениеАннотации.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
> [!INFO]
2+
> Документация из библиотеки [annotations](../../annotations/index.md).
3+
4+
<!--@include: @/api/annotations/Классы/ОпределениеАннотации.md-->

‎docs/api/autumn/Классы/60-ПрилепляемаяЧастица.md renamed to ‎docs/api/autumn/Классы/70-ПрилепляемаяЧастица.md

File renamed without changes.

‎docs/api/autumn/Модули/РаботаСАннотациями.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
> [!INFO]
2+
> Документация из библиотеки [annotations](../../annotations/index.md).
3+
4+
<!--@include: @/api/annotations/Модули/РаботаСАннотациями.md-->

0 commit comments

Comments
 (0)