Re: [Doxygen-users] Question on brief and detailed description

[Albert <alb...@gm...>]

Tom,

Did you have a look at commands like @verbatim ?

Albert


On Sat, Mar 8, 2014 at 5:56 PM, Tom Geraedts <ger...@gm...> wrote:

> 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
>
>
> ------------------------------------------------------------------------------
> Subversion Kills Productivity. Get off Subversion & Make the Move to
> Perforce.
> With Perforce, you get hassle-free workflows. Merge that actually works.
> Faster operations. Version large binaries.  Built-in WAN optimization and
> the
> freedom to use Git, Perforce or both. Make the move to Perforce.
>
> http://pubads.g.doubleclick.net/gampad/clk?id=122218951&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>