\endhtmlonly

\page techdoc Technical Documentation - \subpage codingstyle - \subpage extendlib - \subpage ressources \htmlonly

\endhtmlonly*/ /*! \page codingstyle Coding Style\htmlonly

The coding style is going to be updated. However, there are few reference documents available here:

• https://trac.lrde.org/olena/wiki/CodingStyle
• https://olena.lrde.epita.fr/cgi-bin/twiki/view/Olena/CodingStyle010

\endhtmlonly*/ /*! \page extendlib Extend the Library\htmlonly

\endhtmlonly\section newvaluetype Add a new image value type\htmlonly

\endhtmlonly\section newimagetype Add a new image type\htmlonly

\endhtmlonly\section newroutine Add a new routine\htmlonly

Writing a new routine in Milena requires a specific layout in the code. This layout is described in figure ??.

For a better understanding, we are going to comment this figure (fig. ??) from the bottom to the top.

• Facade. The facade is the public routine that will be called by the user. It should not contains any processing code but call dispatch routines. It must be fully generic.

  An example: \endhtmlonly\include devel/facade.cc.raw\htmlonly

• Implementation dispatch. According to specific information, the dispatch will call the proper implementation of the algorithm. The dispatch is almost always static. It might contains dynamic dispatch in very specific cases. Dispatch function names are composed of the routine name with “_dispatch” appended to it. Dispatch entry point routine must have the same prototype as the facade. Dispatch routines are not intended to be called by the user.

  An example: \endhtmlonly\include devel/dispatch.cc.raw\htmlonly

• Specific implementation. Implementation routine are intended to be called by the user. Thus, they must have an explicit name of what they do and what they take as parameter. They implement de processing code which may be specific for certain types. namespace impl may also have a sub namespace called generic for the generic algorithm.

  An example: \endhtmlonly\include devel/impl.cc.raw\htmlonly

• Shared tests and internal routines. This is the right place to move all the internal routines related to this new routine. They will be hidden to the user.
• Facade prototype. This is what the user should see first if the file is edited. The documentation should be written here.

Note that all parts of the file except the “facade prototype” are included between MLN_INCLUDE_ONLY guards.

\endhtmlonly*/ /*! \page ressources Developer Ressources\htmlonly

\endhtmlonly\section quality Project Quality\htmlonly

• QA Center : https://trac.lrde.org/olena/wiki/QACenter
• Buildbot : https://buildfarm.lrde.org/buildfarm/oln/
• Trac : http://trac.lrde.org/olena

\endhtmlonly\section qna Questions and Answers\htmlonly

The best way to keep in touch with the latest patches or ask your questions is to subscribe to our mailing lists.

Currently four mailing-lists are available:

You can subscribe to these mailing lists at the following address:

https://www.lrde.epita.fr/mailman/listinfo/

Just click on the name of the mailing list you want to subscribe to and fill out the form.

This document was translated from L^AT_EX by H^EV^EA.