Включение изображений

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

\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 — в списках и таблицах. Вот пример включения встроенных изображений в список:

/ *!
    \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 отображает это так:

Вот пример включения встроенных изображений в таблицу:

/ *!
    \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