[Doxygen-users] Question on brief and detailed description

[Tom G. <ger...@gm...>]

Dear mailinglist,

I have been very busy trying to integrate doxygen into a software archive.
It will be a huge improvement!

However, I'm running into an annoying problem which I cant seem to solve at
the moment.

I have the following file description, which is is not correctly recognized
as a single text, but broken up into text descriptions and something that
looks like tagged code descriptions. I'm not sure now what to do to tell
doxygen that the whole text should be seen as text only.

File description example:

/// \file example.cpp
///      This module processes example signals (samples) inorder to
///      reduce example artefacts originating from example motion.
///      This is realised using the example example example example
///      (example) method, which relies on two principles:
///
///      -   Example text example text
///          Example text example text
///          Example text example text
///
///      The following example illustrates this for a example example
resolution:
///
///                   **                                    **
///  ^ example **  *                                 **  *
///  | example *     *                               *
///  |           **       *                            **
///  |          *          *                          *      ----> time
///            *            **                       *
///        ****               *****              ****
///    ****                        **************
///
///                        |<------------------------>|
///                                example
///
///                  |__________________|__________________|
///                -128                 0                +127  ---->
///                                                           optimum
///                                                           ky-value
///
///      The term 'example' refers to the following: each time when a
///      exampleis done, there is only one example-value which perfectly
///      matches the example example at that time.

In this specific example, the lines with stars in it are not displayed as
normal text.

I'm quite sure that somehow doxygen see 'tags' that indicate code
descriptions or something similar.

Best regards,

Tom