dumux merge requestshttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests2018-12-19T16:32:42Zhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1451Merge branch 'feature/handbook-small-improvement-gnuplot' into 'master'2018-12-19T16:32:42ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/handbook-small-improvement-gnuplot' into 'master'[handbook][gnuplot] Improve wording, formatting
See merge request dumux-repositories/dumux!1450
(cherry picked from commit 522483f208ba19261c9d7d8f1ab1120461cacf29)
97dd10df [handbook][gnuplot] Improve wording, formatting[handbook][gnuplot] Improve wording, formatting
See merge request dumux-repositories/dumux!1450
(cherry picked from commit 522483f208ba19261c9d7d8f1ab1120461cacf29)
97dd10df [handbook][gnuplot] Improve wording, formatting3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1452Feature/handbool spellchecl2018-12-19T16:43:30ZTimo Kochtimokoch@math.uio.noFeature/handbool spellchecl3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1458Merge branch 'feature/cleanup-handbook' into 'master'2018-12-20T16:11:44ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/cleanup-handbook' into 'master'Feature/cleanup handbook
Closes #635
See merge request dumux-repositories/dumux!1456
(cherry picked from commit 97589d56095893e4b2b29251d060344e6063c42e)
4ff969b2 [handbook] cleanup, restructure discretization
c00a1139 [handbook] ren...Feature/cleanup handbook
Closes #635
See merge request dumux-repositories/dumux!1456
(cherry picked from commit 97589d56095893e4b2b29251d060344e6063c42e)
4ff969b2 [handbook] cleanup, restructure discretization
c00a1139 [handbook] rename files
2e56a9a5 [handbook] correct quick installation and cleanup3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1465[doc] Update build badge to new url2018-12-21T11:45:00ZTimo Kochtimokoch@math.uio.no[doc] Update build badge to new url3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1466Merge branch 'feature/update-readme-badge' into 'master'2018-12-21T11:45:31ZTimo Kochtimokoch@math.uio.noMerge branch 'feature/update-readme-badge' into 'master'[doc] Update build badge to new url
See merge request dumux-repositories/dumux!1465
(cherry picked from commit 627d394a9915dcfbf472e15eea7f64297dc3d45b)
9271c26c [doc] Update build badge to new url[doc] Update build badge to new url
See merge request dumux-repositories/dumux!1465
(cherry picked from commit 627d394a9915dcfbf472e15eea7f64297dc3d45b)
9271c26c [doc] Update build badge to new url3.0Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1564[changelog][higherorder]2019-04-30T13:28:20ZNed Coltman[changelog][higherorder]* [x] Describe higher order changes in change log
* [x] Describe RANS interface changes in change log
fixes #668 * [x] Describe higher order changes in change log
* [x] Describe RANS interface changes in change log
fixes #668 3.1Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1599[gridmanager][yasp] Improve doc2019-05-17T15:00:04ZTimo Kochtimokoch@math.uio.no[gridmanager][yasp] Improve doc3.1Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1611[io][gridmanager] Improve error message if grid manager not found2019-05-22T18:17:12ZTimo Kochtimokoch@math.uio.no[io][gridmanager] Improve error message if grid manager not found3.1Kilian WeishauptKilian Weishaupthttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1629[gitlab] Add templates for issues and feature requests / merge requests2019-06-01T23:36:42ZTimo Kochtimokoch@math.uio.no[gitlab] Add templates for issues and feature requests / merge requests3.1Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1676Update README.md with doc section2019-07-25T13:32:11ZTimo Kochtimokoch@math.uio.noUpdate README.md with doc section3.1Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1681[readme] Add coverage info2019-07-30T20:18:39ZTimo Kochtimokoch@math.uio.no[readme] Add coverage info3.1Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1685[readme] Fix coverage link2019-08-06T08:46:28ZTimo Kochtimokoch@math.uio.no[readme] Fix coverage link3.1Timo Kochtimokoch@math.uio.noTimo Kochtimokoch@math.uio.nohttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1721[doxygen] remove all sources of warnings, if easily possible2019-10-02T06:55:31ZBeatrix Becker[doxygen] remove all sources of warnings, if easily possibleChanges only affect documentation, should be possible to merge once todos are removed. @DennisGlaeser : I introduced 3-4 todos when I encountered variables that I don't know the purpose of. Could you clarify this or if you have no time p...Changes only affect documentation, should be possible to merge once todos are removed. @DennisGlaeser : I introduced 3-4 todos when I encountered variables that I don't know the purpose of. Could you clarify this or if you have no time point me to someone who can?
Note: This does not solve all problems with doxygen. I'm going to open an issue to ask for help with the rest of the warnings.3.1Katharina HeckKatharina Heckhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1547[examples] Set up problem for documentation (2p, adaptive, point source)2019-10-07T15:03:48ZSina Ackermann[examples] Set up problem for documentation (2p, adaptive, point source)3.1Katharina HeckKatharina Heckhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1351Cleanup/doxygen for 3.02019-10-07T16:11:27ZSimon EmmertCleanup/doxygen for 3.0When checking doxygen, the doxygen should be built and the doxyerr.log should have as little lines/errors as possible. We currently have around 1800 lines of errors and want to reduce this to 1 to 7 lines.
The Doxygen for a **file** sh...When checking doxygen, the doxygen should be built and the doxyerr.log should have as little lines/errors as possible. We currently have around 1800 lines of errors and want to reduce this to 1 to 7 lines.
The Doxygen for a **file** should look like this:
```
/*!
* \file
* \ingroup Common
* \brief Manages the handling of time dependent problems
*/
```
It should always contain the `\file` first.
The `\ingroup` gives a Group that is as **precise** as possible and is part of the `modules.txt`
The `\brief` is a **short comment** on what happens in the file. Alternatively a `\copybrief` could be used. **Make sure the copybrief links to the correct section and is not ambigous!**
Additional text could be added similar to the function description.
A class could look like this:
```
/*!
* \ingroup Common
* \brief Manages the handling of time dependent problems.
*
* This class facilitates the time management of the simulation.
* It doesn't manage [...]
* [...]
* [...] index starting at 0.
*
* \note Time and time step sizes are in units of seconds
*/
```
The class should always have the proper `\ingroup` just like the file.
The `\brief` should always contain a **short description**, and only in very very rare occasions a class can have a `\copybrief`. In the end this is also documentation for users that do not build doxygen and `\copybriefs` from another file are most likely not very useful.
The main part should be an in depth explanation of what is done. This should contain math-expressions where applicable. They can look like the following:
```
* This class implements a spline \f$s(x)\f$ for which, given \f$n\f$ sampling
* points \f$x_1, \dots, x_n\f$, the following conditions hold
*\f{align*}{
s(x_i) & = y_i \quad \forall i \in \{1, \dots, n \}\\
s'(x_1) & = m_1 \\
s'(x_n) & = m_n
\f}
*
```
For a **function** in a file the Doxygen can look like this:
```
/*!
* \brief Set the current simulated time and the time step index.
*
* \param t The time \f$\mathrm{[s]}\f$ which should be jumped to
* \param stepIdx The new time step index
*/
void setTime(Scalar t, int stepIdx)
{ time_ = t; timeStepIdx_ = stepIdx; }
```
The function has a **short comment** with the `\brief`.
If there are **function-arguments** that are not self-explanatory, they should be described using `\param`.** Always explain all params or no params at all!** Otherwise Doxygen will throw an error.
Additional Doxygen-commands that might be useful are `\note` for giving an important note/hint on what the function does as well as `\return` which specifies the return value (if applicable).
We will go through the errors according to folders:
* [x] freeflow (262) @nedc
* [x] material (209) @ackerm
* [x] multidomain (168)
* [x] porousmediumflow (558) @scholz
* [x] common, discretization, geomechanics @hommel
* [ ] nonlinear,io,linear, material, nonlinear, parallel
Fix/Document everything according to the guideline. If there is a problem with a copybrief try to fix it or contact @scholz for help.
Closes #5963.0https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1690Feature/example shallow water2019-10-08T07:30:02ZMartin UtzFeature/example shallow water3.1Katharina HeckKatharina Heckhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1736Docu/doxygen instructions2019-10-08T13:32:26ZSina AckermannDocu/doxygen instructionsCopied Simon's doxygen clean-up instructions from !1351 to a new README.md
The respective link in the styleguide points to the master branch and does not work right now.Copied Simon's doxygen clean-up instructions from !1351 to a new README.md
The respective link in the styleguide points to the master branch and does not work right now.3.1Katharina HeckKatharina Heckhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1757[doc] Update dune.module to version 3.2-git2019-10-11T16:14:23ZTimo Kochtimokoch@math.uio.no[doc] Update dune.module to version 3.2-git3.2Katharina HeckKatharina Heckhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1758[doc] Update CHANGELOG.md2019-10-11T16:15:01ZTimo Kochtimokoch@math.uio.no[doc] Update CHANGELOG.md3.2Katharina HeckKatharina Heckhttps://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/merge_requests/1800[doc] Correct typos in comments2019-11-19T22:31:38ZKai Wendel[doc] Correct typos in comments3.2