#84: Olena 1.0 Code Examples (as documentation) -----------------------+---------------------------------------------------- Reporter: levill_r | Owner: Olena Team Type: task | Status: new Priority: major | Milestone: Olena 1.0 Component: Milena | Version: 1.0 Resolution: | Keywords: doc -----------------------+---------------------------------------------------- Old description:
Write code samples (to be installed into ''prefix''`/share/olena` or something). They shall be highly documented. I (Roland) don't think we should use Doxygen fo such a task: plain comments are just fine, as one can read them while having the whole code under one's eyes.
The description of this ticket might be extended by the kind of code samples that should be added to Olena 1.0ß, or even a detailed list. If such a list were to grow significantly, a dedicated Trac Wiki page would be a better place.
New description: Write code samples (to be installed into ''prefix''`/share/olena` or something). They shall be highly documented. I (Roland) don't think we should use Doxygen fo such a task: plain comments are just fine, as one can read them while having the whole code under one's eyes. The description of this ticket might be extended by the kind of code samples that should be added to Olena 1.0, or even a detailed list. If such a list were to grow significantly, a dedicated Trac Wiki page would be a better place. Comment (by levill_r): s/1.0ß/1.0/ -- Ticket URL: <https://trac.lrde.org/olena/ticket/84#comment:2> Olena <http://olena.lrde.epita.fr> Olena, a generic and efficient C++ image processing library.