From e284908a90ec257d7a1709fcd1b16c006ad032d9 Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Thu, 25 Aug 2016 08:01:27 +0200
Subject: [PATCH] [Doc] added nonlinear solver documentation

---
 .../ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md | 2 +-
 .../nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md    | 1 -
 .../nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md | 2 +-
 .../nonlinear_solvers/nonlinear_solver/t_linear_solver.md    | 5 ++++-
 .../prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md     | 5 ++++-
 .../prj/nonlinear_solvers/nonlinear_solver/t_name.md         | 4 +++-
 .../prj/nonlinear_solvers/nonlinear_solver/t_type.md         | 4 +++-
 7 files changed, 16 insertions(+), 7 deletions(-)
 delete mode 100644 Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md

diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md b/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md
index 576add64edc..617b5386e49 100644
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md
+++ b/Documentation/ProjectFile/prj/nonlinear_solvers/i_nonlinear_solvers.md
@@ -1 +1 @@
-\ogs_missing_documentation
+Contains nonlinear solver settings.
diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md
deleted file mode 100644
index 576add64edc..00000000000
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/Picard/c_Picard.md
+++ /dev/null
@@ -1 +0,0 @@
-\ogs_missing_documentation
diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md
index 576add64edc..cbd40579098 100644
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md
+++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/i_nonlinear_solver.md
@@ -1 +1 @@
-\ogs_missing_documentation
+Defines a single nonlinear solver.
diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md
index 576add64edc..66686d59532 100644
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md
+++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_linear_solver.md
@@ -1 +1,4 @@
-\ogs_missing_documentation
+Specifies the linear solver used to solve the linearized equation systems.
+
+The linear solver is referenced by \ref ogs_file_param__linear_solver__name
+"name".
diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md
index 576add64edc..3625da906eb 100644
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md
+++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_max_iter.md
@@ -1 +1,4 @@
-\ogs_missing_documentation
+Specifies the maximum number of iterations the nonlinear solver can make for
+solving a single equation system.
+
+If this number is exceeded, the nonlinear solver failed.
diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md
index 576add64edc..4651bb62229 100644
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md
+++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_name.md
@@ -1 +1,3 @@
-\ogs_missing_documentation
+Name of the nonlinear solver.
+
+Used to specify which process is solved by which nonlinear solver.
diff --git a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md
index 576add64edc..3da8618c7a3 100644
--- a/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md
+++ b/Documentation/ProjectFile/prj/nonlinear_solvers/nonlinear_solver/t_type.md
@@ -1 +1,3 @@
-\ogs_missing_documentation
+Type of the nonlinear solver.
+
+Can be <tt>Picard</tt> or <tt>Newton</tt>.
-- 
GitLab