Skip to content

Commit 0d1dc24

Browse files
committed
new style of docs for Session.h
1 parent 5c045e1 commit 0d1dc24

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

src/protocol/Session.h

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ namespace STIP {
2323
public:
2424
/// \brief Обработка входящего пакета
2525
///
26-
/// Процесс обработки входящего пакетов
2726
/// Помечает, что пакет с данными получен
2827
///
2928
/// \param packet пакет
@@ -129,10 +128,8 @@ namespace STIP {
129128
/// \brief Инициализация отправки
130129
///
131130
/// Инициализация отправки сообщения
132-
/// Установка команды, идентификатора сессии, идентификатора пакета и размера пакета
133-
/// Копирование данных в пакет
134-
/// Отправка пакета
135-
/// Ожидание ответа
131+
/// Установка команды, идентификатора сессии, идентификатора пакета и размера пакета.
132+
/// Копирование данных в пакет, отправка пакета, ожидание ответа
136133
///
137134
/// \return возвращает true
138135
bool initSend();
@@ -148,7 +145,6 @@ namespace STIP {
148145
///
149146
/// Ожидание подтверждения
150147
///
151-
///
152148
/// \return возвращает статус 5
153149
bool waitApproval();
154150

@@ -166,10 +162,8 @@ namespace STIP {
166162

167163
/// \brief Отправка части данных
168164
///
169-
/// Отправка части данных
170-
/// Установка команды, идентификатора сессии и идентификатора части пакета
171-
/// Копирование части данных в пакет
172-
/// Отправка пакета
165+
/// Установка команды, идентификатора сессии и идентификатора части пакета.
166+
/// Копирование части данных в пакет, отправка пакета
173167
///
174168
/// \param packet_id - идентификатор пакета
175169
void sendPart(size_t packet_id);
@@ -194,7 +188,6 @@ namespace STIP {
194188

195189
/// \brief Обработка входящего пакета ?
196190
///
197-
/// Процесс обработки входящего пакета
198191
/// Проверка команды пакета
199192
///
200193
/// \param packet - пакет
@@ -240,7 +233,7 @@ namespace STIP {
240233
public:
241234
/// \brief Добавление сессии
242235
///
243-
/// Добавление сессии в список сессий
236+
/// Добавление сессии в список сессий.
244237
/// Проверка наличия уже сессии с таким идентификатором
245238
///
246239
/// \param session
@@ -255,7 +248,7 @@ namespace STIP {
255248

256249
/// \brief Получение сессии
257250
///
258-
/// Получение сессии по идентификатору
251+
/// Получение сессии по идентификатору.
259252
/// Проверка наличия сессии с таким идентификатором
260253
///
261254
/// \param id - идентификатор сессии
@@ -264,8 +257,8 @@ namespace STIP {
264257

265258
/// \brief Генерация идентификатора сессии
266259
///
267-
/// Генерация идентификатора сессии
268-
/// Генерация случайного числа в диапазоне от 0 до 1000000
260+
/// Генерация идентификатора сессии.
261+
/// Генерация случайного числа в диапазоне от 0 до 1000000.
269262
/// Проверка наличия сессии с таким идентификатором
270263
///
271264
/// \return сгенерированный идентификатор сессии

0 commit comments

Comments
 (0)