CODEWITHSUNDEEP
documentationdoxygen
Arnab Datta
Arnab Datta

Reputation: 5256

Aligning images in doxygen

I am writing a doc file in doxygen, and I included an image by doing

\image html screenshots/enabled.png "caption"

This shows my enabled.png image on the generated documentation. However, I would like the image to be aligned to the left (since the rest of the documentation is that way). Is there any way to do this in doxygen without doing it with inline html or css?

Upvotes: 9

Views: 7419

Answers (3)

genpfault
genpfault

Reputation: 52167

Stuffing the image into an aligned Markdown table seems to work:

| Image description |
| :---- |
| \image html image.png |

Upvotes: 1

Tastalian
Tastalian

Reputation: 369

Using the following HTML syntax works on Doxygen 1.8.6 (tested with Firefox 66):

/*! \mainpage Test
 *
 * <img src="my-image.jpg" align="left">
 * <div style="clear: both"></div>
 *
 * This is a test page.
 *
 */

Doxygen wraps the image in a <div class="image">, but the align property overrides centering. The extra clearance <div> is added to avoid having the following text written to the right of the image.

Upvotes: 1

Michael Denison
Michael Denison

Reputation: 131

<img src="myimage.png" align="left"/>

But you may need to add \n chars afterwards to prevent text wrapping to the right of the image.

html only as well

Upvotes: 0

Related Questions