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

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

\image

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

Команда принимает два аргумента. Первый аргумент — имя файла изображения. Второй аргумент является необязательным и представляет собой краткое описание изображения, аналогичное атрибуту alt="" в теге изображения HTML. Описание используется для подсказок и для браузеров, которые не поддерживают изображения, например, текстового браузера 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 отображает изображение, указанное в аргументе, вместе с остальным текстом.

Команда принимает два аргумента. Первый аргумент — имя файла изображения. Второй аргумент является необязательным и представляет собой краткое описание изображения, аналогичное атрибуту alt="" в теге изображения HTML. Описание используется для подсказок и для браузеров, которые не поддерживают изображения, например, текстового браузера 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 предлагается как пятидневный открытый курс. Занятия открыты для всех желающих. Несмотря на открытость курса для всех, желающих изучить 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