Doc examples listing

[kerautret]

PR Description

Add examples when missing in section http://liris.cnrs.fr/dgtal/doc/nightly/examples.html

Checklist

• [n.a] Unit-test of your feature with Catch.
• [n.a] Doxygen documentation of the code completed (classes, methods, types, members...)
• [n.a] Documentation module page added or updated.
• New entry in the ChangeLog.md added.
• No warning raised in Debug cmake mode (otherwise, Travis C.I. will fail).
• All continuous integration tests pass (Travis & appveyor)

[dcoeurjo]

test files shouldn't be used as examples

[kerautret]

It was already here (juste a move) ;)

[dcoeurjo]

@kerautret, we've discussed with @rolanddenis about doxygen issues in the documentation. To clarify the "@example" file description, what do you think to:

• ask the authors to document all example files
• move the doxygen example file description from the module pages into the example file (similarly to what you did in the tools)

what do you think?

[dcoeurjo]

As an example to my comment: \example and @example must be moved to the example source code.

[kerautret]

@kerautret, we've discussed with @rolanddenis about doxygen issues in the documentation. To clarify the "@example" file description, what do you think to:
ask the authors to document all example files

yes sure, now we can easily see with this PR which example should be completed.
But not sure that it implies a lot of doc comments since in general they are well given in the main module doc. Perhaps just to check if the short description of the example is ok and to check if the link to the doc module part exist.

move the doxygen example file description from the module pages into the example file (similarly to what you did in the tools)

yes, It should be a good idea and it could be more easy to check if all examples where documented ;)

[dcoeurjo]

diff;)

[kerautret]

;)

[dcoeurjo]

Excellent, merging.

[dcoeurjo]

Opening Issue #1191 to keep track.