update docs

1 files changed, 68 insertions, 0 deletions

diff --git a/lib/project.sh b/lib/project.sh
index 03e322f..f798fa0 100755
--- a/lib/project.sh
+++ b/lib/project.sh
@@ -6,14 +6,65 @@
 # project.sh - bash-скрипт для создания проекта в taskwarrior-tui.
 #******
 
+#****f* global.sh/getProjName
+# NAME
+#
+# getProjName - возвращает название проекта.
+#
+# USES BY
+#
+# - taskProj
+#
+# NOTES
+#
+# Cамое первое описание (description) является названием задачи.
+#
+# RETURN VALUE
+#
+# return {string} - название задачи.
+#******
 function getProjName() {
 	task _get "$1".description
 }
 
+#****f* global.sh/getExitCriteria
+# NAME
+#
+# getExitCriteria - возвращает критерий завершения.
+#
+# USES BY
+#
+# - taskProj
+#
+# NOTES
+#
+# Следующее после самого первого описания (description) идёт - критерий завершения.
+#
+# RETURN VALUE
+#
+# return {string} - критерий завершения задачи.
+#******
 function getExitCriteria() {
 	task _get "$1".annotations.1.description
 }
 
+#****f* global.sh/taskCheck
+# NAME
+#
+# taskCheck - проверка обрабатываемой задачи.
+#
+# DESCRIPTION
+#
+# Проверка задачи на наличие: критерия завершения, названия проекта, первого шага и существующего проекта.
+#
+# USES BY
+#
+# - taskProj
+#
+# RETURN VALUE
+#
+# return {number} - статус завершения.
+#******
 function taskCheck() {
 	local task
 
@@ -40,6 +91,23 @@ function taskCheck() {
 	esac
 }
 
+#****f* global.sh/taskProj
+# NAME
+#
+# taskProj - создание проекта.
+#
+# NOTES
+#
+# Проект создается на основе:
+#
+# - названия проекта;
+# - критерия завершения;
+# - первого шага.
+#
+# USES BY
+#
+# - tskw.sh
+#******
 function taskProj() {
 	local task
 	local projName