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

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

\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