Вставка изображений

Команды для графики позволяют вставлять изображения в документацию. Изображения могут отображаться как отдельные абзацы или в тексте.

\image

Команда \image отображает изображение, указанное в её первом аргументе, и центрирует его в отдельном абзаце.

Команда принимает два аргумента. Первый — имя файла изображения. Второй аргумент — необязательное описание изображения, эквивалентное атрибуту HTML alt="" в теге изображения. Описание используется для всплывающих подсказок и для браузеров, не поддерживающих изображения, таких как текстовый браузер Lynx.

Остальной текст после имени файла — это необязательный аргумент описания. Убедитесь, что после имени файла или описания стоит перевод строки. Если аргумент описания занимает несколько строк, требуются фигурные скобки.

/ *!
    Qt is a C++ toolkit for cross-platform GUI application development.

    \image happyguy.jpg "Happy guy"

    Qt provides single-source portability across Microsoft
    Windows, macOS, Linux, and all major commercial Unix
    variants. It is also available for embedded devices.
* /

QDoc отображает это так:

Qt — это набор инструментов C++ для кроссплатформенного разработки графических приложений.

Qt обеспечивает переносимость одного исходного кода между Microsoft Windows, macOS, Linux и всеми основными коммерческими вариантами Unix. Он также доступен для встроенных устройств.

См. также \inlineimage и \caption.

\inlineimage

Команда \inlineimage отображает изображение, указанное в её аргументе. Изображение отображается в строке вместе с остальным текстом.

Команда принимает два аргумента. Первый — имя файла изображения. Второй аргумент — необязательное описание изображения, эквивалентное атрибуту HTML alt="" в теге изображения. Описание используется для всплывающих подсказок и для случаев, когда браузер не поддерживает изображения, например, текстовый браузер Lynx.

Наиболее распространённое использование команды \inlineimage — в списках и таблицах. Вот пример вставки inline-изображений в список:

/ *!
    \list 1
      \li \inlineimage happy.gif Oh so happy!
      \li \inlineimage happy.gif Oh so happy!
      \li \inlineimage happy.gif Oh so happy!
    \endlist
* /

QDoc отображает это так:

Вот пример вставки inline-изображений в таблицу:

/ *!
    \table
    \header
        \li Qt
        \li Qt Creator
    \row
        \li \inlineimage happy.gif Oh so happy!
        \li \inlineimage happy.gif Oh so happy!
    \row
        \li \inlineimage happy.gif Oh so happy!
        \li \inlineimage happy.gif Oh so happy!
    \endtable
* /

QDoc отображает это так:

Qt	Qt Creator

Команда также может использоваться для вставки изображения в строку текста.

/ *!
    \inlineimage training.jpg Qt Training
    The Qt Programming course is offered as a
    five day Open Enrollment Course. The classes
    are open to the public. Although the course is open
    to anyone who wants to learn, attendees should
    have significant experience in C++ development
    to derive maximum benefit from the course.
* /

QDoc отображает это так:

Курс программирования Qt предлагается как пятидневный открытый курс. Занятия открыты для всех желающих. Несмотря на открытость курса для всех желающих изучать, участникам рекомендуется иметь значительный опыт разработки на C++, чтобы получить максимальную пользу от курса.

См. также \image и \caption.

\caption

Команда \caption предоставляет подпись к изображению.

Команда принимает весь текст до конца абзаца как подпись. Экспериментируйте, пока не получите желаемый эффект.

/ *!
  \table 100%
    \row
      \li \image windowsvista-pushbutton.png
         \caption The QPushButton widget provides a command button.
      \li \image windowsvista-toolbutton.png
         \caption The QToolButton class provides a quick-access button to commands
         or options, usually used inside a QToolBar.
   \endtable
* /

QDoc отображает это так:

См. также \image и \inlineimage