Обновление

2021-10-20 10:11:49 +03:00 · 2021-10-20 10:11:49 +03:00 · 8e3f80d82c
commit 8e3f80d82c
parent 763ec72402
2 changed files with 107 additions and 24 deletions
--- a/wiki/Prog/Development/CMake
+++ b/wiki/Prog/Development/CMake
@ -30,7 +30,6 @@ include::{l10ndir}/{lang}.adoc[]
    ├── .git
    ├── cmake
    │   ├── cmlib
-    │   ├── doc
    │   ├── etc
    │   │   └── uncrustify
    │   ├── find
@ -68,7 +67,6 @@ include::{l10ndir}/{lang}.adoc[]
 |`.git`                    | Системные файлы репозитория Git
 |`cmake`                   | Файлы с дополнительными функциями для CMake
 |`cmake/cmlib`             | Библиотека функций для CMake
-|`cmake/doc`               | Правила для автоматической генерации документации
 |`cmake/etc`               | Файлы настроек, используемые в CMake
 |`cmake/etc/uncrustify`    | Файл настройки для программы автоматического форматирования исходных текстов
 |`cmake/find`              | Модули CMake для поиска внешних программ и библиотек
@ -129,7 +127,6 @@ git init
 git submodule add https://git.246060.ru/f1x1t/cmlib.git cmake/cmlib
 git submodule add https://git.246060.ru/f1x1t/cmake-find.git cmake/find
 git submodule add https://git.246060.ru/f1x1t/cmake-generators.git cmake/generators
-git submodule add https://git.246060.ru/f1x1t/cmake-doc.git cmake/doc
 git commit -a -m "Начало проекта"
 ----

@ -158,9 +155,6 @@ git push -u origin master
 [submodule "cmake/generators"]
 	path = cmake/generators
 	url = git@git.246060.ru:f1x1t/cmake-generators.git
-[submodule "cmake/doc"]
-	path = cmake/doc
-	url = git@git.246060.ru:f1x1t/cmake-doc.git
 ----

 на
@ -176,9 +170,6 @@ git push -u origin master
 [submodule "cmake/generators"]
 	path = cmake/generators
 	url = ../../f1x1t/cmake-generators.git
-[submodule "cmake/doc"]
-	path = cmake/doc
-	url = ../../f1x1t/cmake-doc.git
 ----

 Обновить пути и сохранить изменения:
@ -504,7 +495,8 @@ cmlib_generate_private_config_hpp()
 add_subdirectory(src/cmlib-example)

 # Документация
-add_subdirectory(cmake/doc)
+add_breathe_target(doc-breathe)
+add_doxygen_target(doc-doxygen LATEX YES HTML YES)

 # Создание вспомогательных символических ссылок
 add_dependencies(cmlib-example create_auxilary_symlinks)
@ -620,7 +612,8 @@ cmlib_generate_private_config_hpp()
 add_subdirectory(src/cmlib-example)

 # Документация
-add_subdirectory(cmake/doc)
+add_breathe_target(doc-breathe)
+add_doxygen_target(doc-doxygen LATEX YES HTML YES)

 # Создание вспомогательных символических ссылок
 add_dependencies(cmlib-example create_auxilary_symlinks)
@ -1545,12 +1538,68 @@ make all_unity

 === Документирование кода

-Надо написать.
+Для документирования кода используются блоки комментариев,
+оформленные для обработки программой https://www.doxygen.nl[Doxygen].
+Установка программы:
+
+[source,sh]
+----
+sudo apt-get install doxygen
+----
+
+Пример комментария:
+
+[source,c++]
+----
+/**
+ * @brief Базовый класс
+ */
+class Base {
+public:
+	/**
+	 * @brief Конструктор
+	 */
+	Base();
+	/**
+	 * @brief Деструктор
+	 */
+	~Base();
+	/**
+	 * @brief Вычисление квадратного корня
+	 * @param value Входное значение
+	 * @return Квадратный корень от value
+	 */
+	double sqrt(double value);
+};
+----
+
+Поддержка автоматической генерации документации реализована
+в функциях библиотеки CMLib `add_doxygen_target` и
+`add_breathe_target`, которые необходимо вызвать в основном
+файле `CMakeLists.txt` проекта.
+
+[source,cmake]
+----
+# Документация
+add_doxygen_target(doc-doxygen LATEX YES HTML YES)
+add_breathe_target(doc-breathe)
+----
+
+В результате будут добавлены цели `doc-doxygen` и `doc-breathe`,
+которые можно использовать после конфигурирования проекта:
+
+[source,cmake]
+----
+make doc-doxygen
+make doc-breathe
+----

-Поддержка документирования кода реализована в функциях
-`add_doxygen` и `add_breathe`, для исполнения которых
-добавляются цели `doc-doxygen` и `doc-breathe`.
 Шаблоны для комментирования файлов, классов и функций
 можно автоматически расставить в файлах исходных кодов
 исполнением цели `doc-add-comments` при наличии установленной
-программы `uncrustify`.
+программы `uncrustify`:
+
+[source,cmake]
+----
+make doc-add-comments
+----
--- a/команды.adoc
+++ b/команды.adoc
@ -62,9 +62,9 @@ untracked  -> staged:     git add
 staged     -> unmodified: git commit
 unmodified -> modified:   редактирование
 modified   -> staged:     git add
-modified   -> untracked:  git rm --cached
-unmodified -> untracked:  git rm --cached
-staged     -> untracked:  git rm --cached
+modified   -> untracked:  git rm ~--cached
+unmodified -> untracked:  git rm ~--cached
+staged     -> untracked:  git rm ~--cached
@enduml
 ----

@ -125,7 +125,7 @@ participant remote    as "Удалённый репозиторий\n(remote rep
 [-> workspace : <font color=red>Начало работы</font>
 activate workspace
 remote    -> local :      <font color=red>Получение изменений с сервера</font>\n<b>git fetch</b>
-remote    -> local :      <font color=red>Обновление подмодулей</font>\n<b>git submodule update --recursive --init</b>
+remote    -> local :      <font color=red>Обновление подмодулей</font>\n<b>git submodule update ~--recursive ~--init</b>
 workspace <-> local :     <font color=red>Просмотр информации</font>\n<b>git status</b>
 workspace <-> local :     <font color=red>Переход на ветку master</font>\n<b>git checkout master</b>
 local     -> workspace :  <font color=red>Слияние с удалённой веткой</font>\n<b>git merge origin/master</b>
@ -135,11 +135,45 @@ workspace ->o workspace : <font color=red>Редактирование</font>
 workspace <-> local :     <font color=red>Просмотр изменений</font>\n<b>git diff</b>
 workspace -> index :      <font color=red>Занесение файлов в индекс</font>\n<b>git add</b>
 index     -> local :      <font color=red>Фиксация изменений</font>\n<b>git commit</b>
-local     ->o local :     <font color=red>Присвоение ветки осмысленного названия</font>\n<b>git branch -m temp branch_name</b>
-local     ->o local :     <font color=red>Переход на ветку</font>\n<b>git checkout branch_name</b>
+local     ->o local :     <font color=red>Присвоение ветки осмысленного названия</font>\n<b>git branch -m temp new_task</b>
+local     ->o local :     <font color=red>Переход на ветку</font>\n<b>git checkout new_task</b>
 remote    -> local :      <font color=red>Получение изменений с сервера</font>\n<b>git fetch</b>
-local     ->o local :     <font color=red>Слияние изменений с сервера в текущую ветку (branch_name)</font>\n<b>git merge origin/master</b>
-local     -> remote :     <font color=red>Отправка ветки на сервер</font>\n<b>git push origin branch_name</b>
+local     ->o local :     <font color=red>Слияние изменений с сервера в текущую ветку (new_task)</font>\n<b>git merge origin/master</b>
+local     -> remote :     <font color=red>Отправка ветки на сервер</font>\n<b>git push origin new_task</b>
+remote    ->] :           <font color=red>Создание запроса на слияние</font>
+deactivate workspace
+@enduml
+----
+
+Альтернативный пример действий, выполняемых пользователем в совместном
+проекте, приведён на <<workflow-alt,диаграмме>>.
+
+[[workflow-alt]]
+[.text-center]
+.Альтернативная последовательность действий
+[plantuml]
+----
+@startuml
+skinparam defaultFontSize 24
+skinparam padding 16
+
+participant workspace as "Рабочий каталог\n(working dir)"
+participant index     as "Индекс\n(index)" #77FF77
+participant local     as "Локальный репозиторий\n(local repository)" #FF7777
+participant remote    as "Удалённый репозиторий\n(remote repository)" #7777FF
+
+[-> workspace : <font color=red>Начало работы</font>
+activate workspace
+workspace <-> local :     <font color=red>Переход на локальную ветку master</font>\n<b>git checkout master</b>
+remote    -> workspace :   <font color=red>Слияние с удалённой веткой и обновление рабочего каталога</font>\n<b>git pull</b>
+workspace <-> local : <font color=red>Создание новой ветки</font>\n<b>git checkout -b new_task</b>
+workspace ->o workspace : <font color=red>Редактирование</font>
+workspace <-> local :     <font color=red>Просмотр изменений</font>\n<b>git diff</b>
+workspace -> index :      <font color=red>Занесение файлов в индекс</font>\n<b>git add</b>
+index     -> local :      <font color=red>Фиксация изменений</font>\n<b>git commit</b>
+remote    -> local :      <font color=red>Получение изменений с сервера</font>\n<b>git fetch</b>
+local     ->o local :     <font color=red>Слияние изменений с сервера в текущую ветку (new_task)</font>\n<b>git merge origin/master</b>
+local     -> remote :     <font color=red>Отправка ветки на сервер</font>\n<b>git push origin new_task</b>
 remote    ->] :           <font color=red>Создание запроса на слияние</font>
 deactivate workspace
@enduml