Incluir imágenes
Los comandos gráficos permiten incluir imágenes en la documentación. Las imágenes pueden mostrarse como párrafos independientes o integradas en el texto continuo.
\image
El comando ` \image ` se expande a la imagen especificada por su primer argumento y la muestra centrada en un párrafo independiente.
El comando admite dos argumentos. El primer argumento es el nombre del archivo de imagen. El segundo argumento es una descripción del contenido de la imagen y se utiliza para el atributo HTML ` alt `. Su contenido es leído en voz alta por los lectores de pantalla, por lo que se recomienda encarecidamente su uso por motivos de accesibilidad. También puede ser utilizado por navegadores que no admiten imágenes, como el navegador de texto Lynx. Asimismo, puedes configurar la variable `usealttextastitle` para que QDoc genere un atributo «title» para la imagen, que los navegadores gráficos suelen mostrar como una información sobrevolada cuando el usuario pasa el ratón por encima de la imagen.
Aunque QDoc es bastante flexible, debes escribir tanto el nombre del archivo como la descripción entre llaves, de la siguiente manera:
\image {Bandit.png} {A Golden Retriever holding a bag of coffee in its mouth}Esta sintaxis es la más explícita y siempre debería dar el resultado esperado. Si no es así, asegúrate de añadir un salto de línea después del nombre del archivo o de la descripción. Las llaves son obligatorias si el argumento «descripción» ocupa varias líneas. Si la descripción está entre comillas dobles, QDoc las eliminará antes de generar la salida. Los caracteres especiales pueden sustituirse por el código de entidad HTML correspondiente en la salida HTML de QDoc.
/*!
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.
*/Véase también \inlineimage y \caption.
\inlineimage
El comando « \inlineimage » se expande para mostrar la imagen especificada en su argumento. La imagen se muestra en línea junto con el resto del texto.
El comando admite dos argumentos. El primer argumento es el nombre del archivo de imagen. El segundo argumento es opcional y consiste en una descripción sencilla de la imagen entre llaves {}, equivalente al atributo HTML alt="" en una etiqueta de imagen. La descripción se utiliza para las descripciones emergentes y para aquellos casos en los que un navegador no admite imágenes, como el navegador de texto Lynx.
El uso más habitual del comando ` \inlineimage ` es en listas y tablas. A continuación se muestra un ejemplo de cómo incluir imágenes en línea en una lista:
/*!
\list 1
\li \inlineimage happy.gif {Oh so happy, I am a caption!}
\li \inlineimage happy.gif Oh so happy, but I'm not a caption.
\endlist
*/A continuación se muestra un ejemplo de cómo incluir imágenes en línea en una tabla:
/*!
\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
*/El comando también se puede utilizar para insertar una imagen en línea con el texto.
/*!
\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.
*/Véase también \image y \caption.
\caption
El comando « \caption » permite añadir un pie de foto a una imagen.
El comando toma todo el texto hasta el final del párrafo como pie de foto. Prueba hasta que consigas el efecto que deseas.
/*!
\table 100%
\row
\li \image windows-pushbutton.png
\caption The QPushButton widget provides a command button.
\li \image windows-toolbutton.png
\caption The QToolButton class provides a quick-access button to commands
or options, usually used inside a QToolBar.
\endtable
*/Véase también \image y \inlineimage
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.