// does something...
// returns: true if did something

inline bool something();

// something implementation...

inline bool something() { return false; }

/**
 * Does something. 
 * @warning sometimes craches :-)
 * @return foo value.
 */
int foo(
    int bar    ///< nice parameter.
    );

/// Описание класса и протокола взаимодействия с ним
/// ...
class foo
{
public:
   foo();
   void bar();
};

implement class foo
{
   /// Подробное описание конструктора
   /// ...
   foo()
   {
   }

   /// Подробное описание функции
   /// ...
   void bar()
   {
   }
}

/// \par{Параметр ля-ля-ля}
/// \ret{Возвращает такой-то результат}

x = 1765; //magic number, source is bla-bla-bla;

//param value must be in [-100..200] range
int foo(in param);

ЗХ>x = 1765; //magic number, source is bla-bla-bla;

ЗХ>//param value must be in [-100..200] range
ЗХ>int foo(in param);
ЗХ>

    class stroker
    {
        . . .
        // Stroke parameters
        void line_cap(line_cap_e lc);
        void line_join(line_join_e lj);
        void inner_join(inner_join_e ij);
        void width(double w);
        void miter_limit(double ml);
        void approximation_scale(double as);
        void shorten(double s);
        . . .
    };

MS>/// \par{Параметр ля-ля-ля}
MS>/// \ret{Возвращает такой-то результат}
MS>

void some_func(
    //! Этот комментарий будет описанием аргумента.
    int param1,
    int param2 //!< И этот так же.
    )
    { ... }

/*!
    \file
    \brief Тестовый класс.
*/

#if !defined( TEST_HPP )
#define TEST_HPP

namespace test
{

class Test
    {
    public :
        Test();
        Test( int v );

        int v() const;
        void set_v( int v );

    private :
        int v_;
    };

} /* namespace test */

#endif

/*!
    \file
    \brief Тестовый класс.
*/

#include "test.hpp"

/*!
    \brief Пространство имен для размещения тестового класса.

    Все основные текстовые классы размещаются в данном пространстве имен.
*/
namespace test
{

/*!
    \class Test "test.hpp"
    \brief Тестовый класс.

    Это тестовый класс для проверки возможности описания классов
    не в заголовочном файле.
*/

/*!
    \var Test::v_
    Значение, которое хранится в классе Test.
*/

/*!
    \brief Конструктор по умолчанию

    Устанавливает \a v_ в ноль.
*/
Test::Test()
    :    v_( 0 )
    {}

/*!
    \brief Инициализирующий конструктор.

    Назначает \a v_ указанное значение.
*/
Test::Test(
    //! Начальное значение для \a v_.
    int v )
    :    v_( v )
    {}

/*!
    \name Getter-/Setter-ы
    \{
*/
int Test::v() const
    {
        /*!
            \par Thread-safe?
            Да.
        */

        return v_;
    }

void Test::set_v( int v )
    {
        /*!
            \par Thread-safe?
            Нет.

            \attention
            В текущей версии не выполняет никаких проверок!
        */

        v_ = v;
    }
/*! \} */

} /* namespace test */

/*!
    \page abstract Аннотация

    Задача этого теста -- показать возможности Doxygen по созданию
    полноценной документации. Толчком к этому послужило обсуждение
    на RSDN.ru (<a href="http://rsdn.ru/forum/Message.aspx?mid=1401092">Doxygen, JavaDoc со товарищи...</a>).
    В особенности, сообщение <a href="http://rsdn.ru/Users/Profile.aspx?uid=12737">McSeem2</a>
    (<a href="http://rsdn.ru/forum/Message.aspx?mid=1405520&only=1">Re[3]: Doxygen, JavaDoc со товарищи...</a>),
    в котором он описал, что хотел бы:
    - чтобы было меньше бардака, в частности, чтобы описания классов можно
    было делать не в декларациях классов (т.е. не в hpp-файлах);
    - чтобы оформление комментариев было в TeX-стиле.

    Но, на самом деле, в Doxygen все так и есть. Может быть с шаблонами и есть
    пока проблемы, но ведь Doxygen развивается. Со временем и шаблоны подтянутся.
*/

/*!
    \page install Инсталляция

    - Создайте файл test.hpp.
    - Создайте файл test.cpp.
    - Создайте файл Doxyfile следующего содержания:
    \include Doxyfile
    - Запустите doxygen (я использовал версию 1.4.3).
    - В подкаталогах html и latex будет создана необходимая документация.
*/

/*!
    \page desc Описание

    Здесь может быть какое-то сложное описание, разбитое на секции,
    подсекции и подподсекции.

    \section desc_sec1 Секция

    Как всегда, в примерах самое сложное -- это написать какой-то
    осмысленный текст.

    \subsection desc_sec1_subsec Подсекция

    Ну вот, опять та же проблема -- не хватает фантации.

    \subsection desc_sec1_subsec2 Еще одна подсекция

    Здесь вообще ничего не будет, кроме нескольких подподсекций.

    \subsubsection desc_sec1_subsec2_1 Мелкое описание

    Пример подподсекции.

    \subsubsection desc_sec1_subsec2_2 Еще одно мелкое описание

    Ну совсем мелкое.
*/

/*!
    \mainpage Тестовый проект для демонстрации возможностей Doxygen

    Главная задача -- показать, что с помощью Doxygen можно выстраивать
    довольно сложную документацию.

    \subpage abstract

    \subpage install

    \subpage desc
*/

# Doxyfile 1.4.3
PROJECT_NAME           = Test Project
OUTPUT_LANGUAGE        = Russian
EXTRACT_PRIVATE        = YES
FILE_PATTERNS          = *.dox *.?pp
EXAMPLE_PATH           = .